MediaWiki master
|
Generic operation result class Has warning/error list, boolean status and arbitrary value. More...
Inherits Stringable.
Inherited by MediaWiki\Permissions\PermissionStatus, and MediaWiki\Status\Status.
Public Member Functions | |
__toString () | |
Returns a string representation of the status for debugging. | |
error ( $message,... $parameters) | |
Add an error, do not set fatal flag This can be used for non-fatal errors. | |
fatal ( $message,... $parameters) | |
Add an error and set OK to false, indicating that the operation as a whole was fatal. | |
getErrors () | |
Get the list of errors. | |
getErrorsByType ( $type) | |
Returns a list of status messages of the given type. | |
getMessages (?string $type=null) | |
Returns a list of error messages, optionally only those of the given type. | |
getValue () | |
hasMessage (string $message) | |
Returns true if the specified message is present as a warning or error. | |
hasMessagesExcept (string ... $messages) | |
Returns true if any other message than the specified ones is present as a warning or error. | |
isGood () | |
Returns whether the operation completed and didn't have any error or warnings. | |
isOK () | |
Returns whether the operation completed. | |
merge ( $other, $overwriteValue=false) | |
Merge another status object into this one. | |
replaceMessage (string $source, $dest) | |
If the specified source message exists, replace it with the specified destination message, but keep the same parameters as in the original error. | |
setOK ( $ok) | |
Change operation status. | |
setResult ( $ok, $value=null) | |
Change operation result. | |
splitByErrorType () | |
Splits this StatusValue object into two new StatusValue objects, one which contains only the error messages, and one that contains the warnings, only. | |
warning ( $message,... $parameters) | |
Add a new warning. | |
Static Public Member Functions | |
static | newFatal ( $message,... $parameters) |
Factory function for fatal errors. | |
static | newGood ( $value=null) |
Factory function for good results. | |
Public Attributes | |
int | $failCount = 0 |
Counter for batch operations. | |
mixed | $statusData |
arbitrary extra data about the operation | |
bool[] | $success = [] |
Map of (key => bool) to indicate success of each part of batch operations. | |
int | $successCount = 0 |
Counter for batch operations. | |
mixed | $value |
Protected Member Functions | |
getStatusArray ( $type=false) | |
Returns a list of status messages of the given type (or all if false) | |
Protected Attributes | |
array[] | $errors = [] |
bool | $ok = true |
Generic operation result class Has warning/error list, boolean status and arbitrary value.
"Good" means the operation was completed with no warnings or errors.
"OK" means the operation was partially or wholly completed.
An operation which is not OK should have errors so that the user can be informed as to what went wrong. Calling the fatal() function sets an error message and simultaneously switches off the OK flag.
The recommended pattern for functions returning StatusValue objects is to return a StatusValue unconditionally, both on success and on failure (similarly to Option, Maybe, Promise etc. objects in other languages) – so that the developer of the calling code is reminded that the function can fail, and so that a lack of error-handling will be explicit.
This class accepts any MessageSpecifier objects. The use of Message objects should be avoided when serializability is needed. Use MessageValue in that case instead.
Definition at line 52 of file StatusValue.php.
StatusValue::__toString | ( | ) |
Returns a string representation of the status for debugging.
This is fairly verbose and may change without notice.
Definition at line 451 of file StatusValue.php.
References $params.
StatusValue::error | ( | $message, | |
$parameters ) |
Add an error, do not set fatal flag This can be used for non-fatal errors.
string | MessageSpecifier | $message | Message key or object @phpcs:ignore Generic.Files.LineLength |
MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float> | ...$parameters See Message::params() |
Definition at line 275 of file StatusValue.php.
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), and fatal().
StatusValue::fatal | ( | $message, | |
$parameters ) |
Add an error and set OK to false, indicating that the operation as a whole was fatal.
string | MessageSpecifier | $message | Message key or object @phpcs:ignore Generic.Files.LineLength |
MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float> | ...$parameters See Message::params() |
Definition at line 293 of file StatusValue.php.
References error().
Referenced by PermissionsError\__construct(), MediaWiki\Page\RollbackPage\authorizeRollback(), MediaWiki\Api\ApiBase\dieStatus(), Article\fetchRevisionRecord(), MediaWiki\EditPage\Constraint\BrokenRedirectConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\DefaultTextConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\ExistingSectionEditConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\MissingCommentConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\NewSectionMissingSubjectConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\ReadOnlyConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\SelfRedirectConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\SimpleAntiSpamConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\UnicodeConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\UserRateLimitConstraint\getLegacyStatus(), MediaWiki\Status\StatusFormatter\getMessage(), MediaWiki\Status\StatusFormatter\getWikiText(), MediaWiki\Installer\PostgresInstaller\openConnectionToAnyDB(), MediaWiki\Block\UnblockUser\unblock(), MediaWiki\Block\UnblockUser\unblockUnsafe(), and MediaWiki\Settings\Config\ConfigSchemaAggregator\validateConfig().
StatusValue::getErrors | ( | ) |
Get the list of errors.
Each error is a (message:string or MessageSpecifier,params:array) map
->getMessages()
instead Definition at line 173 of file StatusValue.php.
Referenced by MediaWiki\Status\Status\__get(), MediaWiki\Status\StatusFormatter\getMessage(), and MediaWiki\Status\StatusFormatter\getWikiText().
StatusValue::getErrorsByType | ( | $type | ) |
Returns a list of status messages of the given type.
Each entry is a map of:
->getMessages( $type )
instead string | $type |
Definition at line 337 of file StatusValue.php.
StatusValue::getMessages | ( | ?string | $type = null | ) |
Returns a list of error messages, optionally only those of the given type.
If the warning()
or error()
method was called with a MessageSpecifier object, this method is guaranteed to return the same object.
?string | $type | If provided, only return messages of the type 'warning' or 'error' |
Definition at line 359 of file StatusValue.php.
References $params.
Referenced by PermissionsError\__construct(), MediaWiki\Api\ApiBase\addBlockInfoToStatus(), MediaWiki\Api\ApiErrorFormatter\addMessagesFromStatus(), MediaWiki\Api\ApiErrorFormatter\arrayFromStatus(), MediaWiki\Api\ApiErrorFormatter_BackCompat\arrayFromStatus(), MediaWiki\Api\ApiBase\dieStatus(), MediaWiki\Output\OutputPage\showPermissionStatus(), MediaWiki\Installer\CliInstaller\showStatusMessage(), and MediaWiki\Installer\WebInstaller\showStatusMessage().
|
protected |
Returns a list of status messages of the given type (or all if false)
string | bool | $type |
Definition at line 529 of file StatusValue.php.
StatusValue::getValue | ( | ) |
Definition at line 160 of file StatusValue.php.
Referenced by MediaWiki\Api\ApiMove\moveSubpages(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag(), and splitByErrorType().
StatusValue::hasMessage | ( | string | $message | ) |
Returns true if the specified message is present as a warning or error.
Any message using the same key will be found (ignoring the message parameters).
string | $message | Message key to search for |
Definition at line 384 of file StatusValue.php.
References Wikimedia\Message\MessageSpecifier\getKey().
Referenced by MediaWiki\Api\ApiBase\dieStatus().
StatusValue::hasMessagesExcept | ( | string ... | $messages | ) |
Returns true if any other message than the specified ones is present as a warning or error.
Any messages using the same keys will be found (ignoring the message parameters).
string | ...$messages Message keys to search for |
Definition at line 403 of file StatusValue.php.
StatusValue::isGood | ( | ) |
Returns whether the operation completed and didn't have any error or warnings.
Definition at line 144 of file StatusValue.php.
Referenced by PermissionsError\__construct(), MediaWiki\Api\ApiErrorFormatter\addMessagesFromStatus(), MediaWiki\Api\ApiErrorFormatter\arrayFromStatus(), MediaWiki\Api\ApiErrorFormatter_BackCompat\arrayFromStatus(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Api\ApiBase\dieStatus(), MediaWiki\SpecialPage\FormSpecialPage\execute(), MediaWiki\Specials\SpecialEditWatchlist\executeViewEditWatchlist(), MediaWiki\SpecialPage\ContributionsSpecialPage\getForm(), MediaWiki\Specials\SpecialEmailUser\sendEmailForm(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag(), MediaWiki\HTMLForm\HTMLForm\show(), LogEventsList\showOptions(), and MediaWiki\Output\OutputPage\showPermissionStatus().
StatusValue::isOK | ( | ) |
Returns whether the operation completed.
Definition at line 153 of file StatusValue.php.
Referenced by MediaWiki\Api\ApiUsageException\__construct(), MediaWiki\Status\Status\__get(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Status\StatusFormatter\getMessage(), MediaWiki\Status\StatusFormatter\getWikiText(), and splitByErrorType().
StatusValue::merge | ( | $other, | |
$overwriteValue = false ) |
Merge another status object into this one.
StatusValue | $other | |
bool | $overwriteValue | Whether to override the "value" member |
Definition at line 305 of file StatusValue.php.
Referenced by ScopedLock\factory(), and Wikimedia\FileBackend\FileOpBatch\runParallelBatches().
|
static |
Factory function for fatal errors.
string | MessageSpecifier | $message | Message key or object @phpcs:ignore Generic.Files.LineLength |
MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float> | ...$parameters See Message::params() |
Definition at line 92 of file StatusValue.php.
Referenced by MediaWiki\User\TempUser\TempUserCreator\create().
|
static |
Factory function for good results.
mixed | null | $value |
Definition at line 104 of file StatusValue.php.
Referenced by LocalFileDeleteBatch\execute().
StatusValue::replaceMessage | ( | string | $source, |
$dest ) |
If the specified source message exists, replace it with the specified destination message, but keep the same parameters as in the original error.
Any message using the same key will be replaced (ignoring the message parameters).
string | $source | Message key to search for |
MessageSpecifier | string | $dest | Replacement message key or object |
Definition at line 426 of file StatusValue.php.
References $params, $source, and Wikimedia\Message\MessageSpecifier\getKey().
Referenced by MediaWiki\Api\ApiBase\addBlockInfoToStatus(), and MediaWiki\Api\ApiBase\dieStatus().
StatusValue::setOK | ( | $ok | ) |
Change operation status.
bool | $ok |
Definition at line 183 of file StatusValue.php.
Referenced by MediaWiki\Status\Status\__set(), and MediaWiki\Api\ApiBase\dieStatus().
StatusValue::setResult | ( | $ok, | |
$value = null ) |
Change operation result.
bool | $ok | Whether the operation completed |
mixed | null | $value |
Definition at line 195 of file StatusValue.php.
Referenced by MediaWiki\EditPage\Constraint\AccidentalRecreationConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\ContentModelChangeConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\EditRightConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\ImageRedirectConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\PageSizeConstraint\getLegacyStatus(), and MediaWiki\EditPage\Constraint\UserBlockConstraint\getLegacyStatus().
StatusValue::splitByErrorType | ( | ) |
Splits this StatusValue object into two new StatusValue objects, one which contains only the error messages, and one that contains the warnings, only.
The returned array is defined as: [ 0 => object(StatusValue) # the StatusValue with error messages, only 1 => object(StatusValue) # The StatusValue with warning messages, only ]
Reimplemented in MediaWiki\Status\Status.
Definition at line 121 of file StatusValue.php.
References getValue(), and isOK().
StatusValue::warning | ( | $message, | |
$parameters ) |
Add a new warning.
string | MessageSpecifier | $message | Message key or object @phpcs:ignore Generic.Files.LineLength |
MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float> | ...$parameters See Message::params() |
Definition at line 257 of file StatusValue.php.
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser().
|
protected |
self::getErrors()
(get full list), self::splitByErrorType()
(get errors/warnings), or self::fatal()
, self::error()
or self::warning()
(add error/warning). Definition at line 66 of file StatusValue.php.
int StatusValue::$failCount = 0 |
Counter for batch operations.
Definition at line 78 of file StatusValue.php.
|
protected |
self::isOK()
or self::setOK()
. Definition at line 58 of file StatusValue.php.
mixed StatusValue::$statusData |
arbitrary extra data about the operation
Definition at line 81 of file StatusValue.php.
bool [] StatusValue::$success = [] |
Map of (key => bool) to indicate success of each part of batch operations.
Definition at line 72 of file StatusValue.php.
int StatusValue::$successCount = 0 |
Counter for batch operations.
Definition at line 75 of file StatusValue.php.
mixed StatusValue::$value |
Definition at line 69 of file StatusValue.php.
Referenced by MediaWiki\Status\Status\__set().