Elgg\Upgrade\Locator Class Reference

Locates and registers both core and plugin upgrades. More...

Public Member Functions
	__construct (protected Plugins $plugins)
	Constructor. More...
	locate ()
	Looks for upgrades and saves them as ElggUpgrade entities. More...
	getUpgrade ($class, $component_id)
	Gets intance of an ElggUpgrade based on the given class and id. More...
	getBatch (string $class, ?\ElggUpgrade $upgrade=null)
	Validates class and returns an instance of batch. More...
	upgradeExists ($upgrade_id)
	Check if there already is an ElggUpgrade for this upgrade. More...
	getUpgradeByClass (string $class_name)
	Check if there already is an ElggUpgrade for this upgrade class. More...

Detailed Description

Locates and registers both core and plugin upgrades.

Since

3.0.0

Definition at line 16 of file Locator.php.

Constructor & Destructor Documentation

__construct()

Elgg\Upgrade\Locator::__construct

(

protected Plugins

$plugins

)

Constructor.

Parameters

Plugins

$plugins

Plugins

Definition at line 23 of file Locator.php.

Member Function Documentation

getBatch()

Elgg\Upgrade\Locator::getBatch	(	string	$class,
		?\ElggUpgrade	$upgrade = null
	)

Validates class and returns an instance of batch.

Parameters

string	$class	The fully qualified class name
null | \ElggUpgrade	$upgrade	The upgrade

Returns

Batch

Exceptions

InvalidArgumentException

Definition at line 116 of file Locator.php.

getUpgrade()

Elgg\Upgrade\Locator::getUpgrade	(		$class,
			$component_id
	)

Gets intance of an ElggUpgrade based on the given class and id.

Parameters

string	$class	Class implementing Elgg\Upgrade\Batch
string	$component_id	Either plugin_id or "core"

Returns

\ElggUpgrade

Definition at line 75 of file Locator.php.

getUpgradeByClass()

Elgg\Upgrade\Locator::getUpgradeByClass

(

string

$class_name

)

Check if there already is an ElggUpgrade for this upgrade class.

Parameters

string

$class_name

name of the class used for the upgrade

Returns

\ElggUpgrade|false

Since

3.3

Definition at line 161 of file Locator.php.

locate()

Elgg\Upgrade\Locator::locate

(

)

Looks for upgrades and saves them as ElggUpgrade entities.

Returns

\ElggUpgrade[]

Definition at line 31 of file Locator.php.

upgradeExists()

Elgg\Upgrade\Locator::upgradeExists

(

$upgrade_id

)

Check if there already is an ElggUpgrade for this upgrade.

Parameters

string

$upgrade_id

Id in format <plugin_id>:<yyymmddnn>

Returns

\ElggUpgrade|false

Definition at line 135 of file Locator.php.

---

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

• engine/classes/Elgg/Upgrade/Locator.php