gedcomx-php-client
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rs
          • Client
            • FamilyTree
            • Helpers
            • Memories
            • Util
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rs
      • Client
        • Exception
        • Options
        • Util
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • ChangeHistoryState
  • ChildAndParentsRelationshipState
  • FamilyTreeCollectionState
  • FamilyTreePersonChildrenState
  • FamilyTreePersonParentsState
  • FamilyTreePersonState
  • FamilyTreeRelationshipsState
  • FamilyTreeRelationshipState
  • FamilyTreeStateFactory

Interfaces

  • PreferredRelationshipState

Class FamilyTreeRelationshipsState

The FamilyTreeRelationshipsState exposes management functions for family tree relationships.

Class FamilyTreeRelationshipsState

Gedcomx\Rs\Client\GedcomxApplicationState
Extended by Gedcomx\Rs\Client\RelationshipsState
Extended by Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeRelationshipsState
Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree
Package: Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree
Located at Extensions/FamilySearch/Rs/Client/FamilyTree/FamilyTreeRelationshipsState.php

Methods summary

public Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[]|null
# getChildAndParentsRelationships( )

Gets the child and parents relationships of the current state instance.

Gets the child and parents relationships of the current state instance.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[]|null
public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeRelationshipsState
# addRelationship( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Adds the specified relationship to this collection of relationships. To add a RelationshipType::PARENTCHILD relationship, use addChildAndParents() or addChildAndParentsRelationship() instead.

Adds the specified relationship to this collection of relationships. To add a RelationshipType::PARENTCHILD relationship, use addChildAndParents() or addChildAndParentsRelationship() instead.

Parameters

$relationship
$option

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeRelationshipsState

Throws

Gedcomx\Rs\Client\Exception\GedcomxApplicationException

Overrides

Gedcomx\Rs\Client\RelationshipsState::addRelationship
public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState
# addChildAndParents( Gedcomx\Rs\Client\PersonState $child, Gedcomx\Rs\Client\PersonState $father = null, Gedcomx\Rs\Client\PersonState $mother = null, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Adds a child and parents relationship to the current relationships collection.

Adds a child and parents relationship to the current relationships collection.

Parameters

$child
$father
$mother
$option

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState
public mixed
# addChildAndParentsRelationship( Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship $chap, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Adds a child and parents relationship to the current relationships collection.

Adds a child and parents relationship to the current relationships collection.

Parameters

$chap
$option

Returns

mixed

Methods inherited from Gedcomx\Rs\Client\RelationshipsState

__construct(), addParentChildRelationship(), addSpouseRelationship(), getRelationships(), getSelfRel(), readCollection()

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState

authenticateViaOAuth2AuthCode(), authenticateViaOAuth2ClientCredentials(), authenticateViaOAuth2Password(), authenticateViaOAuth2WithoutCredentials(), authenticateWithAccessToken(), delete(), generateClientSecret(), get(), getAccessToken(), getClient(), getETag(), getEntity(), getHeader(), getHeaders(), getLastEmbeddedRequest(), getLastEmbeddedResponse(), getLastModified(), getLink(), getLinks(), getRequest(), getResourceReference(), getResponse(), getSelfUri(), getStatus(), getUri(), hasClientError(), hasError(), hasServerError(), hasStatus(), head(), ifSuccessful(), inject(), isAuthenticated(), loadAllEmbeddedResources(), logout(), options(), post(), put(), readAttributableContributor(), readContributor(), readReferenceContributor(), send()

gedcomx-php-client API documentation generated by ApiGen