Upgrade3_3_0B1 extends UpgradeUtil
Upgrades to version 3.3.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 |
| addEmailTemplates() | Adds email templates, i.e. the tax liability report |
| addModuleClientMeta() | Adds module_client_meta table |
| addPackageProration() | Adds fields to the package table for proration |
| inheritSettings() | Sets a new inheritable field for company/system settings |
| priceOverride() | Adds price override to services |
| updateInvoices() | Updates invoices added proforma as status |
| updateSettings() | Update settings |
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
addEmailTemplates()
Adds email templates, i.e. the tax liability report
private
addEmailTemplates([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
addModuleClientMeta()
Adds module_client_meta table
private
addModuleClientMeta([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
addPackageProration()
Adds fields to the package table for proration
private
addPackageProration([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
inheritSettings()
Sets a new inheritable field for company/system settings
private
inheritSettings([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
priceOverride()
Adds price override to services
private
priceOverride([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
updateInvoices()
Updates invoices added proforma as status
private
updateInvoices([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
updateSettings()
Update settings
private
updateSettings([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change