MediaWiki\Api\ApiErrorFormatter_BackCompat Class Reference

Format errors and warnings in the old style, for backwards compatibility. More...

Inherits MediaWiki\Api\ApiErrorFormatter.

Collaboration diagram for MediaWiki\Api\ApiErrorFormatter_BackCompat:

Public Member Functions
	__construct (ApiResult $result)
	arrayFromStatus (StatusValue $status, $type='error', $format=null)
	Format messages from a StatusValue as an array. Parameters StatusValue $status string $type 'warning' or 'error' string | null $format Returns array
	formatException (Throwable $exception, array $options=[])
	Format a throwable as an array.
	getFormat ()
	Fetch the format for this formatter. Since 1.32 Returns string
Public Member Functions inherited from MediaWiki\Api\ApiErrorFormatter
	__construct (ApiResult $result, Language $lang, $format, $useDB=false)
	addError ( $modulePath, $msg, $code=null, $data=null)
	Add an error to the result.
	addMessagesFromStatus ( $modulePath, StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
	Add warnings and errors from a StatusValue object to the result.
	addWarning ( $modulePath, $msg, $code=null, $data=null)
	Add a warning to the result.
	formatMessage ( $msg, $format=null)
	Format a message as an array.
	getContextTitle ()
	Get the page used for rendering error messages, e.g.
	getLanguage ()
	Fetch the Language for this formatter.
	getMessageFromException (Throwable $exception, array $options=[])
	Get an ApiMessage from a throwable.
	newWithFormat ( $format)
	Return a formatter like this one but with a different format.
	setContextTitle (PageReference $title)
	Set the page used for rendering error messages, e.g.

Protected Member Functions
	addWarningOrError ( $tag, $modulePath, $msg)
	Actually add the warning or error to the result. Parameters string $tag 'warning' or 'error' string | null $modulePath ApiMessage | ApiRawMessage $msg
	formatMessageInternal ( $msg, $format)
	Format a message as an array. Since 1.29 Parameters ApiMessage | ApiRawMessage $msg string | null $format Returns array
Protected Member Functions inherited from MediaWiki\Api\ApiErrorFormatter
	getDummyTitle ()
	Fetch a dummy title to set on Messages.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Api\ApiErrorFormatter
static	isValidApiCode ( $code)
	Test whether a code is a valid API error code.
static	stripMarkup ( $text)
	Turn wikitext into something resembling plaintext.
Protected Attributes inherited from MediaWiki\Api\ApiErrorFormatter
string	$format = 'none'
Language	$lang
ApiResult	$result
bool	$useDB = false

Detailed Description

Format errors and warnings in the old style, for backwards compatibility.

Since

1.25

Deprecated

since 1.25; only for backwards compatibility, do not use

Definition at line 20 of file ApiErrorFormatter_BackCompat.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Api\ApiErrorFormatter_BackCompat::__construct

(

ApiResult

$result

)

Parameters

ApiResult

$result

Into which data will be added

Definition at line 25 of file ApiErrorFormatter_BackCompat.php.

References MediaWiki\Api\ApiErrorFormatter\$result, MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Api\ApiErrorFormatter\getLanguage().

Member Function Documentation

addWarningOrError()

MediaWiki\Api\ApiErrorFormatter_BackCompat::addWarningOrError ( $tag, $modulePath, $msg )

protected

Actually add the warning or error to the result.

Parameters

string	$tag	'warning' or 'error'
string | null	$modulePath
ApiMessage | ApiRawMessage	$msg

Reimplemented from MediaWiki\Api\ApiErrorFormatter.

Definition at line 84 of file ApiErrorFormatter_BackCompat.php.

References $path, MediaWiki\Api\ApiResult\ADD_ON_TOP, MediaWiki\Api\ApiResult\NO_SIZE_CHECK, MediaWiki\Api\ApiResult\OVERRIDE, and MediaWiki\Api\ApiErrorFormatter\stripMarkup().

arrayFromStatus()

MediaWiki\Api\ApiErrorFormatter_BackCompat::arrayFromStatus	(	StatusValue	$status,
			$type = 'error',
			$format = null )

Format messages from a StatusValue as an array.

Parameters

StatusValue	$status
string	$type	'warning' or 'error'
string | null	$format

Returns

array

Reimplemented from MediaWiki\Api\ApiErrorFormatter.

Definition at line 40 of file ApiErrorFormatter_BackCompat.php.

References MediaWiki\Api\ApiErrorFormatter\$result, MediaWiki\Api\ApiMessage\create(), StatusValue\getMessages(), StatusValue\isGood(), and MediaWiki\Api\ApiResult\setIndexedTagName().

formatException()

MediaWiki\Api\ApiErrorFormatter_BackCompat::formatException	(	Throwable	$exception,
		array	$options = [] )

Format a throwable as an array.

Since

1.29

Parameters

Throwable	$exception
array	$options	See parent::formatException(), plus bc: (bool) Return only the string, not an array

Returns

array|string

Reimplemented from MediaWiki\Api\ApiErrorFormatter.

Definition at line 78 of file ApiErrorFormatter_BackCompat.php.

formatMessageInternal()

MediaWiki\Api\ApiErrorFormatter_BackCompat::formatMessageInternal ( $msg, $format )

protected

Format a message as an array.

Since

1.29

Parameters

ApiMessage | ApiRawMessage	$msg
string | null	$format

Returns

array

Reimplemented from MediaWiki\Api\ApiErrorFormatter.

Definition at line 63 of file ApiErrorFormatter_BackCompat.php.

getFormat()

MediaWiki\Api\ApiErrorFormatter_BackCompat::getFormat

(

)

Fetch the format for this formatter.

Since

1.32

Returns

string

Reimplemented from MediaWiki\Api\ApiErrorFormatter.

Definition at line 35 of file ApiErrorFormatter_BackCompat.php.

---

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

• includes/Api/ApiErrorFormatter_BackCompat.php