Elgg\Upgrades\UpdateMetastringBoolDatabaseValue Class Reference

Inheritance diagram for Elgg\Upgrades\UpdateMetastringBoolDatabaseValue:

Public Member Functions
	getVersion ()
	{Version of the upgrade.This tells the date when the upgrade was added. It consists of eight digits and is in format yyyymmddnn where: yyyy is the year mm is the month (with leading zero) dd is the day (with leading zero) nn is an incrementing number (starting from 00) that is used in case two separate upgrades have been added during the same day Returns int E.g. 2016123101 } More...
	shouldBeSkipped ()
	{Should this upgrade be skipped?If true, the upgrade will not be performed and cannot be accessed later. Returns bool } More...
	needsIncrementOffset ()
	{Should the run() method receive an offset representing all processed items?If true, run() will receive as $offset the number of items already processed. This is useful if you are only modifying data, and need to use the $offset in a function like elgg_get_entities*() to know how many to skip over.If false, run() will receive as $offset the total number of failures. This should be used if your process deletes or moves data out of the way of the process. E.g. if you delete 50 objects on each run(), you may still use the $offset to skip objects that already failed once. Returns bool } More...
	countItems ()
	{The total number of items to process during the upgrade.If unknown, Batch::UNKNOWN_COUNT should be returned, and run() must manually mark the result as complete. Returns int } More...
	run (Result $result, $offset)
	{Runs upgrade on a single batch of items.If countItems() returns Batch::UNKNOWN_COUNT, this method must call $result->markCompleted() when the upgrade is complete. Parameters Result $result Result of the batch (this must be returned) int $offset Number to skip when processing Returns Result } More...
Public Member Functions inherited from Elgg\Upgrade\Batch
	__construct (protected ?\ElggUpgrade $upgrade=null)
	Constructs a upgrade batch. More...
	getUpgrade ()
	Returns the related upgrade entity. More...

Additional Inherited Members
Public Attributes inherited from Elgg\Upgrade\Batch
const	UNKNOWN_COUNT = -1
	countItems() should return this if it doesn't know how many items remain. More...

Detailed Description

Definition at line 12 of file UpdateMetastringBoolDatabaseValue.php.

Member Function Documentation

countItems()

Elgg\Upgrades\UpdateMetastringBoolDatabaseValue::countItems

(

)

{The total number of items to process during the upgrade.If unknown, Batch::UNKNOWN_COUNT should be returned, and run() must manually mark the result as complete.

Returns

int

}

Reimplemented from Elgg\Upgrade\Batch.

Definition at line 38 of file UpdateMetastringBoolDatabaseValue.php.

getVersion()

Elgg\Upgrades\UpdateMetastringBoolDatabaseValue::getVersion

(

)

{Version of the upgrade.This tells the date when the upgrade was added. It consists of eight digits and is in format yyyymmddnn where:

• yyyy is the year
• mm is the month (with leading zero)
• dd is the day (with leading zero)
• nn is an incrementing number (starting from 00) that is used in case two separate upgrades have been added during the same day

Returns

int E.g. 2016123101

}

Reimplemented from Elgg\Upgrade\Batch.

Definition at line 17 of file UpdateMetastringBoolDatabaseValue.php.

needsIncrementOffset()

Elgg\Upgrades\UpdateMetastringBoolDatabaseValue::needsIncrementOffset

(

)

{Should the run() method receive an offset representing all processed items?If true, run() will receive as $offset the number of items already processed. This is useful if you are only modifying data, and need to use the $offset in a function like elgg_get_entities*() to know how many to skip over.If false, run() will receive as $offset the total number of failures. This should be used if your process deletes or moves data out of the way of the process. E.g. if you delete 50 objects on each run(), you may still use the $offset to skip objects that already failed once.

Returns

bool

}

Reimplemented from Elgg\Upgrade\Batch.

Definition at line 31 of file UpdateMetastringBoolDatabaseValue.php.

run()

Elgg\Upgrades\UpdateMetastringBoolDatabaseValue::run	(	Result	$result,
			$offset
	)

{Runs upgrade on a single batch of items.If countItems() returns Batch::UNKNOWN_COUNT, this method must call $result->markCompleted() when the upgrade is complete.

Parameters

Result	$result	Result of the batch (this must be returned)
int	$offset	Number to skip when processing

Returns

Result

}

Reimplemented from Elgg\Upgrade\Batch.

Definition at line 61 of file UpdateMetastringBoolDatabaseValue.php.

shouldBeSkipped()

Elgg\Upgrades\UpdateMetastringBoolDatabaseValue::shouldBeSkipped

(

)

{Should this upgrade be skipped?If true, the upgrade will not be performed and cannot be accessed later.

Returns

bool

}

Reimplemented from Elgg\Upgrade\Batch.

Definition at line 24 of file UpdateMetastringBoolDatabaseValue.php.

---

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

• engine/classes/Elgg/Upgrades/UpdateMetastringBoolDatabaseValue.php