Class Collection

A collection of genealogical resources.

Gedcomx\Common\ExtensibleData

Extended by

Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks

Extended by

Gedcomx\Records\Collection

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

Methods summary

`public`	# `__construct( mixed $o = null )` Constructs a Collection from a (parsed) JSON hash Constructs a Collection from a (parsed) JSON hash Parameters `$o` Either an array (JSON) or an XMLReader. Throws Exception Overrides `Gedcomx\Links\HypermediaEnabledData::__construct`
`public string`	# `getLang( )` The language of this description of the collection The language of this description of the collection Returns string
`public`	# `setLang( string $lang )` The language of this description of the collection The language of this description of the collection Parameters `$lang`
`public string`	# `getTitle( )` A title for the collection. A title for the collection. Returns string
`public`	# `setTitle( string $title )` A title for the collection. A title for the collection. Parameters `$title`
`public integer`	# `getSize( )` The size of the collection, in terms of the number of items in this collection. The size of the collection, in terms of the number of items in this collection. Returns integer
`public`	# `setSize( integer $size )` The size of the collection, in terms of the number of items in this collection. The size of the collection, in terms of the number of items in this collection. Parameters `$size`
`public Gedcomx\Records\CollectionContent[]`	# `getContent( )` Descriptions of the content of this collection. Descriptions of the content of this collection. Returns `Gedcomx\Records\CollectionContent[]`
`public`	# `setContent( Gedcomx\Records\CollectionContent[] $content )` Descriptions of the content of this collection. Descriptions of the content of this collection. Parameters `$content`
`public Gedcomx\Common\Attribution`	# `getAttribution( )` Attribution metadata for this collection. Attribution metadata for this collection. Returns `Gedcomx\Common\Attribution`
`public`	# `setAttribution( Gedcomx\Common\Attribution $attribution )` Attribution metadata for this collection. Attribution metadata for this collection. Parameters `$attribution`
`public array`	# `toArray( )` Returns the associative array for this Collection Returns the associative array for this Collection Returns array Overrides `Gedcomx\Links\HypermediaEnabledData::toArray`
`public`	# `initFromArray( array $o )` Initializes this Collection from an associative array Initializes this Collection from an associative array Parameters `$o` Overrides `Gedcomx\Links\HypermediaEnabledData::initFromArray`
`public`	# `accept( Gedcomx\Rt\GedcomxModelVisitor $visitor )`
`public`	# `toXml( XMLWriter $writer, boolean $includeNamespaces = true )` Writes this Collection to an XML writer. Writes this Collection 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 Collection to an XML writer. The startElement is expected to be already provided. Writes the contents of this Collection 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()