gedcomx-php
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • Collection
  • CollectionContent
  • Field
  • FieldDescriptor
  • FieldValue
  • FieldValueDescriptor
  • RecordDescriptor
  • RecordSet
  • RecordSetIterator

Interfaces

  • HasFields

Class RecordSet

The GEDCOM X bulk record data formats are used to exchange bulk genealogical data sets, grouped into records.

Gedcomx\Common\ExtensibleData
Extended by Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks
Extended by Gedcomx\Records\RecordSet
Namespace: Gedcomx\Records
Located at Records/RecordSet.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a RecordSet from a (parsed) JSON hash

Constructs a RecordSet 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 the genealogical data.

The language of the genealogical data.

Returns

string
public
# setLang( string $lang )

The language of the genealogical data.

The language of the genealogical data.

Parameters

$lang
public Gedcomx\Gedcomx
# getMetadata( )

Metadata about this record set; shared among all records in the set.

Metadata about this record set; shared among all records in the set.

Returns

Gedcomx\Gedcomx
public
# setMetadata( Gedcomx\Gedcomx $metadata )

Metadata about this record set; shared among all records in the set.

Metadata about this record set; shared among all records in the set.

Parameters

$metadata
public Gedcomx\Gedcomx[]
# getRecords( )

The records included in this genealogical data set.

The records included in this genealogical data set.

Returns

Gedcomx\Gedcomx[]
public
# setRecords( array $records )

The records included in this genealogical data set.

The records included in this genealogical data set.

Parameters

$records
public array
# toArray( )

Returns the associative array for this RecordSet

Returns the associative array for this RecordSet

Returns

array

Overrides

Gedcomx\Links\HypermediaEnabledData::toArray
public
# initFromArray( array $o )

Initializes this RecordSet from an associative array

Initializes this RecordSet from an associative array

Parameters

$o

Overrides

Gedcomx\Links\HypermediaEnabledData::initFromArray
public
# toXml( XMLWriter $writer, boolean $includeNamespaces = true )

Writes this RecordSet to an XML writer.

Writes this RecordSet 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 RecordSet to an XML writer. The startElement is expected to be already provided.

Writes the contents of this RecordSet 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()

gedcomx-php API documentation generated by ApiGen