Upgrade5_7_0B1 extends UpgradeUtil
Upgrades to version 5.7.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 |
| addParityStringSetting() | Adds a parity string setting to the system |
| addQuotationDeliveryEmail() | Adds the quotation delivery email template |
| addQuotationMessengerTemplates() | Adds quotation messenger templates: |
| addQuotationsNaviagtionItem() | Adds "Quotations" to the navigation bar |
| addQuotationsPermissions() | Add permission to Quotations |
| addQuotationsWidget() | Adds "Quotations" widget to the client profile |
| addRenewalQueueNavItem() | Adds a parity string setting to the system |
| addStaffQuotationApprovedEmail() | Adds the staff quotation delivery email template |
| addToolsRenewalQueuePermissions() | Adds a permission for tools renewal queue page |
| addTransitionQuotationsCron() | Adds a new invoice late fees table to the database and their respective cron task |
| createQuotationTables() | Creates the required tables by the Quotation system in the database |
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() : array<string|int, mixed>
Return values
array<string|int, mixed> —A numerically indexed array of tasks to execute for the upgrade process
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
addParityStringSetting()
Adds a parity string setting to the system
private
addParityStringSetting([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
addQuotationDeliveryEmail()
Adds the quotation delivery email template
private
addQuotationDeliveryEmail([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, false to perform the change
addQuotationMessengerTemplates()
Adds quotation messenger templates:
private
addQuotationMessengerTemplates([bool $undo = false ]) : mixed
- Quotation Delivery
- Quotation Approved
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
addQuotationsNaviagtionItem()
Adds "Quotations" to the navigation bar
private
addQuotationsNaviagtionItem([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
addQuotationsPermissions()
Add permission to Quotations
private
addQuotationsPermissions([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
addQuotationsWidget()
Adds "Quotations" widget to the client profile
private
addQuotationsWidget([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
addRenewalQueueNavItem()
Adds a parity string setting to the system
private
addRenewalQueueNavItem([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade
addStaffQuotationApprovedEmail()
Adds the staff quotation delivery email template
private
addStaffQuotationApprovedEmail([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, false to perform the change
addToolsRenewalQueuePermissions()
Adds a permission for tools renewal queue page
private
addToolsRenewalQueuePermissions([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to add or undo the change
addTransitionQuotationsCron()
Adds a new invoice late fees table to the database and their respective cron task
private
addTransitionQuotationsCron([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
True to undo the change, or false to perform the change
createQuotationTables()
Creates the required tables by the Quotation system in the database
private
createQuotationTables([bool $undo = false ]) : mixed
Parameters
- $undo : bool = false
-
Whether to undo the upgrade