WikiLambda
MediaWiki WikiLambda extension
Loading...
Searching...
No Matches
MediaWiki\Extension\WikiLambda\ZObjects\ZKey Class Reference
+ Inheritance diagram for MediaWiki\Extension\WikiLambda\ZObjects\ZKey:
+ Collaboration diagram for MediaWiki\Extension\WikiLambda\ZObjects\ZKey:

Public Member Functions

 __construct ( $type, $identity, $label, $isIdentity=null)
 Construct a new ZKey instance.
 
 isValid ()
 @inheritDoc
 
 getKeyType ()
 Get the Zid for the type that describes the value of this key.
 
 getKeyId ()
 Get the ZKey Id.
 
 getKeyLabel ()
 Get the ZMultilingualString that contains the label for this key.
 
 getIsIdentity ()
 Returns whether the key is identity or not.
 
- 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.
 
 getZValue ()
 Return the untyped content 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\ZKey::__construct ( $type,
$identity,
$label,
$isIdentity = null )

Construct a new ZKey instance.

Parameters
ZObject$typeZReference to the type for this key value
ZObject$identityZString with the key ID
ZObject$labelZMultiLingualString that contains the label of this key
ZObject | null$isIdentityoptional ZObject that contains the isIdentity flag

Member Function Documentation

◆ getDefinition()

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

@inheritDoc

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

◆ getIsIdentity()

MediaWiki\Extension\WikiLambda\ZObjects\ZKey::getIsIdentity ( )

Returns whether the key is identity or not.

Returns
bool

◆ getKeyId()

MediaWiki\Extension\WikiLambda\ZObjects\ZKey::getKeyId ( )

Get the ZKey Id.

Returns
string

◆ getKeyLabel()

MediaWiki\Extension\WikiLambda\ZObjects\ZKey::getKeyLabel ( )

Get the ZMultilingualString that contains the label for this key.

Returns
ZMultiLingualString

◆ getKeyType()

MediaWiki\Extension\WikiLambda\ZObjects\ZKey::getKeyType ( )

Get the Zid for the type that describes the value of this key.

Returns
string

◆ isValid()

MediaWiki\Extension\WikiLambda\ZObjects\ZKey::isValid ( )

@inheritDoc

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


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