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

  • DiscussionsState
  • DiscussionState
  • FamilySearchClient
  • FamilySearchCollectionState
  • FamilySearchPlaceDescriptionState
  • FamilySearchPlaces
  • FamilySearchPlaceState
  • FamilySearchSourceDescriptionState
  • FamilySearchStateFactory
  • PersonMatchResultsState
  • PersonMergeState
  • PersonNonMatchesState
  • Rel
  • UserHistoryState
  • UserState

Class PersonMergeState

The PersonMergeState exposes management functions for a person merge.

Class PersonMergeState

Gedcomx\Rs\Client\GedcomxApplicationState
Extended by Gedcomx\Rs\Client\CollectionState
Extended by Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState
Extended by Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client
Package: Gedcomx\Extensions\FamilySearch\Rs\Client
Located at Extensions/FamilySearch/Rs/Client/PersonMergeState.php

Methods summary

public Gedcomx\Extensions\FamilySearch\Platform\Tree\MergeAnalysis|null
# getAnalysis( )

Gets the analysis of the current person merge.

Gets the analysis of the current person merge.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Tree\MergeAnalysis|null
public
# isAllowed( )

If there is no 'Allow' header, it is allowed

If there is no 'Allow' header, it is allowed

Returns

boolean
public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState|null
# readMergeMirror( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Reads the merge mirror for the current merge.

Reads the merge mirror for the current merge.

Parameters

$option

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState|null
public Gedcomx\Rs\Client\PersonState|null
# readSurvivor( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Reads the survivor of the current merge.

Reads the survivor of the current merge.

Parameters

$option

Returns

Gedcomx\Rs\Client\PersonState|null
public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
# doMerge( Gedcomx\Extensions\FamilySearch\Platform\Tree\Merge $merge, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Performs the specified merge operation.

Performs the specified merge operation.

Parameters

$merge
$option

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
# mergeEntity( Gedcomx\Extensions\FamilySearch\FamilySearchPlatform $entity, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Performs the specified merges from FamilySearchPlatform::getMerges().

Performs the specified merges from FamilySearchPlatform::getMerges().

Parameters

$entity
$option

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState

Methods inherited from Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

__construct(), addDiscussion(), addProcessingTime(), getCollection(), normalizeDate(), readCurrentUser(), readCurrentUserHistory(), readDiscussions(), readPerson(), searchForPersonMatches()

Methods inherited from Gedcomx\Rs\Client\CollectionState

AddParentChildRelationship(), addArtifact(), addCollection(), addPerson(), addRecord(), addRelationship(), addRelationships(), addSourceDescription(), addSpouseRelationship(), readCollection(), readPersonForCurrentUser(), readPersons(), readRecords(), readRelationships(), readResourcesOfCurrentUser(), readSourceDescriptions(), readSubcollections(), searchForPersons(), update()

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