Util/Update/Runner.php
- Classes
- Kwf_Util_Update_Runner
\Kwf_Util_Update_Runner
Methods
- __construct
- checkUpdatesSettings
- executeUpdates
- getErrors
- getProgressSteps
- setEnableDebug
- setProgressBar
- setSkipClearCache
- setVerbose
- writeExecutedUpdates
Description
Runner that executes update scripts
Methods
__construct
__construct(
$updates
)
:
Arguments
- $updates
Details
- visibility
- public
- final
- false
- static
- false
checkUpdatesSettings
checkUpdatesSettings(
)
:
Executes checkSettings method for all update scripts which should check if everything is set up correctly to execute the update script
Details
- visibility
- public
- final
- false
- static
- false
executeUpdates
executeUpdates(
$options
=
array
)
:
Arguments
- $options
Details
- visibility
- public
- final
- false
- static
- false
getErrors
getErrors(
)
:
Details
- visibility
- public
- final
- false
- static
- false
getProgressSteps
getProgressSteps(
)
:
Details
- visibility
- public
- final
- false
- static
- false
setEnableDebug
setEnableDebug(
$v
)
:
Enabled debug mode. In debug mode when an update script causes an execption the backtrace is shown and the update is stopped. This is useful for debugging update scripts
Arguments
- $v
Details
- visibility
- public
- final
- false
- static
- false
setProgressBar
setProgressBar(
$progressBar
)
:
Arguments
- $progressBar
Details
- visibility
- public
- final
- false
- static
- false
setSkipClearCache
setSkipClearCache(
$v
)
:
Arguments
- $v
Details
- visibility
- public
- final
- false
- static
- false
setVerbose
setVerbose(
$v
)
:
If verbose is enabled output is echoed while executing update scripts
Arguments
- $v
Details
- visibility
- public
- final
- false
- static
- false
writeExecutedUpdates
writeExecutedUpdates(
$doneNames
)
:
Arguments
- $doneNames
Details
- visibility
- public
- final
- false
- static
- false