Class Entry

The "atom:entry" element represents an individual entry, acting as a container for metadata and data associated with the entry.

Gedcomx\Atom\CommonAttributes

Gedcomx\Atom\ExtensibleElement

Gedcomx\Atom\Entry implements Gedcomx\Links\SupportsLinks

Direct known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\Util\ChangeEntry, Gedcomx\Extensions\FamilySearch\Rs\Client\Util\ChangeHistoryPage

Namespace: Gedcomx\Atom
Located at Atom/Entry.php

Methods summary

`public`	# `__construct( mixed $o = null )` Constructs a Entry from a (parsed) JSON hash Constructs a Entry from a (parsed) JSON hash Parameters `$o` Either an array (JSON) or an XMLReader. Throws Exception Overrides `Gedcomx\Atom\ExtensibleElement::__construct`
`public Gedcomx\Atom\Person[]`	# `getAuthors( )` The author of the entry. The author of the entry. Returns `Gedcomx\Atom\Person[]`
`public`	# `setAuthors( Gedcomx\Atom\Person[] $authors )` The author of the entry. The author of the entry. Parameters `$authors`
`public Gedcomx\Atom\Category[]`	# `getCategories( )` information about a category associated with an entry. information about a category associated with an entry. Returns `Gedcomx\Atom\Category[]`
`public`	# `setCategories( Gedcomx\Atom\Category[] $categories )` information about a category associated with an entry. information about a category associated with an entry. Parameters `$categories`
`public string`	# `getConfidence( )` The confidence of the result, if this entry represents a search result. The confidence of the result, if this entry represents a search result. Returns string
`public`	# `setConfidence( string $confidence )` The confidence of the result, if this entry represents a search result. The confidence of the result, if this entry represents a search result. Parameters `$confidence`
`public Gedcomx\Atom\Content`	# `getContent( )` The content of the entry. The content of the entry. Returns `Gedcomx\Atom\Content`
`public`	# `setContent( Gedcomx\Atom\Content $content )` The content of the entry. The content of the entry. Parameters `$content`
`public Gedcomx\Atom\Person[]`	# `getContributors( )` information about a category associated with the entry information about a category associated with the entry Returns `Gedcomx\Atom\Person[]`
`public`	# `setContributors( array $contributors )` information about a category associated with the entry information about a category associated with the entry Parameters `$contributors`
`public string`	# `getId( )` a permanent, universally unique identifier for the entry. a permanent, universally unique identifier for the entry. Returns string
`public`	# `setId( string $id )` a permanent, universally unique identifier for the entry. a permanent, universally unique identifier for the entry. Parameters `$id`
`public Gedcomx\Links\Link[]`	# `getLinks( )` a reference from a entry to a Web resource. a reference from a entry to a Web resource. Returns `Gedcomx\Links\Link[]` Implementation of `Gedcomx\Links\SupportsLinks::getLinks()`
`public`	# `setLinks( array $links )` a reference from a entry to a Web resource. a reference from a entry to a Web resource. Parameters `$links` Implementation of `Gedcomx\Links\SupportsLinks::setLinks()`
`public integer`	# `getPublished( )` instant in time associated with an event early in the life cycle of the entry. instant in time associated with an event early in the life cycle of the entry. Returns integer
`public`	# `setPublished( integer $published )` instant in time associated with an event early in the life cycle of the entry. instant in time associated with an event early in the life cycle of the entry. Parameters `$published`
`public string`	# `getRights( )` information about rights held in and over the entry. information about rights held in and over the entry. Returns string
`public`	# `setRights( string $rights )` information about rights held in and over the entry. information about rights held in and over the entry. Parameters `$rights`
`public float`	# `getScore( )` The relevance score. The relevance score. Returns float
`public`	# `setScore( float $score )` The relevance score. The relevance score. Parameters `$score`
`public string`	# `getTitle( )` a human-readable title for the entry a human-readable title for the entry Returns string
`public`	# `setTitle( string $title )` a human-readable title for the entry a human-readable title for the entry Parameters `$title`
`public integer`	# `getUpdated( )` the most recent instant in time when the entry was modified in a way the publisher considers significant. the most recent instant in time when the entry was modified in a way the publisher considers significant. Returns integer
`public`	# `setUpdated( integer $updated )` the most recent instant in time when the entry was modified in a way the publisher considers significant. the most recent instant in time when the entry was modified in a way the publisher considers significant. Parameters `$updated`
`public array`	# `toArray( )` Returns the associative array for this Entry Returns the associative array for this Entry Returns array Overrides `Gedcomx\Atom\ExtensibleElement::toArray`
`public`	# `initFromArray( array $o )` Initializes this Entry from an associative array Initializes this Entry from an associative array Parameters `$o` Overrides `Gedcomx\Atom\ExtensibleElement::initFromArray`
`public`	# `toXml( XMLWriter $writer, boolean $includeNamespaces = true )` Writes this Entry to an XML writer. Writes this Entry to an XML writer. Parameters `$writer` The XML writer. `$includeNamespaces` Whether to write out the namespaces in the element.
`public`	# `writeXmlContents( XMLWriter $writer )` Writes the contents of this Entry to an XML writer. The startElement is expected to be already provided. Writes the contents of this Entry to an XML writer. The startElement is expected to be already provided. Parameters `$writer` The XML writer. Overrides `Gedcomx\Atom\ExtensibleElement::writeXmlContents`
`public`	# `addLink( Gedcomx\Links\Link $link )` Add a link. Add a 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\Atom\ExtensibleElement

addExtensionElement(), findExtensionOfType(), findExtensionsOfType(), getExtensionElements(), removeExtensionElements(), setExtensionElement(), setExtensionElements()

Methods inherited from Gedcomx\Atom\CommonAttributes

getBase(), getLang(), initFromReader(), setBase(), setLang(), toJson()

Namespaces

Classes

Class Entry

Direct known subclasses

Methods summary

Parameters

Throws

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Implementation of

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Overrides

Parameters

Parameters

Overrides

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Methods inherited from Gedcomx\Atom\ExtensibleElement

Methods inherited from Gedcomx\Atom\CommonAttributes