Elgg  Version 3.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Elgg\Upgrades\ActivateNewPlugins Class Reference

Activate plugins added in Elgg 3.0. More...

Inheritance diagram for Elgg\Upgrades\ActivateNewPlugins:
Elgg\Upgrade\SystemUpgrade Elgg\Upgrade\Batch

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$resultResult of the batch (this must be returned)
int$offsetNumber to skip when processing
Returns
Result
} More...
 

Protected Member Functions

 getPluginIDs ()
 Not all plugins which should be active have to be installed, for example in the MIT version of Elgg. More...
 

Protected Attributes

 $plugins
 

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

Activate plugins added in Elgg 3.0.

Definition at line 11 of file ActivateNewPlugins.php.

Member Function Documentation

Elgg\Upgrades\ActivateNewPlugins::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 68 of file ActivateNewPlugins.php.

Elgg\Upgrades\ActivateNewPlugins::getPluginIDs ( )
protected

Not all plugins which should be active have to be installed, for example in the MIT version of Elgg.

Returns
string[]

Definition at line 26 of file ActivateNewPlugins.php.

Elgg\Upgrades\ActivateNewPlugins::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 47 of file ActivateNewPlugins.php.

Elgg\Upgrades\ActivateNewPlugins::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 61 of file ActivateNewPlugins.php.

Elgg\Upgrades\ActivateNewPlugins::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$resultResult of the batch (this must be returned)
int$offsetNumber to skip when processing
Returns
Result
}

Implements Elgg\Upgrade\Batch.

Definition at line 75 of file ActivateNewPlugins.php.

Elgg\Upgrades\ActivateNewPlugins::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 54 of file ActivateNewPlugins.php.

Member Data Documentation

Elgg\Upgrades\ActivateNewPlugins::$plugins
protected
Initial value:
= [
'activity',
'friends',
'friends_collections',
'system_log',
]

Definition at line 13 of file ActivateNewPlugins.php.


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