PHP Interface Elgg\Upgrade\Batch

Since: 3.0.0
Datei anzeigen Open project: elgg/elgg

Public Methods

Method Description
countItems ( ) : integer Gets the amount of items that need to be upgraded
isRequired ( ) : boolean Checks whether there are items that need to be upgraded.
run ( Result $result, integer $offset ) : Result Runs upgrade on a single batch of items

Method Details

countItems() public method

Gets the amount of items that need to be upgraded
public countItems ( ) : integer
return integer

isRequired() public method

Checks whether there are items that need to be upgraded.
public isRequired ( ) : boolean
return boolean

run() public method

Runs upgrade on a single batch of items
public run ( Result $result, integer $offset ) : Result
$result Result Object that holds results of the batch
$offset integer Starting point of the batch
return Result Instance of \Elgg\Upgrade\Result