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

Inheritance diagram for StatusValue:

Public Member Functions
	__toString ()

	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.

	getValue ()

	hasMessage ( $message)
	Returns true if the specified message 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.

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 Attributes
array[]	$errors = []

bool	$ok = true

Private Member Functions
	flattenParams (array $params)

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.

@newable

Since: 1.25

Definition at line 43 of file StatusValue.php.

Member Function Documentation

◆ __toString()

StatusValue::__toString ( )

Returns: string

Definition at line 306 of file StatusValue.php.

References isOK().

◆ 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
	mixed	...$parameters

Definition at line 194 of file StatusValue.php.

Referenced by MediaWiki\Storage\PageUpdater\checkAllRequiredRoles(), MediaWiki\Storage\PageUpdater\checkAllRolesAllowed(), and MediaWiki\Storage\PageUpdater\checkNoRolesRequired().

◆ 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
	mixed	...$parameters

Definition at line 209 of file StatusValue.php.

Referenced by Status\getMessage(), Status\getWikiText(), and EditPage\runPostMergeFilters().

◆ flattenParams()

StatusValue::flattenParams ( array $params )

private

Parameters

array $params Message parameters

Returns: string String representation

Definition at line 360 of file StatusValue.php.

◆ getErrors()

StatusValue::getErrors ( )

Get the list of errors.

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

Returns: array[]

Definition at line 149 of file StatusValue.php.

Referenced by Status\__get(), ApiErrorFormatter\addMessagesFromStatus(), ApiErrorFormatter\arrayFromStatus(), ApiErrorFormatter_BackCompat\arrayFromStatus(), Status\getMessage(), Status\getStatusArray(), Status\getWikiText(), and EditPage\runPostMergeFilters().

◆ 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

Parameters

string $type

Returns: array[]

Definition at line 244 of file StatusValue.php.

References $type.

Referenced by ApiErrorFormatter_BackCompat\arrayFromStatus(), and ApiBase\dieStatus().

◆ getValue()

StatusValue::getValue ( )

Returns: mixed

Definition at line 138 of file StatusValue.php.

Referenced by SearchEngine\maybePaginate(), 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.

Parameters

string | MessageSpecifier $message Message key or object to search for

Returns: bool

Definition at line 262 of file StatusValue.php.

Referenced by ApiBase\addBlockInfoToStatus().

◆ isGood()

StatusValue::isGood ( )

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

Returns: bool

Definition at line 122 of file StatusValue.php.

Referenced by ApiErrorFormatter\addMessagesFromStatus(), ApiErrorFormatter\arrayFromStatus(), ApiErrorFormatter_BackCompat\arrayFromStatus(), SpecialChangeEmail\attemptChange(), ApiBase\dieStatus(), LocalFileDeleteBatch\execute(), FindBadBlobs\handleStatus(), BotPassword\loginHook(), EditPage\runPostMergeFilters(), SpecialEmailUser\sendEmailForm(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag(), HTMLForm\show(), and SpecialConfirmEmail\showRequestForm().

◆ isOK()

StatusValue::isOK ( )

Returns whether the operation completed.

Returns: bool

Definition at line 131 of file StatusValue.php.

Referenced by ApiUsageException\__construct(), Status\__get(), __toString(), ApiRevisionDelete\extractStatusInfo(), Status\getMessage(), Status\getWikiText(), FindBadBlobs\handleStatus(), EditPage\runPostMergeFilters(), 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

Definition at line 224 of file StatusValue.php.

Referenced by LocalFileDeleteBatch\execute(), ScopedLock\factory(), MediaWiki\Storage\PageUpdater\makeNewRevision(), and 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 70 of file StatusValue.php.

◆ newGood()

static StatusValue::newGood ( $value = null )

static

Factory function for good results.

Parameters

mixed | null $value

Returns: static

Definition at line 82 of file StatusValue.php.

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

Note, due to the lack of tools for comparing IStatusMessage objects, this function will not work when using such an object as the search parameter.

Parameters

MessageSpecifier \| string	$source	Message key or object 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 290 of file StatusValue.php.

References $source.

Referenced by ApiBase\addBlockInfoToStatus().

◆ setOK()

StatusValue::setOK ( $ok )

Change operation status.

Parameters

bool $ok

Definition at line 158 of file StatusValue.php.

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

◆ setResult()

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

Change operation result.

Parameters

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

Definition at line 168 of file StatusValue.php.

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

Definition at line 99 of file StatusValue.php.

References getValue(), and isOK().

◆ warning()

StatusValue::warning	(	$message,
		$parameters
	)

Add a new warning.

Parameters

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

Definition at line 179 of file StatusValue.php.

Member Data Documentation

◆ $errors

array [] StatusValue::$errors = []

protected

Definition at line 49 of file StatusValue.php.

Referenced by Status\getErrorMessageArray(), and Status\getWikiText().

◆ $failCount

int StatusValue::$failCount = 0

Counter for batch operations.

Definition at line 61 of file StatusValue.php.

◆ $ok

bool StatusValue::$ok = true

protected

Definition at line 46 of file StatusValue.php.

◆ $success

bool [] StatusValue::$success = []

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

Definition at line 55 of file StatusValue.php.

◆ $successCount

int StatusValue::$successCount = 0

Counter for batch operations.

Definition at line 58 of file StatusValue.php.

◆ $value

mixed StatusValue::$value

Definition at line 52 of file StatusValue.php.

Referenced by 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 Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ __toString()

◆ error()

◆ fatal()

◆ flattenParams()

◆ getErrors()

◆ getErrorsByType()

◆ getValue()

◆ hasMessage()

◆ isGood()

◆ isOK()

◆ merge()

◆ newFatal()

◆ newGood()

◆ replaceMessage()

◆ setOK()

◆ setResult()

◆ splitByErrorType()

◆ warning()

Member Data Documentation

◆ $errors

◆ $failCount

◆ $ok

◆ $success

◆ $successCount

◆ $value