Upgrade loop Executes upgrade batches for a given duration of time.
More...
Upgrade loop Executes upgrade batches for a given duration of time.
Definition at line 15 of file Loop.php.
Constructor.
- Parameters
-
- Exceptions
-
Definition at line 69 of file Loop.php.
Elgg\Upgrade\Loop::canContinue |
( |
|
$started, |
|
|
|
$max_duration = null |
|
) |
| |
|
protected |
Check if the loop cand and should continue.
- Parameters
-
float | $started | Timestamp of the loop initiation |
int | $max_duration | Maximum loop duration |
- Returns
- bool
Definition at line 220 of file Loop.php.
Elgg\Upgrade\Loop::isCompleted |
( |
| ) |
|
|
protected |
Check if upgrade has completed.
- Returns
- bool
Definition at line 237 of file Loop.php.
Elgg\Upgrade\Loop::loop |
( |
|
$max_duration = null | ) |
|
Run upgrade loop for a preset number of seconds.
- Parameters
-
int | $max_duration | Maximum loop duration |
- Returns
- void
Definition at line 102 of file Loop.php.
Elgg\Upgrade\Loop::report |
( |
| ) |
|
|
protected |
Report loop results.
- Returns
- void
Definition at line 182 of file Loop.php.
Elgg\Upgrade\Loop::runBatch |
( |
ProgressBar |
$progress | ) |
|
|
protected |
Run batch.
- Parameters
-
ProgressBar | $progress | Progress bar helper |
- Returns
- void
Definition at line 146 of file Loop.php.
Elgg\Upgrade\Loop::$batch |
|
protected |
Elgg\Upgrade\Loop::$count |
|
protected |
Elgg\Upgrade\Loop::$max_duration |
|
protected |
Elgg\Upgrade\Loop::$offset |
|
protected |
Elgg\Upgrade\Loop::$processed |
|
protected |
Elgg\Upgrade\Loop::$progress |
|
protected |
Elgg\Upgrade\Loop::$result |
|
protected |
Elgg\Upgrade\Loop::$upgrade |
|
protected |
The documentation for this class was generated from the following file: