Generic operation result class Has warning/error list, boolean status and arbitrary value. More...

Inherits Stringable.

Inherited by MediaWiki\Permissions\PermissionStatus, MediaWiki\Permissions\PermissionStatus, MediaWiki\Status\Status, MediaWiki\Status\Status, MediaWiki\Upload\UploadVerificationStatus, and MediaWiki\Upload\UploadVerificationStatus.

Collaboration diagram for StatusValue:

[legend]

Public Member Functions
	__construct ()

	__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.

T	$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 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.

Stability: newable

Stability: stable: to extend

Since: 1.25 @template T Type of the value stored in the status when the operation result is OK. May be 'never' to indicate that there's no meaningful value, and that this status is only used to keep track of errors and warnings.

Definition at line 41 of file StatusValue.php.

Constructor & Destructor Documentation

◆ __construct()

StatusValue::__construct ( )

Reimplemented in MediaWiki\Status\Status.

Definition at line 75 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 446 of file StatusValue.php.

◆ error()

StatusValue::error	(		$message,
			$parameters )

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

Parameters

string \| MessageSpecifier	$message	Message key or object
	MessageParam\|MessageSpecifier\|string\|int\|float\|list<MessageParam\|MessageSpecifier\|string\|int\|float>	...$parameters See Message::params()

Returns: $this

Definition at line 270 of file StatusValue.php.

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser().

◆ 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	$message	Message key or object
	MessageParam\|MessageSpecifier\|string\|int\|float\|list<MessageParam\|MessageSpecifier\|string\|int\|float>	...$parameters See Message::params()

Returns: $this

Definition at line 288 of file StatusValue.php.

◆ 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 166 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.

If the warning() or error() method was called with a MessageSpecifier object, this method is guaranteed to return the same object.

Since: 1.43

Parameters

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

Returns: MessageSpecifier[]

Definition at line 354 of file StatusValue.php.

Referenced by MediaWiki\Exception\PermissionsError\__construct(), MediaWiki\Api\ApiErrorFormatter\addMessagesFromStatus(), MediaWiki\Api\ApiErrorFormatter\arrayFromStatus(), MediaWiki\Api\ApiErrorFormatter_BackCompat\arrayFromStatus(), MediaWiki\Specials\SpecialEmailUser\getTarget(), 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 524 of file StatusValue.php.

◆ getValue()

StatusValue::getValue ( )

Returns: T

Definition at line 153 of file StatusValue.php.

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

◆ hasMessage()

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).

Parameters

string $message Message key to search for

Returns: bool

Definition at line 379 of file StatusValue.php.

References Wikimedia\Message\MessageSpecifier\getKey().

Referenced by MediaWiki\Specials\SpecialEmailUser\execute().

◆ hasMessagesExcept()

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).

Parameters

string ...$messages Message keys to search for

Returns: bool

Definition at line 398 of file StatusValue.php.

◆ isGood()

StatusValue::isGood ( )

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

Returns: bool

Definition at line 137 of file StatusValue.php.

Referenced by MediaWiki\Exception\PermissionsError\__construct(), MediaWiki\Api\ApiErrorFormatter\addMessagesFromStatus(), MediaWiki\Api\ApiErrorFormatter\arrayFromStatus(), MediaWiki\Api\ApiErrorFormatter_BackCompat\arrayFromStatus(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\SpecialPage\FormSpecialPage\execute(), MediaWiki\Specials\SpecialEmailUser\execute(), MediaWiki\Specials\SpecialEditWatchlist\executeViewEditWatchlist(), MediaWiki\SpecialPage\ContributionsSpecialPage\getForm(), MediaWiki\Specials\SpecialEmailUser\getTarget(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag(), MediaWiki\HTMLForm\HTMLForm\show(), MediaWiki\Logging\LogEventsList\showOptions(), and MediaWiki\Output\OutputPage\showPermissionStatus().

◆ isOK()

StatusValue::isOK ( )

Returns whether the operation completed.

Returns: bool

Definition at line 146 of file StatusValue.php.

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

◆ 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 RevDelList\acquireItemLocks(), Wikimedia\LockManager\ScopedLock\factory(), RevDelList\releaseItemLocks(), 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
	MessageParam\|MessageSpecifier\|string\|int\|float\|list<MessageParam\|MessageSpecifier\|string\|int\|float>	...$parameters See Message::params()

Definition at line 86 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

Definition at line 97 of file StatusValue.php.

Referenced by MediaWiki\FileRepo\File\LocalFileDeleteBatch\execute().

◆ replaceMessage()

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).

Parameters

string	$source	Message key to search for
MessageSpecifier \| string	$dest	Replacement message key or object

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

Definition at line 421 of file StatusValue.php.

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

◆ setOK()

StatusValue::setOK ( $ok )

Change operation status.

Parameters

bool $ok

Returns: $this

Definition at line 176 of file StatusValue.php.

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

◆ setResult()

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

Change operation result.

Parameters

bool	$ok	Whether the operation completed
T	$value	If `$ok` is true, this should be a value of the template type `T`. Otherwise it may be null or omitted.

Returns: $this

Definition at line 190 of file StatusValue.php.

Referenced by MediaWiki\EditPage\Constraint\AccidentalRecreationConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\AuthorizationConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\ContentModelChangeConstraint\getLegacyStatus(), MediaWiki\EditPage\Constraint\ImageRedirectConstraint\getLegacyStatus(), and MediaWiki\EditPage\Constraint\PageSizeConstraint\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 114 of file StatusValue.php.

◆ warning()

StatusValue::warning	(		$message,
			$parameters )

Add a new warning.

Parameters

string \| MessageSpecifier	$message	Message key or object
	MessageParam\|MessageSpecifier\|string\|int\|float\|list<MessageParam\|MessageSpecifier\|string\|int\|float>	...$parameters See Message::params()

Returns: $this

Definition at line 252 of file StatusValue.php.

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser().

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 55 of file StatusValue.php.

◆ $failCount

int StatusValue::$failCount = 0

Counter for batch operations.

Definition at line 67 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 47 of file StatusValue.php.

◆ $statusData

mixed StatusValue::$statusData

arbitrary extra data about the operation

Definition at line 70 of file StatusValue.php.

◆ $success

bool [] StatusValue::$success = []

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

Definition at line 61 of file StatusValue.php.

◆ $successCount

int StatusValue::$successCount = 0

Counter for batch operations.

Definition at line 64 of file StatusValue.php.

◆ $value

T StatusValue::$value

Definition at line 58 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

Constructor & Destructor Documentation

◆ __construct()

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