Horde_Core_LoginTasks_SystemTask_Upgrade
extends Horde_LoginTasks_SystemTask
in package
Login system task for automated upgrade tasks.
Copyright 2011-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
Properties
- $interval : int
- The interval at which to run the task.
- $_app : string
- The current application.
- $_auth : bool
- Do these upgrade tasks require authentication?
- $_toupgrade : array<string|int, mixed>
- The list of versions to upgrade.
- $_versions : array<string|int, mixed>
- The list of versions which upgrades will occur.
Methods
- __construct() : mixed
- Constructor.
- execute() : mixed
- Perform upgrade tasks.
- forceUpgrade() : mixed
- Force re-run of all upgrade tasks.
- skip() : mixed
- _pref() : string
- Manage the upgrade preferences.
- _upgrade() : mixed
- Perform upgrade tasks for a given version.
Properties
$interval
The interval at which to run the task.
public
int
$interval
= \Horde_LoginTasks::EVERY
$_app
The current application.
protected
string
$_app
= 'horde'
$_auth
Do these upgrade tasks require authentication?
protected
bool
$_auth
= \false
$_toupgrade
The list of versions to upgrade.
protected
array<string|int, mixed>
$_toupgrade
= array()
$_versions
The list of versions which upgrades will occur.
protected
array<string|int, mixed>
$_versions
= array()
Methods
__construct()
Constructor.
public
__construct() : mixed
execute()
Perform upgrade tasks.
public
execute() : mixed
forceUpgrade()
Force re-run of all upgrade tasks.
public
forceUpgrade() : mixed
skip()
public
skip() : mixed
_pref()
Manage the upgrade preferences.
protected
_pref(string $action) : string
Parameters
- $action : string
-
Either 'get' or 'set'.
Return values
string —The current version.
_upgrade()
Perform upgrade tasks for a given version.
protected
abstract _upgrade(string $version) : mixed
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.
Parameters
- $version : string
-
A version string.