MediaWiki  master
ApiErrorFormatter_BackCompat Class Reference

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

Inheritance diagram for ApiErrorFormatter_BackCompat:
Collaboration diagram for ApiErrorFormatter_BackCompat:

Public Member Functions

 __construct (ApiResult $result)
 
 arrayFromStatus (StatusValue $status, $type='error', $format=null)
 Format messages from a StatusValue as an array. More...
 
 formatException (Throwable $exception, array $options=[])
 Format a throwable as an array. More...
 
 getFormat ()
 Fetch the format for this formatter. More...
 
- Public Member Functions inherited from ApiErrorFormatter
 __construct (ApiResult $result, Language $lang, $format, $useDB=false)
 
 addError ( $modulePath, $msg, $code=null, $data=null)
 Add an error to the result. More...
 
 addMessagesFromStatus ( $modulePath, StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
 Add warnings and errors from a StatusValue object to the result. More...
 
 addWarning ( $modulePath, $msg, $code=null, $data=null)
 Add a warning to the result. More...
 
 formatMessage ( $msg, $format=null)
 Format a message as an array. More...
 
 getLanguage ()
 Fetch the Language for this formatter. More...
 
 getMessageFromException (Throwable $exception, array $options=[])
 Get an ApiMessage from a throwable. More...
 
 newWithFormat ( $format)
 Return a formatter like this one but with a different format. More...
 

Protected Member Functions

 addWarningOrError ( $tag, $modulePath, $msg)
 Actually add the warning or error to the result. More...
 
 formatMessageInternal ( $msg, $format)
 Format a message as an array. More...
 
- Protected Member Functions inherited from ApiErrorFormatter
 getDummyTitle ()
 Fetch a dummy title to set on Messages. More...
 

Additional Inherited Members

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

Detailed Description

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

Since
1.25
Deprecated:
Only for backwards compatibility, do not use

Definition at line 30 of file ApiErrorFormatter_BackCompat.php.

Constructor & Destructor Documentation

◆ __construct()

ApiErrorFormatter_BackCompat::__construct ( ApiResult  $result)
Parameters
ApiResult$resultInto which data will be added

Definition at line 35 of file ApiErrorFormatter_BackCompat.php.

References ApiErrorFormatter\$result, and ApiErrorFormatter\getLanguage().

Member Function Documentation

◆ addWarningOrError()

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

Definition at line 89 of file ApiErrorFormatter_BackCompat.php.

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

◆ arrayFromStatus()

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

Definition at line 48 of file ApiErrorFormatter_BackCompat.php.

References ApiErrorFormatter\$result, $type, ApiMessage\create(), StatusValue\getErrors(), StatusValue\getErrorsByType(), StatusValue\isGood(), and ApiResult\setIndexedTagName().

◆ formatException()

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

Format a throwable as an array.

Since
1.29
Parameters
Throwable$exception
array$optionsSee parent::formatException(), plus
  • bc: (bool) Return only the string, not an array
Returns
array|string

Reimplemented from ApiErrorFormatter.

Definition at line 84 of file ApiErrorFormatter_BackCompat.php.

◆ formatMessageInternal()

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

Definition at line 69 of file ApiErrorFormatter_BackCompat.php.

◆ getFormat()

ApiErrorFormatter_BackCompat::getFormat ( )

Fetch the format for this formatter.

Since
1.32
Returns
string

Reimplemented from ApiErrorFormatter.

Definition at line 44 of file ApiErrorFormatter_BackCompat.php.


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