Elgg
Version 6.0
|
Result of a single BatchUpgrade run. More...
Public Member Functions | |
addError ($message) | |
Add new error message to the batch. More... | |
getErrors () | |
Get error messages. More... | |
addFailures (int $num=1) | |
Increment failure count. More... | |
getFailureCount () | |
Get count of failures within the current batch. More... | |
addSuccesses (int $num=1) | |
Set an item (or items) as successfully upgraded. More... | |
getSuccessCount () | |
Get count of successfully upgraded items within the current batch. More... | |
markComplete () | |
Mark the upgrade as complete (not necessarily successful) More... | |
wasMarkedComplete () | |
Has the upgrade been marked complete? More... | |
toArray () | |
Export to reports array. More... | |
Result of a single BatchUpgrade run.
Definition at line 10 of file Result.php.
Elgg\Upgrade\Result::addError | ( | $message | ) |
Add new error message to the batch.
string|string[] | $message Error messages |
Definition at line 27 of file Result.php.
Elgg\Upgrade\Result::addFailures | ( | int | $num = 1 | ) |
Increment failure count.
This must be called every time an item fails to get upgraded.
int | $num | Number of items (defaults to 1) |
Definition at line 53 of file Result.php.
Elgg\Upgrade\Result::addSuccesses | ( | int | $num = 1 | ) |
Set an item (or items) as successfully upgraded.
int | $num | Amount if items (defaults to one) |
Definition at line 73 of file Result.php.
Elgg\Upgrade\Result::getErrors | ( | ) |
Get error messages.
Definition at line 40 of file Result.php.
Elgg\Upgrade\Result::getFailureCount | ( | ) |
Get count of failures within the current batch.
Definition at line 62 of file Result.php.
Elgg\Upgrade\Result::getSuccessCount | ( | ) |
Get count of successfully upgraded items within the current batch.
Definition at line 82 of file Result.php.
Elgg\Upgrade\Result::markComplete | ( | ) |
Mark the upgrade as complete (not necessarily successful)
Definition at line 91 of file Result.php.
Elgg\Upgrade\Result::toArray | ( | ) |
Elgg\Upgrade\Result::wasMarkedComplete | ( | ) |