PHP Class Elgg\UpgradeService

Public Methods

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

Method	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

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

Gets a list of processes upgrades

protected getProcessedUpgrades ( ) : mixed
return	mixed	Array of processed upgrade filenames or false

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
return	array

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.
return	integer \| false

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
return	array \| false

Upgrades Elgg Database and code

protected processUpgrades ( ) : boolean
return	boolean

Run the upgrade process

public run ( ) : array
return	array	$result Associative array containing possible errors

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)
return	boolean

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.
return	boolean