Class UpdateCommand

X2Engine command line updater.

CComponent

Extended by

CConsoleCommand

Extended by

UpdateCommand

Package: application\commands
Author: Demitri Morgan <demitri@x2engine.com>
Located at x2engine/protected/commands/UpdateCommand.php

Methods summary
`public boolean`	# `beforeAction( string $action, array $params )` This method is invoked right before an action is to be executed. You may override this method to do last-minute preparation for the action. This method is invoked right before an action is to be executed. You may override this method to do last-minute preparation for the action. Parameters `$action` `string` $action the action name `$params` `array` $params the parameters to be passed to the action method. Returns `boolean` whether the action should be executed. Overrides `CConsoleCommand::beforeAction()`
`public`	# `actionIndex( )`
`public`	# `actionApp( integer $force = 0, integer $backup = 1, mixed $lock = 0 )` Update the application. Update the application. Parameters `$force` `integer` $force "force" parameter sent to `UpdateCommand::runOperation()` `$backup` `integer` $backup "backup" parameter sent to `UpdateCommand::runOperation()` `$lock`
`public`	# `actionUpgrade( type $key, type $firstName, type $lastName, type $email, boolean $force = 0, mixed $backup = 1 )` Performs registration and upgrades the application to a different edition. Performs registration and upgrades the application to a different edition. Parameters `$key` `type` $key Product key `$firstName` `type` $firstName First name `$lastName` `type` $lastName Last name `$email` `type` $email Email address `$force` `boolean` $force Same as the $force argument of `UpdateCommand::actionApp()` `$backup`
`public`	# `runOperation( string $scenario, boolean $force = false, boolean $backup = true, mixed $lock = false )` Runs the actual update/upgrade. Runs the actual update/upgrade. Parameters `$scenario` `string` $scenario The scenario (update or upgrade) `$force` `boolean` $force False to halt on encountering any compatibility issues; true to continue through issues `$backup` `boolean` $backup If enabled: create database backup before running operations, and restore to the backup if operations fail. `$lock`
`public integer`	# `runUpdateUpdater( )` Returns `integer` 1 to indicate that a self-update was performed; 0 to indicate that the updater utility is already the latest version.

Methods inherited from CConsoleCommand
`__construct(), afterAction(), behaviors(), buildFileList(), confirm(), copyFiles(), ensureDirectory(), getCommandRunner(), getHelp(), getName(), getOptionHelp(), init(), onAfterAction(), onBeforeAction(), pluralize(), prompt(), renderFile(), resolveRequest(), run(), usageError()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties inherited from CConsoleCommand
`$defaultAction`

Magic properties inherited from CConsoleCommand
`$commandRunner, $help, $name, $optionHelp`