Upgrade4_1_0B1 extends UpgradeUtil
Upgrades to version 4.1.0-b1
Table of Contents
Properties
| $tasks |
Methods
| __construct() | Setup |
| addConfig() | Adds a config setting to the given file |
| editConfig() | Updates a config setting in the given file with the given value |
| errors() | Return all validation errors encountered |
| getEnvironment() | Fetches the current tasks environment |
| mergeConfig() | Extracts all config settings from $file, merges their values into $template and writes the result back in $file. |
| process() | Processes the given task |
| rollback() | Rolls back all tasks completed for the upgrade process |
| setEnvironment() | Set the environment where the task are going to be executed |
| tasks() | Returns a numerically indexed array of tasks to execute for the upgrade process |
| newRecord() | Creates a new database connection |
| replaceConfig() | Replaces a config setting within the context of a string |
| addForceLimits() | Add the force_limits column to the module_groups table |
| addInternalUseField() | Adds coupon field for internal use only |
| addSettings() | Adds the new company/client group setting for required contact fields |
| createLogDirectory() | Create the new log directory |
| dropCouponsType() | Drops the coupons type field |
| installNoneModule() | Install the none module |
| setThemeSettings() | Set colors for the new theme settings |
| updateAutodebitPendingEmail() | Update autodebit pending email tags |
| updatePluginActions() | Updates the primary key on the plugin_actions table to accommodate multiple identical actions per plugin |
| updatePriceFields() | Updates the price fields in the database from decimal(12,4) to decimal(19,4) |
Methods
__construct()
Setup
public
__construct() : mixed
addConfig()
Adds a config setting to the given file
public
addConfig(string $file, string $key, mixed $value) : mixed
Parameters
- $file : string
-
The full path to the config file
- $key : string
-
The config setting name
- $value : mixed
-
The config setting value
editConfig()
Updates a config setting in the given file with the given value
public
editConfig(string $file, string $key, mixed $value) : mixed
Parameters
- $file : string
-
The full path to the config file
- $key : string
-
The config setting name
- $value : mixed
-
The config setting value
errors()
Return all validation errors encountered
public
errors() : mixed
Return values
mixed —Boolean false if no errors encountered, an array of errors otherwise
getEnvironment()
Fetches the current tasks environment
public
getEnvironment() : string
Return values
string —The environment where the tasks are running
mergeConfig()
Extracts all config settings from $file, merges their values into $template and writes the result back in $file.
public
mergeConfig(string $file, string $template) : mixed
Parameters
- $file : string
-
The full path to the config
- $template : string
-
The full path to the config template
process()
Processes the given task
public
process(string $task) : mixed
Parameters
- $task : string
-
The task to process
rollback()
Rolls back all tasks completed for the upgrade process
public
rollback() : mixed
setEnvironment()
Set the environment where the task are going to be executed
public
setEnvironment(string $environment) : mixed
Parameters
- $environment : string
-
The environment where the upgrade tasks are running, "install" or "upgrade"
tasks()
Returns a numerically indexed array of tasks to execute for the upgrade process
public
tasks() : mixed
Tags
newRecord()
Creates a new database connection
protected
newRecord() : Record
Return values
Record —a new instance of Record
replaceConfig()
Replaces a config setting within the context of a string
protected
replaceConfig(string $key, string $value, string $contents) : string
Parameters
- $key : string
-
The config key to replace the value of
- $value : string
-
The new value
- $contents : string
-
The context in which the $key is set
Return values
string —$contents with the given $value replaced
addForceLimits()
Add the force_limits column to the module_groups table
private
addForceLimits([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
addInternalUseField()
Adds coupon field for internal use only
private
addInternalUseField([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
addSettings()
Adds the new company/client group setting for required contact fields
private
addSettings([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
createLogDirectory()
Create the new log directory
private
createLogDirectory([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
dropCouponsType()
Drops the coupons type field
private
dropCouponsType([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
installNoneModule()
Install the none module
private
installNoneModule([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
setThemeSettings()
Set colors for the new theme settings
private
setThemeSettings([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
updateAutodebitPendingEmail()
Update autodebit pending email tags
private
updateAutodebitPendingEmail([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
updatePluginActions()
Updates the primary key on the plugin_actions table to accommodate multiple identical actions per plugin
private
updatePluginActions([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
updatePriceFields()
Updates the price fields in the database from decimal(12,4) to decimal(19,4)
private
updatePriceFields([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade