Elgg\Upgrades\ChangeUserNotificationSettingsNamespace Class Reference

Change the metadata name of the user notification settings to be multi-purpose. More...

Inheritance diagram for Elgg\Upgrades\ChangeUserNotificationSettingsNamespace:

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...
	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...
	shouldBeSkipped ()
	Should this upgrade be skipped?If true, the upgrade will not be performed and cannot be accessed later. 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...

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

Change the metadata name of the user notification settings to be multi-purpose.

Since

4.0

Definition at line 15 of file ChangeUserNotificationSettingsNamespace.php.

Member Function Documentation

Elgg\Upgrades\ChangeUserNotificationSettingsNamespace::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

Implements Elgg\Upgrade\Batch.

Definition at line 41 of file ChangeUserNotificationSettingsNamespace.php.

Elgg\Upgrades\ChangeUserNotificationSettingsNamespace::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

Implements Elgg\Upgrade\Batch.

Definition at line 20 of file ChangeUserNotificationSettingsNamespace.php.

Elgg\Upgrades\ChangeUserNotificationSettingsNamespace::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

Implements Elgg\Upgrade\Batch.

Definition at line 27 of file ChangeUserNotificationSettingsNamespace.php.

Elgg\Upgrades\ChangeUserNotificationSettingsNamespace::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

Implements Elgg\Upgrade\Batch.

Definition at line 57 of file ChangeUserNotificationSettingsNamespace.php.

Elgg\Upgrades\ChangeUserNotificationSettingsNamespace::shouldBeSkipped

(

)

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

Returns

bool

Implements Elgg\Upgrade\Batch.

Definition at line 34 of file ChangeUserNotificationSettingsNamespace.php.

---

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

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