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

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.

Since: 1.25

Definition at line 42 of file StatusValue.php.

Member Function Documentation

◆ __toString()

StatusValue::__toString ( )

Returns: string

Definition at line 305 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 193 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 208 of file StatusValue.php.

Referenced by MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), Status\getMessage(), Status\getWikiText(), and EditPage\runPostMergeFilters().

◆ getErrors()

StatusValue::getErrors ( )

Get the list of errors.

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

Returns: array[]

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

References $type.

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

◆ getValue()

StatusValue::getValue ( )

Returns: mixed

Definition at line 137 of file StatusValue.php.

Referenced by SearchEngine\maybePaginate(), and MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag().

◆ 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 261 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 121 of file StatusValue.php.

Referenced by ApiErrorFormatter\addMessagesFromStatus(), ApiErrorFormatter\arrayFromStatus(), ApiErrorFormatter_BackCompat\arrayFromStatus(), SpecialChangeEmail\attemptChange(), ApiBase\dieStatus(), LocalFileDeleteBatch\execute(), 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 130 of file StatusValue.php.

Referenced by Status\__get(), __toString(), MediaWiki\Storage\PageUpdater\doCreate(), MediaWiki\Storage\PageUpdater\doModify(), Status\getMessage(), Status\getWikiText(), EditPage\runPostMergeFilters(), and MediaWiki\Storage\PageUpdater\saveRevision().

◆ 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 223 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 69 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 81 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 289 of file StatusValue.php.

References $source.

Referenced by ApiBase\addBlockInfoToStatus().

◆ setOK()

StatusValue::setOK ( $ok )

Change operation status.

Parameters

bool $ok

Definition at line 157 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 167 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 98 of file StatusValue.php.

◆ warning()

StatusValue::warning	(	$message,
		$parameters
	)

Add a new warning.

Parameters

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

Definition at line 178 of file StatusValue.php.

Referenced by MediaWiki\Storage\PageUpdater\doModify().

Member Data Documentation

◆ $errors

array [] StatusValue::$errors = []

protected

Definition at line 48 of file StatusValue.php.

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

◆ $failCount

int StatusValue::$failCount = 0

Counter for batch operations.

Definition at line 60 of file StatusValue.php.

◆ $ok

bool StatusValue::$ok = true

protected

Definition at line 45 of file StatusValue.php.

◆ $success

bool [] StatusValue::$success = []

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

Definition at line 54 of file StatusValue.php.

◆ $successCount

int StatusValue::$successCount = 0

Counter for batch operations.

Definition at line 57 of file StatusValue.php.

◆ $value

mixed StatusValue::$value

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

Detailed Description

Member Function Documentation

◆ __toString()

◆ error()

◆ fatal()

◆ getErrors()

◆ getErrorsByType()

◆ getValue()

◆ hasMessage()

◆ isGood()

◆ isOK()

◆ merge()

◆ newFatal()

◆ newGood()

◆ replaceMessage()

◆ setOK()

◆ setResult()

◆ splitByErrorType()

◆ warning()

Member Data Documentation

◆ $errors

◆ $failCount

◆ $ok

◆ $success

◆ $successCount

◆ $value