Upgrade service for Elgg.
More...
Upgrade service for Elgg.
Definition at line 23 of file UpgradeService.php.
Elgg\UpgradeService::down |
( |
| ) |
|
|
protected |
Elgg\UpgradeService::executeUpgrade |
( |
ElggUpgrade |
$upgrade, |
|
|
|
$max_duration = null |
|
) |
| |
Call the upgrade's run() for a specified period of time, or until it completes.
- Parameters
-
ElggUpgrade | $upgrade | Upgrade to run |
int | $max_duration | Maximum duration in seconds Set to false to execute an entire upgrade |
- Returns
- Result
- Exceptions
-
Definition at line 539 of file UpgradeService.php.
Elgg\UpgradeService::getCompletedUpgrades |
( |
|
$async = true | ) |
|
Elgg\UpgradeService::getPendingUpgrades |
( |
|
$async = true | ) |
|
Elgg\UpgradeService::getProcessedUpgrades |
( |
| ) |
|
|
protected |
Gets a list of processes upgrades.
- Returns
- mixed Array of processed upgrade filenames or false
Definition at line 340 of file UpgradeService.php.
Elgg\UpgradeService::getUnprocessedUpgrades |
( |
|
$upgrade_files = null , |
|
|
|
$processed_upgrades = null |
|
) |
| |
|
protected |
Checks if any upgrades need to be run.
- Parameters
-
null | array | $upgrade_files | Optional upgrade files |
null | array | $processed_upgrades | Optional processed upgrades |
- Returns
- array
Definition at line 417 of file UpgradeService.php.
Elgg\UpgradeService::getUpgradeFiles |
( |
|
$upgrade_path = null | ) |
|
|
protected |
Returns a list of upgrade files relative to the $upgrade_path dir.
- Parameters
-
string | $upgrade_path | The up |
- Returns
- array|false
Definition at line 373 of file UpgradeService.php.
Elgg\UpgradeService::getUpgradeFileVersion |
( |
|
$filename | ) |
|
|
protected |
Returns the version of the upgrade filename.
- Parameters
-
string | $filename | The upgrade filename. No full path. |
- Returns
- int|false
- Since
- 1.8.0
Definition at line 354 of file UpgradeService.php.
Elgg\UpgradeService::processUpgrades |
( |
| ) |
|
|
protected |
Elgg\UpgradeService::run |
( |
|
$upgrades = null | ) |
|
Run the upgrade process.
- Parameters
-
- Returns
- Promise
- Exceptions
-
Definition at line 199 of file UpgradeService.php.
Elgg\UpgradeService::runLegacyUpgrades |
( |
| ) |
|
|
protected |
Elgg\UpgradeService::runUpgrades |
( |
|
$upgrades | ) |
|
|
protected |
Run system and async upgrades.
- Parameters
-
- Returns
- Promise
Definition at line 162 of file UpgradeService.php.
Elgg\UpgradeService::setProcessedUpgrade |
( |
|
$upgrade | ) |
|
|
protected |
Saves a processed upgrade to a dataset.
- Parameters
-
string | $upgrade | Filename of the processed upgrade (not the path, just the file) |
- Returns
- bool
Definition at line 325 of file UpgradeService.php.
Elgg\UpgradeService::up |
( |
| ) |
|
|
protected |
Elgg\UpgradeService::upgradeCode |
( |
|
$version, |
|
|
|
$quiet = false |
|
) |
| |
|
protected |
Run any php upgrade scripts which are required.
- Parameters
-
int | $version | Version upgrading from. |
bool | $quiet | Suppress errors. Don't use this. |
- Returns
- bool
Definition at line 252 of file UpgradeService.php.
Elgg\UpgradeService::$locator |
|
protected |
Elgg\UpgradeService::$progress |
|
protected |
The documentation for this class was generated from the following file: