MediaWiki\Extension\WikiLambda\ZObjects\ZKeyReference Class Reference

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

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

Public Member Functions
	__construct ( $value)
	Construct a ZKeyReference instance, bypassing the internal ZString formally contained.
	isValid ()
	@inheritDoc
	getZValue ()
	Get string value of the ZKeyReference object.
	getKeyLabel ()
	Returns the label of the current ZKeyReference, if it is a global key.
Public Member Functions inherited from MediaWiki\Extension\WikiLambda\ZObjects\ZObject
	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\ZKeyReference::__construct

(

$value

)

Construct a ZKeyReference instance, bypassing the internal ZString formally contained.

Parameters

ZString | string

$value

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

Member Function Documentation

getDefinition()

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

static

@inheritDoc

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

getKeyLabel()

MediaWiki\Extension\WikiLambda\ZObjects\ZKeyReference::getKeyLabel

(

)

Returns the label of the current ZKeyReference, if it is a global key.

Else it returns the untranslated key.

Returns

string

getZValue()

MediaWiki\Extension\WikiLambda\ZObjects\ZKeyReference::getZValue

(

)

Get string value of the ZKeyReference object.

Returns

string The identifier of the ZKey referred by this ZObject

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

isValid()

MediaWiki\Extension\WikiLambda\ZObjects\ZKeyReference::isValid

(

)

@inheritDoc

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

---

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

• includes/ZObjects/ZKeyReference.php