Class HypermediaEnabledData

An data type that supports hypermedia controls (i.e. links).

Gedcomx\Common\ExtensibleData

Extended by

Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks

Direct known subclasses

Gedcomx\Agent\Agent, Gedcomx\Common\EvidenceReference, Gedcomx\Records\CollectionContent, Gedcomx\Records\Field, Gedcomx\Records\FieldDescriptor, Gedcomx\Records\FieldValueDescriptor, Gedcomx\Records\RecordDescriptor, Gedcomx\Records\RecordSet, Gedcomx\Source\Coverage, Gedcomx\Source\SourceCitation, Gedcomx\Source\SourceDescription, Gedcomx\Source\SourceReference, Gedcomx\Common\Note, Gedcomx\Conclusion\Conclusion, Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment, Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion, Gedcomx\Extensions\FamilySearch\Platform\Tree\DiscussionReference, Gedcomx\Extensions\FamilySearch\Platform\Users\User, Gedcomx\Gedcomx, Gedcomx\Records\Collection

Indirect known subclasses

Gedcomx\Conclusion\Document, Gedcomx\Conclusion\Event, Gedcomx\Extensions\FamilySearch\FamilySearchPlatform, Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship, Gedcomx\Records\FieldValue, Gedcomx\Conclusion\EventRole, Gedcomx\Conclusion\Fact, Gedcomx\Conclusion\Gender, Gedcomx\Conclusion\Name, Gedcomx\Conclusion\Person, Gedcomx\Conclusion\PlaceDescription, Gedcomx\Conclusion\Relationship, Gedcomx\Conclusion\Subject

Namespace: Gedcomx\Links
Located at Links/HypermediaEnabledData.php

Methods summary

`public`	# `__construct( mixed $o = null )` Constructs a HypermediaEnabledData from a (parsed) JSON hash Constructs a HypermediaEnabledData from a (parsed) JSON hash Parameters `$o` Either an array (JSON) or an XMLReader. Throws Exception Overrides `Gedcomx\Common\ExtensibleData::__construct`
`public Gedcomx\Links\Link[]`	# `getLinks( )` The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. Returns `Gedcomx\Links\Link[]` Implementation of `Gedcomx\Links\SupportsLinks::getLinks()`
`public`	# `setLinks( array $links )` The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. Parameters `$links` Implementation of `Gedcomx\Links\SupportsLinks::setLinks()`
`public array`	# `toArray( )` Returns the associative array for this HypermediaEnabledData Returns the associative array for this HypermediaEnabledData Returns array Overrides `Gedcomx\Common\ExtensibleData::toArray`
`public`	# `initFromArray( array $o )` Initializes this HypermediaEnabledData from an associative array Initializes this HypermediaEnabledData from an associative array Parameters `$o` Overrides `Gedcomx\Common\ExtensibleData::initFromArray`
`public`	# `writeXmlContents( XMLWriter $writer )` Writes the contents of this HypermediaEnabledData to an XML writer. The startElement is expected to be already provided. Writes the contents of this HypermediaEnabledData to an XML writer. The startElement is expected to be already provided. Parameters `$writer` The XML writer. Overrides `Gedcomx\Common\ExtensibleData::writeXmlContents`
`public`	# `addLink( Gedcomx\Links\Link $link )` Parameters `$link` Implementation of `Gedcomx\Links\SupportsLinks::addLink()`
`public`	# `addLinkRelation( string $rel, string $href )` Add a hypermedia link relationship Add a hypermedia link relationship Parameters `$rel` see Gedcom\Rs\Client\Rel `$href` The target URI. Implementation of `Gedcomx\Links\SupportsLinks::addLinkRelation()`
`public`	# `addTemplatedLink( string $rel, string $template )` Add a templated link. Add a templated link. Parameters `$rel` see Gedcom\Rs\Client\Rel `$template` The link template. Implementation of `Gedcomx\Links\SupportsLinks::addTemplatedLink()`
`public Gedcomx\Links\Link`	# `getLink( string $rel )` Get a link by its rel. Get a link by its rel. Parameters `$rel` see Gedcom\Rs\Client\Rel Returns `Gedcomx\Links\Link` Implementation of `Gedcomx\Links\SupportsLinks::getLink()`
`public Gedcomx\Links\Link[]`	# `getLinksByRel( string $rel )` Get a list of links by rel. Get a list of links by rel. Parameters `$rel` see Gedcom\Rs\Client\Rel Returns `Gedcomx\Links\Link[]` Implementation of `Gedcomx\Links\SupportsLinks::getLinksByRel()`

Methods inherited from Gedcomx\Common\ExtensibleData

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