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.

Collaboration diagram for StatusValue:

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 ( $message)
	Returns true if the specified message is present as a warning or error.

	hasMessagesExcept (... $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 ( $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

Detailed Description

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 Status objects is to return a StatusValue unconditionally, i.e. both on success and on failure – 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.

The use of Message objects should be avoided when serializability is needed.

Stability: newable

Stability: stable: to extend

Since: 1.25

Definition at line 50 of file StatusValue.php.

Member Function Documentation

◆ __toString()

StatusValue::__toString ( )

Returns a string representation of the status for debugging.

This is fairly verbose and may change without notice.

Returns: string

Definition at line 492 of file StatusValue.php.

References $params.

◆ error()

StatusValue::error	(		$message,
			$parameters )

Add an error, do not set fatal flag This can be used for non-fatal errors.

Parameters

string \| MessageSpecifier \| MessageValue	$message	Message key or object
	mixed	...$parameters

Returns: $this

Definition at line 270 of file StatusValue.php.

Referenced by fatal().

◆ fatal()

StatusValue::fatal	(		$message,
			$parameters )

Add an error and set OK to false, indicating that the operation as a whole was fatal.

Parameters

string \| MessageSpecifier \| MessageValue	$message	Message key or object
	mixed	...$parameters

Returns: $this

Definition at line 288 of file StatusValue.php.

References error().

◆ getErrors()

StatusValue::getErrors ( )

Get the list of errors.

Each error is a (message:string or MessageSpecifier,params:array) map

Deprecated: since 1.43 Use ->getMessages() instead

Returns: array[]

Definition at line 169 of file StatusValue.php.

Referenced by MediaWiki\Status\Status\__get(), MediaWiki\Status\StatusFormatter\getMessage(), and MediaWiki\Status\StatusFormatter\getWikiText().

◆ getErrorsByType()

StatusValue::getErrorsByType ( $type )

Returns a list of status messages of the given type.

Each entry is a map of:

message: string message key or MessageSpecifier
params: array list of parameters

Deprecated: since 1.43 Use ->getMessages( $type ) instead

Parameters

string $type

Returns: array[]

Definition at line 332 of file StatusValue.php.

◆ getMessages()

StatusValue::getMessages ( ?string $type = null )

Returns a list of error messages, optionally only those of the given type.

Since: 1.43

Parameters

?string $type If provided, only return messages of the type 'warning' or 'error'

Returns: MessageSpecifier[]

Definition at line 351 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().

◆ getStatusArray()

StatusValue::getStatusArray ( $type = false )

protected

Returns a list of status messages of the given type (or all if false)

Access: internal: Only for use by Status.

Parameters

string | bool $type

Returns: array[]

Definition at line 568 of file StatusValue.php.

◆ getValue()

StatusValue::getValue ( )

Returns: mixed

Definition at line 156 of file StatusValue.php.

Referenced by MediaWiki\Api\ApiMove\moveSubpages(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag(), and splitByErrorType().

◆ hasMessage()

StatusValue::hasMessage ( $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).

Parameters

string $message Message key to search for (this parameter used to allow MessageSpecifier|MessageValue too, deprecated since 1.43)

Returns: bool

Definition at line 378 of file StatusValue.php.

References Wikimedia\Message\MessageSpecifier\getKey(), and wfDeprecatedMsg().

Referenced by MediaWiki\Api\ApiBase\dieStatus().

◆ hasMessagesExcept()

StatusValue::hasMessagesExcept ( $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).

Parameters

string ...$messages Message keys to search for (this parameter used to allow MessageSpecifier|MessageValue too, deprecated since 1.43)

Returns: bool

Definition at line 408 of file StatusValue.php.

References wfDeprecatedMsg().

◆ isGood()

StatusValue::isGood ( )

Returns whether the operation completed and didn't have any error or warnings.

Returns: bool

Definition at line 140 of file StatusValue.php.

Referenced by PermissionsError\__construct(), MediaWiki\Api\ApiErrorFormatter\addMessagesFromStatus(), MediaWiki\Api\ApiErrorFormatter\arrayFromStatus(), MediaWiki\Api\ApiErrorFormatter_BackCompat\arrayFromStatus(), 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().

◆ isOK()

StatusValue::isOK ( )

Returns whether the operation completed.

Returns: bool

Definition at line 149 of file StatusValue.php.

Referenced by MediaWiki\Api\ApiUsageException\__construct(), MediaWiki\Status\Status\__get(), MediaWiki\Status\StatusFormatter\getMessage(), MediaWiki\Status\StatusFormatter\getWikiText(), and splitByErrorType().

◆ merge()

StatusValue::merge	(		$other,
			$overwriteValue = false )

Merge another status object into this one.

Parameters

StatusValue	$other
bool	$overwriteValue	Whether to override the "value" member

Returns: $this

Definition at line 300 of file StatusValue.php.

Referenced by ScopedLock\factory(), and Wikimedia\FileBackend\FileOpBatch\runParallelBatches().

◆ newFatal()

static StatusValue::newFatal	(		$message,
			$parameters )

static

Factory function for fatal errors.

Parameters

string \| MessageSpecifier	$message	Message key or object
	mixed	...$parameters

Returns: static

Definition at line 88 of file StatusValue.php.

Referenced by MediaWiki\User\TempUser\TempUserCreator\create().

◆ newGood()

static StatusValue::newGood ( $value = null )

static

Factory function for good results.

Parameters

mixed | null $value

Returns: static

Definition at line 100 of file StatusValue.php.

Referenced by LocalFileDeleteBatch\execute().

◆ replaceMessage()

StatusValue::replaceMessage	(		$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.

When using a string as the $source parameter, any message using the same key will be replaced (regardless of whether it was stored as string or as MessageSpecifier, and ignoring the message parameters).

When using a MessageValue as the $source parameter, this function does not work. This is a bug, but it's impractical to fix. Therefore, passing a MessageValue is deprecated (since 1.43).

When using a MessageSpecifier as the $source parameter, the message will only be replaced when the same MessageSpecifier object was stored in the StatusValue (compared with ===). Since the only reliable way to obtain one is to use getErrors(), which is deprecated, passing a MessageSpecifier is deprecated as well (since 1.43).

Parameters

string	$source	Message key to search for (this parameter used to allow MessageSpecifier\|MessageValue too, deprecated since 1.43)
MessageSpecifier \| MessageValue \| string	$dest	Replacement message key or object

Returns: bool Return true if the replacement was done, false otherwise.

Definition at line 456 of file StatusValue.php.

References $params, $source, Wikimedia\Message\MessageSpecifier\getKey(), and wfDeprecatedMsg().

Referenced by MediaWiki\Api\ApiBase\addBlockInfoToStatus(), and MediaWiki\Api\ApiBase\dieStatus().

◆ setOK()

StatusValue::setOK ( $ok )

Change operation status.

Parameters

bool $ok

Returns: $this

Definition at line 179 of file StatusValue.php.

Referenced by MediaWiki\Status\Status\__set(), and MediaWiki\Api\ApiBase\dieStatus().

◆ setResult()

StatusValue::setResult	(		$ok,
			$value = null )

Change operation result.

Parameters

bool	$ok	Whether the operation completed
mixed \| null	$value

Returns: $this

Definition at line 191 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().

◆ splitByErrorType()

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 ]

Returns: static[]

Reimplemented in MediaWiki\Status\Status.

Definition at line 117 of file StatusValue.php.

References getValue(), and isOK().

◆ warning()

StatusValue::warning	(		$message,
			$parameters )

Add a new warning.

Parameters

string \| MessageSpecifier \| MessageValue	$message	Message key or object
	mixed	...$parameters

Returns: $this

Definition at line 252 of file StatusValue.php.

Member Data Documentation

◆ $errors

array [] StatusValue::$errors = []

protected

Access: internal: Only for use by Status. Use self::getErrors() (get full list), self::splitByErrorType() (get errors/warnings), or self::fatal(), self::error() or self::warning() (add error/warning).

Definition at line 64 of file StatusValue.php.

◆ $failCount

int StatusValue::$failCount = 0

Counter for batch operations.

Definition at line 76 of file StatusValue.php.

◆ $ok

bool StatusValue::$ok = true

protected

Access: internal: Only for use by Status. Use self::isOK() or self::setOK().

Definition at line 56 of file StatusValue.php.

◆ $statusData

mixed StatusValue::$statusData

arbitrary extra data about the operation

Definition at line 79 of file StatusValue.php.

◆ $success

bool [] StatusValue::$success = []

Map of (key => bool) to indicate success of each part of batch operations.

Definition at line 70 of file StatusValue.php.

◆ $successCount

int StatusValue::$successCount = 0

Counter for batch operations.

Definition at line 73 of file StatusValue.php.

◆ $value

mixed StatusValue::$value

Definition at line 67 of file StatusValue.php.

Referenced by MediaWiki\Status\Status\__set().

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

includes/libs/StatusValue.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __toString()

◆ error()

◆ fatal()

◆ getErrors()

◆ getErrorsByType()

◆ getMessages()

◆ getStatusArray()

◆ getValue()

◆ hasMessage()

◆ hasMessagesExcept()

◆ isGood()

◆ isOK()

◆ merge()

◆ newFatal()

◆ newGood()

◆ replaceMessage()

◆ setOK()

◆ setResult()

◆ splitByErrorType()

◆ warning()

Member Data Documentation

◆ $errors

◆ $failCount

◆ $ok

◆ $statusData

◆ $success

◆ $successCount

◆ $value