v450a1
extends migration
in
Migration to v4.5.0-a1
Table of Contents
| $db | Database object | database |
|---|---|---|
| $config | System config object | config |
| $isCli | CLI execution flag | bool |
| $requiredResult | Result of pre-executed migration, false if one failed | bool |
| updateSystemConfig() | Update system configs | bool |
| __construct() | Constructor method | bool |
| getConfig() | Config object getter | config |
| getDB() | Config object getter | config |
| isCli() | Config object getter | config |
| isRequired() | Migration execution required due to system version | bool |
| process() | Execute migrations | bool |
| output() | Output of migration messages | void |
| getNewVersion() | Returns new version, e. g. from version.txt | string |
| init() | Pre-Initializing | bool |
| required() | Returns a list of migrations which have to be executed before | array |
| alterTablesAfter() | Execute additional database table changes | bool |
| updatePermissionsAfter() | Executes additional permission updates | bool |
| updateFileSystem() | Execute additional file system updates | bool |
| updateSystemConfig() | Execute additional system config updates | bool |
| onDatabase() | Returns a list of database driver names the migration should be executed to, default is MySQL/ MariaDB and Postgres | array |
| getNamespace() | Returns migration class namespace | string |
Properties
$db
Database object
private
database
$db
$config
System config object
private
config
$config
$isCli
CLI execution flag
private
bool
$isCli
= null
$requiredResult
Result of pre-executed migration, false if one failed
protected
bool
$requiredResult
= true
Methods
updateSystemConfig()
Update system configs
protected
updateSystemConfig(
)
: bool
Return values
bool__construct()
Constructor method
public
final __construct(
)
: bool
Return values
boolgetConfig()
Config object getter
protected
final getConfig(
)
: config
Return values
configgetDB()
Config object getter
protected
final getDB(
)
: config
Return values
configisCli()
Config object getter
protected
final isCli(
)
: config
Return values
configisRequired()
Migration execution required due to system version
public
final isRequired(
)
: bool
Return values
boolprocess()
Execute migrations
public
final process(
)
: bool
Return values
booloutput()
Output of migration messages
protected
final output(
$str :
string
[, $error :
bool
= false ]
)
: void
Parameters
- $str : string
- $error : bool = false
Tags
getNewVersion()
Returns new version, e. g. from version.txt
protected
getNewVersion(
)
: string
Return values
stringinit()
Pre-Initializing
protected
init(
)
: bool
Return values
boolrequired()
Returns a list of migrations which have to be executed before
protected
required(
)
: array
Return values
arrayalterTablesAfter()
Execute additional database table changes
protected
alterTablesAfter(
)
: bool
Return values
boolupdatePermissionsAfter()
Executes additional permission updates
protected
updatePermissionsAfter(
)
: bool
Return values
boolupdateFileSystem()
Execute additional file system updates
protected
updateFileSystem(
)
: bool
Return values
boolupdateSystemConfig()
Execute additional system config updates
protected
updateSystemConfig(
)
: bool
Return values
boolonDatabase()
Returns a list of database driver names the migration should be executed to, default is MySQL/ MariaDB and Postgres
protected
onDatabase(
)
: array
Tags
Return values
arraygetNamespace()
Returns migration class namespace
public
static getNamespace(
$version :
string
)
: string
Parameters
- $version : string