Class Feed

The Atom data formats provide a format for web content and metadata syndication. The XML media type is defined by RFC 4287. The JSON data format is specific to GEDCOM X and is a translation to JSON from the XML.

Gedcomx\Atom\CommonAttributes

Gedcomx\Atom\ExtensibleElement

Gedcomx\Atom\Feed

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

Methods summary

`public`	# `__construct( mixed $o = null )` Constructs a Feed from a (parsed) JSON hash Constructs a Feed 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 feed. The author of the feed. Returns `Gedcomx\Atom\Person[]`
`public`	# `setAuthors( Gedcomx\Atom\Person[] $authors )` The author of the feed. The author of the feed. Parameters `$authors`
`public Gedcomx\Atom\Person[]`	# `getContributors( )` information about a category associated with the feed information about a category associated with the feed Returns `Gedcomx\Atom\Person[]`
`public`	# `setContributors( Gedcomx\Atom\Person[] $contributors )` information about a category associated with the feed information about a category associated with the feed Parameters `$contributors`
`public Gedcomx\Atom\Generator`	# `getGenerator( )` identifies the agent used to generate the feed identifies the agent used to generate the feed Returns `Gedcomx\Atom\Generator`
`public`	# `setGenerator( Gedcomx\Atom\Generator $generator )` identifies the agent used to generate the feed identifies the agent used to generate the feed Parameters `$generator`
`public string`	# `getIcon( )` identifies an image that provides iconic visual identification for the feed. identifies an image that provides iconic visual identification for the feed. Returns string
`public`	# `setIcon( string $icon )` identifies an image that provides iconic visual identification for the feed. identifies an image that provides iconic visual identification for the feed. Parameters `$icon`
`public string`	# `getId( )` a permanent, universally unique identifier for the feed. a permanent, universally unique identifier for the feed. Returns string
`public`	# `setId( string $id )` a permanent, universally unique identifier for the feed. a permanent, universally unique identifier for the feed. Parameters `$id`
`public integer`	# `getResults( )` The total number of results available, if this feed is supplying a subset of results, such as for a query. The total number of results available, if this feed is supplying a subset of results, such as for a query. Returns integer
`public`	# `setResults( integer $results )` The total number of results available, if this feed is supplying a subset of results, such as for a query. The total number of results available, if this feed is supplying a subset of results, such as for a query. Parameters `$results`
`public integer`	# `getIndex( )` The index of the first entry in this page of data, if this feed is supplying a page of data. The index of the first entry in this page of data, if this feed is supplying a page of data. Returns integer
`public`	# `setIndex( integer $index )` The index of the first entry in this page of data, if this feed is supplying a page of data. The index of the first entry in this page of data, if this feed is supplying a page of data. Parameters `$index`
`public Gedcomx\Links\Link[]`	# `getLinks( )` a reference from a feed to a Web resource. a reference from a feed to a Web resource. Returns `Gedcomx\Links\Link[]`
`public`	# `setLinks( Gedcomx\Links\Link[] $links )` a reference from a feed to a Web resource. a reference from a feed to a Web resource. Parameters `$links`
`public string`	# `getLogo( )` identifies an image that provides visual identification for the feed. identifies an image that provides visual identification for the feed. Returns string
`public`	# `setLogo( string $logo )` identifies an image that provides visual identification for the feed. identifies an image that provides visual identification for the feed. Parameters `$logo`
`public string`	# `getRights( )` information about rights held in and over the feed. information about rights held in and over the feed. Returns string
`public`	# `setRights( string $rights )` information about rights held in and over the feed. information about rights held in and over the feed. Parameters `$rights`
`public string`	# `getSubtitle( )` a human-readable description or subtitle for the feed. a human-readable description or subtitle for the feed. Returns string
`public`	# `setSubtitle( string $subtitle )` a human-readable description or subtitle for the feed. a human-readable description or subtitle for the feed. Parameters `$subtitle`
`public string`	# `getTitle( )` a human-readable title for the feed a human-readable title for the feed Returns string
`public`	# `setTitle( string $title )` a human-readable title for the feed a human-readable title for the feed Parameters `$title`
`public integer`	# `getUpdated( )` the most recent instant in time when the feed was modified in a way the publisher considers significant. the most recent instant in time when the feed was modified in a way the publisher considers significant. Returns integer
`public`	# `setUpdated( integer $updated )` the most recent instant in time when the feed was modified in a way the publisher considers significant. the most recent instant in time when the feed was modified in a way the publisher considers significant. Parameters `$updated`
`public Gedcomx\Atom\Entry[]`	# `getEntries( )` The entries in the feed. The entries in the feed. Returns `Gedcomx\Atom\Entry[]`
`public`	# `setEntries( Gedcomx\Atom\Entry[] $entries )` The entries in the feed. The entries in the feed. Parameters `$entries`
`public Gedcomx\Records\Field[]`	# `getFacets( )` The list of facets for the feed, used for convenience in browsing and filtering. The list of facets for the feed, used for convenience in browsing and filtering. Returns `Gedcomx\Records\Field[]`
`public`	# `setFacets( Gedcomx\Records\Field[] $facets )` The list of facets for the feed, used for convenience in browsing and filtering. The list of facets for the feed, used for convenience in browsing and filtering. Parameters `$facets`
`public array`	# `toArray( )` Returns the associative array for this Feed Returns the associative array for this Feed Returns array Overrides `Gedcomx\Atom\ExtensibleElement::toArray`
`public`	# `initFromArray( array $o )` Initializes this Feed from an associative array Initializes this Feed from an associative array Parameters `$o` Overrides `Gedcomx\Atom\ExtensibleElement::initFromArray`
`public`	# `toXml( XMLWriter $writer, boolean $includeNamespaces = true )` Writes this Feed to an XML writer. Writes this Feed 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 Feed to an XML writer. The startElement is expected to be already provided. Writes the contents of this Feed to an XML writer. The startElement is expected to be already provided. Parameters `$writer` The XML writer. Overrides `Gedcomx\Atom\ExtensibleElement::writeXmlContents`

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 Feed

Methods summary

Parameters

Throws

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Overrides

Parameters

Parameters

Overrides

Methods inherited from Gedcomx\Atom\ExtensibleElement

Methods inherited from Gedcomx\Atom\CommonAttributes