Class FieldDescriptor

A description of a field in a record.

Gedcomx\Common\ExtensibleData

Extended by

Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks

Extended by

Gedcomx\Records\FieldDescriptor

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

Methods summary

`public`	# `__construct( mixed $o = null )` Constructs a FieldDescriptor from a (parsed) JSON hash Constructs a FieldDescriptor from a (parsed) JSON hash Parameters `$o` Either an array (JSON) or an XMLReader. Throws Exception Overrides `Gedcomx\Links\HypermediaEnabledData::__construct`
`public string`	# `getOriginalLabel( )` The original label for the field, as stated on the original record. The original label for the field, as stated on the original record. Returns string
`public`	# `setOriginalLabel( string $originalLabel )` The original label for the field, as stated on the original record. The original label for the field, as stated on the original record. Parameters `$originalLabel`
`public Gedcomx\Common\TextValue[]`	# `getDescription( )` The description of the field. The description of the field. Returns `Gedcomx\Common\TextValue[]`
`public`	# `setDescription( Gedcomx\Common\TextValue[] $description )` The description of the field. The description of the field. Parameters `$description`
`public Gedcomx\Records\FieldValueDescriptor[]`	# `getValues( )` Descriptors of the values that are applicable to the field. Descriptors of the values that are applicable to the field. Returns `Gedcomx\Records\FieldValueDescriptor[]`
`public`	# `setValues( Gedcomx\Records\FieldValueDescriptor[] $values )` Descriptors of the values that are applicable to the field. Descriptors of the values that are applicable to the field. Parameters `$values`
`public array`	# `toArray( )` Returns the associative array for this FieldDescriptor Returns the associative array for this FieldDescriptor Returns array Overrides `Gedcomx\Links\HypermediaEnabledData::toArray`
`public`	# `initFromArray( array $o )` Initializes this FieldDescriptor from an associative array Initializes this FieldDescriptor from an associative array Parameters `$o` Overrides `Gedcomx\Links\HypermediaEnabledData::initFromArray`
`public`	# `writeXmlContents( XMLWriter $writer )` Writes the contents of this FieldDescriptor to an XML writer. The startElement is expected to be already provided. Writes the contents of this FieldDescriptor 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()