Elgg  Version master
Public Member Functions | Protected Member Functions | List of all members
Elgg\Upgrades\NotificationsPrefix Class Reference

Migrate the notification subscription relationship to a new naming convention. More...

Inheritance diagram for Elgg\Upgrades\NotificationsPrefix:
Elgg\Upgrade\AsynchronousUpgrade Elgg\Upgrade\Batch

Public Member Functions

 getVersion ()
 
 needsIncrementOffset ()
 
 shouldBeSkipped ()
 
 countItems ()
 
 run (Result $result, $offset)
 
- Public Member Functions inherited from Elgg\Upgrade\Batch
 __construct (\ElggUpgrade $upgrade=null)
 Constructs a upgrade batch. More...
 
 getVersion ()
 Version of the upgrade. More...
 
 shouldBeSkipped ()
 Should this upgrade be skipped? More...
 
 needsIncrementOffset ()
 Should the run() method receive an offset representing all processed items? More...
 
 countItems ()
 The total number of items to process during the upgrade. More...
 
 run (Result $result, $offset)
 Runs upgrade on a single batch of items. More...
 
 getUpgrade ()
 Returns the related upgrade entity. More...
 

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...
 
- Protected Attributes inherited from Elgg\Upgrade\Batch
 $upgrade
 

Detailed Description

Migrate the notification subscription relationship to a new naming convention.

Since
4.0

Definition at line 18 of file NotificationsPrefix.php.

Member Function Documentation

Elgg\Upgrades\NotificationsPrefix::countItems ( )

Definition at line 46 of file NotificationsPrefix.php.

Elgg\Upgrades\NotificationsPrefix::getEntityGUIDOptions ( array  $options = [])
protected

Get options for entity guid selection.

Parameters
array$optionsadditional options
Returns
array

Definition at line 110 of file NotificationsPrefix.php.

Elgg\Upgrades\NotificationsPrefix::getVersion ( )

Definition at line 23 of file NotificationsPrefix.php.

Elgg\Upgrades\NotificationsPrefix::needsIncrementOffset ( )

Definition at line 30 of file NotificationsPrefix.php.

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

Definition at line 53 of file NotificationsPrefix.php.

Elgg\Upgrades\NotificationsPrefix::shouldBeSkipped ( )

Definition at line 37 of file NotificationsPrefix.php.


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