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

  • Attribution
  • CustomEntity
  • CustomKeyedItem
  • EvidenceReference
  • ExtensibleData
  • Note
  • Qualifier
  • ResourceReference
  • TextValue
  • UniqueCustomKeyedItem

Interfaces

  • Attributable
  • HasNotes

Class ExtensibleData

A set of data that supports extension elements.

Direct known subclasses

Gedcomx\Agent\Address, Gedcomx\Agent\OnlineAccount, Gedcomx\Common\Attribution, Gedcomx\Conclusion\DateInfo, Gedcomx\Conclusion\DisplayProperties, Gedcomx\Conclusion\NameForm, Gedcomx\Conclusion\NamePart, Gedcomx\Conclusion\PlaceDisplayProperties, Gedcomx\Conclusion\PlaceReference, Gedcomx\Links\HypermediaEnabledData

Indirect known subclasses

Gedcomx\Agent\Agent, Gedcomx\Common\EvidenceReference, Gedcomx\Conclusion\Person, Gedcomx\Conclusion\PlaceDescription, Gedcomx\Conclusion\Relationship, Gedcomx\Conclusion\Subject, Gedcomx\Extensions\FamilySearch\FamilySearchPlatform, Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment, Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion, Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship, Gedcomx\Extensions\FamilySearch\Platform\Tree\DiscussionReference, Gedcomx\Extensions\FamilySearch\Platform\Users\User, Gedcomx\Common\Note, Gedcomx\Gedcomx, Gedcomx\Records\Collection, Gedcomx\Records\CollectionContent, Gedcomx\Records\Field, Gedcomx\Records\FieldDescriptor, Gedcomx\Records\FieldValue, Gedcomx\Records\FieldValueDescriptor, Gedcomx\Records\RecordDescriptor, Gedcomx\Records\RecordSet, Gedcomx\Source\Coverage, Gedcomx\Conclusion\Conclusion, Gedcomx\Source\SourceCitation, Gedcomx\Source\SourceDescription, Gedcomx\Source\SourceReference, Gedcomx\Conclusion\Document, Gedcomx\Conclusion\Event, Gedcomx\Conclusion\EventRole, Gedcomx\Conclusion\Fact, Gedcomx\Conclusion\Gender, Gedcomx\Conclusion\Name

Namespace: Gedcomx\Common
Located at Common/ExtensibleData.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a ExtensibleData from a (parsed) JSON hash

Constructs a ExtensibleData from a (parsed) JSON hash

Parameters

$o
Either an array (JSON) or an XMLReader.

Throws

Exception
public string
# getId( )

A local, context-specific id for the data.

A local, context-specific id for the data.

Returns

string
public
# setId( string $id )

A local, context-specific id for the data.

A local, context-specific id for the data.

Parameters

$id
public array
# getExtensionElements( )

Custom extension elements for a conclusion.

Custom extension elements for a conclusion.

Returns

array
Custom extension elements for a conclusion.
public
# setExtensionElements( array $elements )

Custom extension elements for a conclusion.

Custom extension elements for a conclusion.

Parameters

$elements
Custom extension elements for a conclusion.
public
# addExtensionElement( mixed $element )

Add an extension element.

Add an extension element.

Parameters

$element
The extension element to add.
public array
# removeExtensionElements( string $class )

Remove extension elements of a given type.

Remove extension elements of a given type.

Parameters

$class
The type of extension element to remove.

Returns

array
The removed extension elements.
public
# setExtensionElement( mixed $element )

Sets an extension element by first removing all previous elements of the same type, then adding it to the list.

Sets an extension element by first removing all previous elements of the same type, then adding it to the list.

Parameters

$element
The element to set.
public mixed
# findExtensionOfType( string $class )

Finds the first extension of a specified type.

Finds the first extension of a specified type.

Parameters

$class
The type.

Returns

mixed
The extension, or null if none found.
public array
# findExtensionsOfType( string $class )

Find the extensions of a specified type.

Find the extensions of a specified type.

Parameters

$class
The type.

Returns

array
The extensions, possibly empty but not null.
public array
# toArray( )

Returns the associative array for this ExtensibleData

Returns the associative array for this ExtensibleData

Returns

array
public string
# toJson( )

Returns the JSON string for this ExtensibleData

Returns the JSON string for this ExtensibleData

Returns

string
public
# initFromArray( array $o )

Initializes this ExtensibleData from an associative array

Initializes this ExtensibleData from an associative array

Parameters

$o
public
# initFromReader( XMLReader $xml )

Initializes this ExtensibleData from an XML reader.

Initializes this ExtensibleData from an XML reader.

Parameters

$xml
The reader to use to initialize this object.
public
# writeXmlContents( XMLWriter $writer )

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

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

Parameters

$writer
The XML writer.
gedcomx-php API documentation generated by ApiGen