Elgg\UpgradeService Class Reference

Upgrade service for Elgg. More...

Public Member Functions
	__construct (protected Locator $locator, protected Translator $translator, protected EventsService $events, protected Config $config, protected Mutex $mutex, protected SystemMessagesService $system_messages, protected Progress $progress)
	Constructor. More...
	run ($upgrades=null)
	Run the upgrade process. More...
	getPendingUpgrades (bool $async=true)
	Get pending async upgrades. More...
	getCompletedUpgrades (bool $async=true)
	Get completed (async) upgrades ordered by recently completed first. More...
	executeUpgrade (\ElggUpgrade $upgrade, ?int $max_duration=null)
	Call the upgrade's run() for a specified period of time, or until it completes. More...

Protected Member Functions
	up ()
	Start an upgrade process. More...
	down ()
	Finish an upgrade process. More...
	runUpgrades ($upgrades)
	Run system and async upgrades. More...

Detailed Description

Upgrade service for Elgg.

Definition at line 23 of file UpgradeService.php.

Constructor & Destructor Documentation

__construct()

Elgg\UpgradeService::__construct	(	protected Locator	$locator,
		protected Translator	$translator,
		protected EventsService	$events,
		protected Config	$config,
		protected Mutex	$mutex,
		protected SystemMessagesService	$system_messages,
		protected Progress	$progress
	)

Constructor.

Parameters

Locator	$locator	Upgrade locator
Translator	$translator	Translation service
EventsService	$events	Events service
Config	$config	Config
Mutex	$mutex	Database mutex service
SystemMessagesService	$system_messages	System messages
Progress	$progress	Progress

Definition at line 38 of file UpgradeService.php.

Member Function Documentation

down()

Elgg\UpgradeService::down ( )

protected

Finish an upgrade process.

Returns

Promise

Definition at line 80 of file UpgradeService.php.

executeUpgrade()

Elgg\UpgradeService::executeUpgrade	(	\ElggUpgrade	$upgrade,
		?int	$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 | null	$max_duration	Maximum duration in seconds Set to 0 to execute an entire upgrade

Returns

Result

Definition at line 276 of file UpgradeService.php.

getCompletedUpgrades()

Elgg\UpgradeService::getCompletedUpgrades

(

bool

$async = true

)

Get completed (async) upgrades ordered by recently completed first.

Parameters

bool

$async

Include async upgrades

Returns

\ElggUpgrade[]

Definition at line 223 of file UpgradeService.php.

getPendingUpgrades()

Elgg\UpgradeService::getPendingUpgrades

(

bool

$async = true

)

Get pending async upgrades.

Parameters

bool

$async

Include async upgrades

Returns

\ElggUpgrade[]

Definition at line 189 of file UpgradeService.php.

run()

Elgg\UpgradeService::run

(

$upgrades = null

)

Run the upgrade process.

Parameters

\ElggUpgrade[]

$upgrades

Upgrades to run

Returns

PromiseInterface

Definition at line 140 of file UpgradeService.php.

runUpgrades()

Elgg\UpgradeService::runUpgrades (   $upgrades )

protected

Run system and async upgrades.

Parameters

\ElggUpgrade[]

$upgrades

Upgrades to run

Returns

PromiseInterface

Definition at line 103 of file UpgradeService.php.

up()

Elgg\UpgradeService::up ( )

protected

Start an upgrade process.

Returns

Promise

Definition at line 54 of file UpgradeService.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/UpgradeService.php