|
Elgg
Version 4.3
|
Migrate the notification subscription relationship to a new naming convention. More...
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:
| |||||||
| 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.
| |||||||
| shouldBeSkipped () | |||||||
Should this upgrade be skipped?If true, the upgrade will not be performed and cannot be accessed later.
| |||||||
| 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.
| |||||||
| 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.
| |||||||
Protected Member Functions | |
| getEntityGUIDOptions (array $options=[]) | |
| Get options for entity guid selection. 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... | |
Migrate the notification subscription relationship to a new naming convention.
Definition at line 18 of file NotificationsPrefix.php.
| Elgg\Upgrades\NotificationsPrefix::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.
Implements Elgg\Upgrade\Batch.
Definition at line 46 of file NotificationsPrefix.php.
|
protected |
Get options for entity guid selection.
| array | $options | additional options |
Definition at line 110 of file NotificationsPrefix.php.
| Elgg\Upgrades\NotificationsPrefix::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 yearmm 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 dayImplements Elgg\Upgrade\Batch.
Definition at line 23 of file NotificationsPrefix.php.
| Elgg\Upgrades\NotificationsPrefix::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.
Implements Elgg\Upgrade\Batch.
Definition at line 30 of file NotificationsPrefix.php.
| Elgg\Upgrades\NotificationsPrefix::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.
| Result | $result | Result of the batch (this must be returned) |
| int | $offset | Number to skip when processing |
Implements Elgg\Upgrade\Batch.
Definition at line 53 of file NotificationsPrefix.php.
| Elgg\Upgrades\NotificationsPrefix::shouldBeSkipped | ( | ) |
Should this upgrade be skipped?If true, the upgrade will not be performed and cannot be accessed later.
Implements Elgg\Upgrade\Batch.
Definition at line 37 of file NotificationsPrefix.php.
1.8.11