MediaWiki\Extension\WikiLambda\ZObjects\ZType Class Reference

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

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

Public Member Functions
	__construct ( $identity, $keys, $validator)
	Construct a ZType instance given the identity ZReference, a ZTypedList of ZKeys, and a ZReference to the type validator.
	isValid ()
	@inheritDoc
	getZValue ()
	Get the complete data values of this ZType, comprised of identity, keys and validator.
	getTypeId ()
	Get the string representation of th ZType Zid.
	getTypeKeys ()
	Get a list with the set of ZKeys for this ZType.
	getTypeValidator ()
	Get the string representation fo the ZReference to this ZType validator.
	getZKey ( $key)
	Get the ZKey of a given key reference from the set of ZKeys of this ZType or null if the ZKey is not available.
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\ZType::__construct	(		$identity,
			$keys,
			$validator )

Construct a ZType instance given the identity ZReference, a ZTypedList of ZKeys, and a ZReference to the type validator.

Parameters

ZObject	$identity
ZObject	$keys
ZObject	$validator

Member Function Documentation

getDefinition()

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

static

@inheritDoc

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

getTypeId()

MediaWiki\Extension\WikiLambda\ZObjects\ZType::getTypeId

(

)

Get the string representation of th ZType Zid.

Returns

string

getTypeKeys()

MediaWiki\Extension\WikiLambda\ZObjects\ZType::getTypeKeys

(

)

Get a list with the set of ZKeys for this ZType.

Returns

ZTypedList

getTypeValidator()

MediaWiki\Extension\WikiLambda\ZObjects\ZType::getTypeValidator

(

)

Get the string representation fo the ZReference to this ZType validator.

Returns

string

getZKey()

MediaWiki\Extension\WikiLambda\ZObjects\ZType::getZKey

(

$key

)

Get the ZKey of a given key reference from the set of ZKeys of this ZType or null if the ZKey is not available.

Parameters

string

$key

Returns

ZKey|null

getZValue()

MediaWiki\Extension\WikiLambda\ZObjects\ZType::getZValue

(

)

Get the complete data values of this ZType, comprised of identity, keys and validator.

Returns

array

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

isValid()

MediaWiki\Extension\WikiLambda\ZObjects\ZType::isValid

(

)

@inheritDoc

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

---

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

• includes/ZObjects/ZType.php