Class FieldValueDescriptor

A way a field is to be displayed to a user.

Gedcomx\Common\ExtensibleData

Extended by

Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks

Extended by

Gedcomx\Records\FieldValueDescriptor

Namespace: Gedcomx\Records
Located at Records/FieldValueDescriptor.php

Methods summary

`public`	# `__construct( mixed $o = null )` Constructs a FieldValueDescriptor from a (parsed) JSON hash Constructs a FieldValueDescriptor from a (parsed) JSON hash Parameters `$o` Either an array (JSON) or an XMLReader. Throws Exception Overrides `Gedcomx\Links\HypermediaEnabledData::__construct`
`public boolean`	# `getOptional( )` Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty. Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty. Returns boolean
`public`	# `setOptional( boolean $optional )` Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty. Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty. Parameters `$optional`
`public string`	# `getType( )` The type of the field value. The type of the field value. Returns string
`public`	# `setType( string $type )` The type of the field value. The type of the field value. Parameters `$type`
`public string`	# `getLabelId( )` The id of the label applicable to the field value The id of the label applicable to the field value Returns string
`public`	# `setLabelId( string $labelId )` The id of the label applicable to the field value The id of the label applicable to the field value Parameters `$labelId`
`public Gedcomx\Common\TextValue[]`	# `getDisplayLabels( )` The labels to be used for display purposes. The labels to be used for display purposes. Returns `Gedcomx\Common\TextValue[]`
`public`	# `setDisplayLabels( array $displayLabels )` The labels to be used for display purposes. The labels to be used for display purposes. Parameters `$displayLabels`
`public array`	# `toArray( )` Returns the associative array for this FieldValueDescriptor Returns the associative array for this FieldValueDescriptor Returns array Overrides `Gedcomx\Links\HypermediaEnabledData::toArray`
`public`	# `initFromArray( array $o )` Initializes this FieldValueDescriptor from an associative array Initializes this FieldValueDescriptor from an associative array Parameters `$o` Overrides `Gedcomx\Links\HypermediaEnabledData::initFromArray`
`public`	# `writeXmlContents( XMLWriter $writer )` Writes the contents of this FieldValueDescriptor to an XML writer. The startElement is expected to be already provided. Writes the contents of this FieldValueDescriptor to an XML writer. The startElement is expected to be already provided. Parameters `$writer` The XML writer. Overrides `Gedcomx\Links\HypermediaEnabledData::writeXmlContents`

Methods inherited from Gedcomx\Links\HypermediaEnabledData

addLink(), addLinkRelation(), addTemplatedLink(), getLink(), getLinks(), getLinksByRel(), setLinks()

Methods inherited from Gedcomx\Common\ExtensibleData

addExtensionElement(), findExtensionOfType(), findExtensionsOfType(), getExtensionElements(), getId(), initFromReader(), removeExtensionElements(), setExtensionElement(), setExtensionElements(), setId(), toJson()