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 RecordDescriptor

A descriptor for a common set of records.

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a RecordDescriptor from a (parsed) JSON hash

Constructs a RecordDescriptor 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 record description.

The language of this record description.

Returns

string
public
# setLang( string $lang )

The language of this record description.

The language of this record description.

Parameters

$lang
public Gedcomx\Records\FieldDescriptor[]
# getFields( )

Descriptors of the fields that are applicable to this record.

Descriptors of the fields that are applicable to this record.

Returns

Gedcomx\Records\FieldDescriptor[]
public
# setFields( array $fields )

Descriptors of the fields that are applicable to this record.

Descriptors of the fields that are applicable to this record.

Parameters

$fields
public array
# toArray( )

Returns the associative array for this RecordDescriptor

Returns the associative array for this RecordDescriptor

Returns

array

Overrides

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

Initializes this RecordDescriptor from an associative array

Initializes this RecordDescriptor from an associative array

Parameters

$o

Overrides

Gedcomx\Links\HypermediaEnabledData::initFromArray
public
# accept( Gedcomx\Rt\GedcomxModelVisitor $visitor )
public
# writeXmlContents( XMLWriter $writer )

Writes the contents of this RecordDescriptor to an XML writer. The startElement is expected to be already provided.

Writes the contents of this RecordDescriptor 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