MediaWiki\Extension\WikiLambda\ZObjects\ZError Class Reference

Inheritance diagram for MediaWiki\Extension\WikiLambda\ZObjects\ZError:

Collaboration diagram for MediaWiki\Extension\WikiLambda\ZObjects\ZError:

Public Member Functions
	__construct ( $type, $value)
	Construct a new ZError instance.
	isValid ()
	@inheritDoc
	getZValue ()
	Get the content of the ZError value.
	getZErrorType ()
	Get the Zid that identifies the ZErrorType that describes this ZError.
	getMessage ()
	Get a human-readable one-line string that identifies the ZError information.
	getErrorData ()
	Get all ZError related information in different forms for API failure response.
Public Member Functions inherited from MediaWiki\Extension\WikiLambda\ZObjects\ZObject
	__construct ( $type)
	Construct a new ZObject instance.
	getValueByKey (string $key)
	Fetch value of given key from the current ZObject.
	setValueByKey (string $key, ZObject $value)
	Set a value of given key in the current ZObject.
	isBuiltin ()
	Returns whether this ZObject is a builtin class.
	isTypeReference ()
	Returns whether the object type is a ZReference that points to a type.
	isTypeFunctionCall ()
	Returns whether the object type is a ZFunctionCall that resolves to a type.
	getZTypeObject ()
	Returns either the ZReference or the ZFunctionCall that contain the type of this ZObject (Z1K1)
	getZType ()
	Returns a string with the Zid representing the type of this ZObject.
	getLinkedZObjects ()
	Return all ZObject Zids that are linked to the current ZObject.
	getSerialized ( $form=self::FORM_CANONICAL)
	Convert this ZObject into its serialized canonical representation.
	getHumanReadable ( $language=null)
	Convert this ZObject into human readable object by translating all keys and references into the preferred language or its fallbacks.
	__toString ()
	Over-ride the default __toString() method to serialise ZObjects into a JSON representation.

Static Public Member Functions
static	getDefinition ()
	@inheritDoc

Additional Inherited Members
Public Attributes inherited from MediaWiki\Extension\WikiLambda\ZObjects\ZObject
const	FORM_CANONICAL = 1
const	FORM_NORMAL = 2
Protected Attributes inherited from MediaWiki\Extension\WikiLambda\ZObjects\ZObject
	$type = null
	$data = []
	$linkedZObjects = []

Constructor & Destructor Documentation

__construct()

MediaWiki\Extension\WikiLambda\ZObjects\ZError::__construct	(		$type,
			$value )

Construct a new ZError instance.

Parameters

string	$type	ZErrorType Zid
ZObject	$value	Value that describes the ZError

Member Function Documentation

getDefinition()

static MediaWiki\Extension\WikiLambda\ZObjects\ZError::getDefinition ( )

static

@inheritDoc

Reimplemented from MediaWiki\Extension\WikiLambda\ZObjects\ZObject.

getErrorData()

MediaWiki\Extension\WikiLambda\ZObjects\ZError::getErrorData

(

)

Get all ZError related information in different forms for API failure response.

Returns

array

getMessage()

MediaWiki\Extension\WikiLambda\ZObjects\ZError::getMessage

(

)

Get a human-readable one-line string that identifies the ZError information.

Returns

string ZError message

getZErrorType()

MediaWiki\Extension\WikiLambda\ZObjects\ZError::getZErrorType

(

)

Get the Zid that identifies the ZErrorType that describes this ZError.

Returns

string ZErrorType Zid

getZValue()

MediaWiki\Extension\WikiLambda\ZObjects\ZError::getZValue

(

)

Get the content of the ZError value.

Returns

ZObject Value that describes this ZError

Reimplemented from MediaWiki\Extension\WikiLambda\ZObjects\ZObject.

isValid()

MediaWiki\Extension\WikiLambda\ZObjects\ZError::isValid

(

)

@inheritDoc

Reimplemented from MediaWiki\Extension\WikiLambda\ZObjects\ZObject.

---

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

• includes/ZObjects/ZError.php