PHP Class Elgg\UpgradeService

Afficher le fichier Open project: elgg/elgg Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( Translator $translator, EventsService $events, PluginHooksService $hooks, Config $config, Logger $logger, Mutex $mutex ) Constructor
run ( ) : array Run the upgrade process

Méthodes protégées

Méthode Description
getProcessedUpgrades ( ) : mixed Gets a list of processes upgrades
getUnprocessedUpgrades ( null | array $upgrade_files = null, null | array $processed_upgrades = null ) : array Checks if any upgrades need to be run.
getUpgradeFileVersion ( string $filename ) : integer | false Returns the version of the upgrade filename.
getUpgradeFiles ( string $upgrade_path = null ) : array | false Returns a list of upgrade files relative to the $upgrade_path dir.
processUpgrades ( ) : boolean Upgrades Elgg Database and code
setProcessedUpgrade ( string $upgrade ) : boolean Saves a processed upgrade to a dataset.
upgradeCode ( integer $version, boolean $quiet = false ) : boolean Run any php upgrade scripts which are required

Method Details

__construct() public méthode

Constructor
public __construct ( Translator $translator, EventsService $events, PluginHooksService $hooks, Config $config, Logger $logger, Mutex $mutex )
$translator Elgg\I18n\Translator Translation service
$events EventsService Events service
$hooks PluginHooksService Plugin hook service
$config Config Config
$logger Logger Logger
$mutex Elgg\Database\Mutex Database mutex service

getProcessedUpgrades() protected méthode

Gets a list of processes upgrades
protected getProcessedUpgrades ( ) : mixed
Résultat mixed Array of processed upgrade filenames or false

getUnprocessedUpgrades() protected méthode

Checks if any upgrades need to be run.
protected getUnprocessedUpgrades ( null | array $upgrade_files = null, null | array $processed_upgrades = null ) : array
$upgrade_files null | array Optional upgrade files
$processed_upgrades null | array Optional processed upgrades
Résultat array

getUpgradeFileVersion() protected méthode

Returns the version of the upgrade filename.
Since: 1.8.0
protected getUpgradeFileVersion ( string $filename ) : integer | false
$filename string The upgrade filename. No full path.
Résultat integer | false

getUpgradeFiles() protected méthode

Returns a list of upgrade files relative to the $upgrade_path dir.
protected getUpgradeFiles ( string $upgrade_path = null ) : array | false
$upgrade_path string The up
Résultat array | false

processUpgrades() protected méthode

Upgrades Elgg Database and code
protected processUpgrades ( ) : boolean
Résultat boolean

run() public méthode

Run the upgrade process
public run ( ) : array
Résultat array $result Associative array containing possible errors

setProcessedUpgrade() protected méthode

Saves a processed upgrade to a dataset.
protected setProcessedUpgrade ( string $upgrade ) : boolean
$upgrade string Filename of the processed upgrade (not the path, just the file)
Résultat boolean

upgradeCode() protected méthode

Run any php upgrade scripts which are required
protected upgradeCode ( integer $version, boolean $quiet = false ) : boolean
$version integer Version upgrading from.
$quiet boolean Suppress errors. Don't use this.
Résultat boolean