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

  • Error
  • FamilySearchPlatform
  • Feature
  • HealthConfig
  • OAuth2
  • Tag

Class FamilySearchPlatform

The FamilySearch data types define serialization formats that are specific the FamilySearch developer platform. These data formats are extensions of the GEDCOM X media types and provide concepts and data types that are specific to FamilySearch and therefore haven't been adopted into a formal, more general specification.

Gedcomx\Common\ExtensibleData
Extended by Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks
Extended by Gedcomx\Gedcomx
Extended by Gedcomx\Extensions\FamilySearch\FamilySearchPlatform
Namespace: Gedcomx\Extensions\FamilySearch
Located at Extensions/FamilySearch/FamilySearchPlatform.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a FamilySearchPlatform from a (parsed) JSON hash

Constructs a FamilySearchPlatform from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

Gedcomx\Gedcomx::__construct
public Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[]
# getChildAndParentsRelationships( )

The child-and-parents relationships for this data set.

The child-and-parents relationships for this data set.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[]
public
# setChildAndParentsRelationships( Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[] $childAndParentsRelationships )

The child-and-parents relationships for this data set.

The child-and-parents relationships for this data set.

Parameters

$childAndParentsRelationships
public
# addChildAndParentsRelationship( Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship $relation )

Parameters

$relation
public
# addDiscussion( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion $discussion )

Add a discussion to the data set.

Add a discussion to the data set.

Parameters

$discussion
The discussion to be added.
public Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion[]
# getDiscussions( )

The discussions included in this data set.

The discussions included in this data set.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion[]
public
# setDiscussions( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion[] $discussions )

The discussions included in this data set.

The discussions included in this data set.

Parameters

$discussions
public
# addUser( Gedcomx\Extensions\FamilySearch\Platform\Users\User $user )

Add a user to the data set.

Add a user to the data set.

Parameters

$user
The user to be added.
public Gedcomx\Extensions\FamilySearch\Platform\Users\User[]
# getUsers( )

The users included in this genealogical data set.

The users included in this genealogical data set.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Users\User[]
public
# setUsers( Gedcomx\Extensions\FamilySearch\Platform\Users\User[] $users )

The users included in this genealogical data set.

The users included in this genealogical data set.

Parameters

$users
public
# addMerge( Gedcomx\Extensions\FamilySearch\Platform\Tree\Merge $merge )

Add a merge to the data set.

Add a merge to the data set.

Parameters

$merge
The user to be added.
public Gedcomx\Extensions\FamilySearch\Platform\Tree\Merge[]
# getMerges( )

The merges for this data set.

The merges for this data set.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Tree\Merge[]
public
# setMerges( Gedcomx\Extensions\FamilySearch\Platform\Tree\Merge[] $merges )

The merges for this data set.

The merges for this data set.

Parameters

$merges
public
# addMergeAnalysis( Gedcomx\Extensions\FamilySearch\Platform\Tree\MergeAnalysis $mergeAnalysis )

Add a merge analysis to the data set.

Add a merge analysis to the data set.

Parameters

$mergeAnalysis
The user to be added.
public Gedcomx\Extensions\FamilySearch\Platform\Tree\MergeAnalysis[]
# getMergeAnalyses( )

The merge analysis results for this data set.

The merge analysis results for this data set.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Tree\MergeAnalysis[]
public
# setMergeAnalyses( Gedcomx\Extensions\FamilySearch\Platform\Tree\MergeAnalysis[] $mergeAnalyses )

The merge analysis results for this data set.

The merge analysis results for this data set.

Parameters

$mergeAnalyses
public Gedcomx\Extensions\FamilySearch\Feature[]
# getFeatures( )

The set of features defined in the platform API.

The set of features defined in the platform API.

Returns

Gedcomx\Extensions\FamilySearch\Feature[]
public
# setFeatures( Gedcomx\Extensions\FamilySearch\Feature[] $features )

The set of features defined in the platform API.

The set of features defined in the platform API.

Parameters

$features
public Gedcomx\Extensions\FamilySearch\Error[]
# getErrors( )

List of errors associated with an API response.

List of errors associated with an API response.

Returns

Gedcomx\Extensions\FamilySearch\Error[]
public
# setErrors( Gedcomx\Extensions\FamilySearch\Error[] $errors )

List of errors associated with an API response.

List of errors associated with an API response.

Parameters

$errors
public array
# toArray( )

Returns the associative array for this FamilySearchPlatform

Returns the associative array for this FamilySearchPlatform

Returns

array

Overrides

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

Initializes this FamilySearchPlatform from an associative array

Initializes this FamilySearchPlatform from an associative array

Parameters

$o

Overrides

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

Writes this FamilySearchPlatform to an XML writer.

Writes this FamilySearchPlatform to an XML writer.

Parameters

$writer
The XML writer.
$includeNamespaces
Whether to write out the namespaces in the element.

Overrides

Gedcomx\Gedcomx::toXml
public
# writeXmlContents( XMLWriter $writer )

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

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

Parameters

$writer
The XML writer.

Overrides

Gedcomx\Gedcomx::writeXmlContents

Methods inherited from Gedcomx\Gedcomx

accept(), addPerson(), addRelationship(), addSourceDescription(), getAgents(), getAttribution(), getCollections(), getDescriptionRef(), getDocuments(), getEvents(), getFields(), getLang(), getPersons(), getPlaces(), getProfile(), getRecordDescriptors(), getRelationships(), getSourceDescriptions(), setAgents(), setAttribution(), setCollections(), setDescriptionRef(), setDocuments(), setEvents(), setFields(), setLang(), setPersons(), setPlaces(), setProfile(), setRecordDescriptors(), setRelationships(), setSourceDescriptions()

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()

Constants summary

string PROJECT_ID
# "fs-platform"

Constants inherited from Gedcomx\Gedcomx

ATOM_JSON_MEDIA_TYPE, ATOM_XML_MEDIA_TYPE, FORM_DATA_TYPE, HTML_TYPE, JSON_APPLICATION_TYPE, JSON_MEDIA_TYPE, LD_JSON_TYPE, PLAIN_TEXT, XML_MEDIA_TYPE

gedcomx-php API documentation generated by ApiGen