Class UpgradeUtil

Upgrade Utility that all upgrade objects must extend

Direct known subclasses

Upgrade3_0_0A4, Upgrade3_0_0A5, Upgrade3_0_3, Upgrade3_0_4, Upgrade3_1_0B1, Upgrade3_1_1, Upgrade3_1_2, Upgrade3_2_0B1, Upgrade3_2_1, Upgrade3_3_0B1, Upgrade3_3_0B2, Upgrade3_3_2, Upgrade3_0_0A6, Upgrade3_4_0, Upgrade3_4_0B1, Upgrade3_4_3, Upgrade3_5_0B1, Upgrade3_5_0B2, Upgrade3_5_0B4, Upgrade3_5_1, Upgrade3_6_0B1, Upgrade3_0_0A7, Upgrade3_0_0B1, Upgrade3_0_0B2, Upgrade3_0_0B3, Upgrade3_0_0B6, Upgrade3_0_0B7, Upgrade3_0_2

Abstract
Package: blesta\components\upgrades
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/upgrades/lib/upgrade_util.php

Methods summary

`abstract public`	# `tasks( )` Returns a numerically indexed array of tasks to execute for the upgrade process Returns a numerically indexed array of tasks to execute for the upgrade process Retrun array A numerically indexed array of tasks to execute for the upgrade process
`abstract public`	# `process( string $task )` Processes the given task Processes the given task Parameters `$task` `string` $task The task to process
`abstract public`	# `rollback( )` Rolls back all tasks completed for the upgrade process Rolls back all tasks completed for the upgrade process
`public`	# `addConfig( string $file, string $key, mixed $value )` Adds a config setting to the given file Adds a config setting to the given file Parameters `$file` `string` $file The full path to the config file `$key` `string` $key The config setting name `$value` `mixed` $value The config setting value
`public`	# `editConfig( string $file, string $key, mixed $value )` Updates a config setting in the given file with the given value Updates a config setting in the given file with the given value Parameters `$file` `string` $file The full path to the config file `$key` `string` $key The config setting name `$value` `mixed` $value The config setting value
`public`	# `mergeConfig( string $file, string $template )` Extracts all config settings from $file, merges their values into $template and writes the result back in $file. Extracts all config settings from $file, merges their values into $template and writes the result back in $file. Parameters `$file` `string` $file The full path to the config `$template` `string` $template The full path to the config template
`protected string`	# `replaceConfig( string $key, string $value, string $contents )` Replaces a config setting within the context of a string Replaces a config setting within the context of a string Parameters `$key` `string` $key The config key to replace the value of `$value` `string` $value The new value `$contents` `string` $contents The context in which the $key is set Returns `string` $contents with the given $value replaced
`public mixed`	# `errors( )` Return all validation errors encountered Return all validation errors encountered Returns `mixed` Boolean false if no errors encountered, an array of errors otherwise

Packages

Classes

Class UpgradeUtil

Direct known subclasses

Methods summary

Retrun

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Magic methods summary