• Home
  • Horde_Core_LoginTasks_SystemTask_Upgrade

PHP Class Horde_Core_LoginTasks_SystemTask_Upgrade, horde

Copyright 2011-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Michael Slusarz ([email protected])
Inheritance: extends Horde_LoginTasks_SystemTask
Datei anzeigen Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$interval integer The interval at which to run the task.

Protected Properties

Property Type Description
$_app string The current application.
$_auth boolean Do these upgrade tasks require authentication?
$_toupgrade array The list of versions to upgrade.
$_versions array The list of versions which upgrades will occur.

Public Methods

Method Description
__construct ( ) Constructor.
execute ( ) Perform upgrade tasks.
forceUpgrade ( ) Force re-run of all upgrade tasks.
skip ( )

Protected Methods

Method Description
_pref ( string $action ) : string Manage the upgrade preferences.
_upgrade ( string $version ) Perform upgrade tasks for a given version.

Method Details

__construct() public method

Constructor.
public __construct ( )

_pref() protected method

Manage the upgrade preferences.
protected _pref ( string $action ) : string
$action string Either 'get' or 'set'.
return string The current version.

_upgrade() abstract protected method

For those running a git checkout, the system task for a given version will run continuously until that version is released. Code should be added to not convert already converted values.
abstract protected _upgrade ( string $version )
$version string A version string.

execute() public method

Perform upgrade tasks.
public execute ( )

forceUpgrade() public method

Force re-run of all upgrade tasks.
public forceUpgrade ( )

skip() public method

public skip ( )

Property Details

$_app protected_oe property

The current application.
protected string $_app
return string

$_auth protected_oe property

Do these upgrade tasks require authentication?
protected bool $_auth
return boolean

$_toupgrade protected_oe property

The list of versions to upgrade.
protected array $_toupgrade
return array

$_versions protected_oe property

The list of versions which upgrades will occur.
protected array $_versions
return array

$interval public_oe property

The interval at which to run the task.
public int $interval
return integer