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 PersonMatchResultsState

The PersonMatchResultsState exposes management functions for a person match results.

Class PersonMatchResultsState

Gedcomx\Rs\Client\GedcomxApplicationState
Extended by Gedcomx\Rs\Client\PersonSearchResultsState
Extended by Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState
Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client
Package: Gedcomx\Extensions\FamilySearch\Rs\Client
Located at Extensions/FamilySearch/Rs/Client/PersonMatchResultsState.php

Methods summary

public
# __construct( GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken, Gedcomx\Rs\Client\StateFactory $stateFactory )

Constructs a new person match results state using the specified client, request, response, access token, and state factory.

Constructs a new person match results state using the specified client, request, response, access token, and state factory.

Parameters

$client
$request
$response
$accessToken
$stateFactory

Overrides

Gedcomx\Rs\Client\PersonSearchResultsState::__construct
public Gedcomx\Rs\Client\PersonState
# readPerson( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Reads the current person for these potential match results.

Reads the current person for these potential match results.

Parameters

$option

Returns

Gedcomx\Rs\Client\PersonState
public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
# readMergeOptions( Gedcomx\Atom\Entry $entry, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )

Reads merge options for the specified search result entry.

Reads merge options for the specified search result entry.

Parameters

$entry
$options

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
# readMergeAnalysis( Gedcomx\Atom\Entry $entry, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )

Creates a merge analysis for the current person and the potential duplicate person specified by the search result entry.

Creates a merge analysis for the current person and the potential duplicate person specified by the search result entry.

Parameters

$entry
$options

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState
# addNonMatch( Gedcomx\Atom\Entry $entry, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )

Declares the specified search result entry as not a match for the current person.

Declares the specified search result entry as not a match for the current person.

Parameters

$entry
$options

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState
public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState
# updateMatchStatus( Gedcomx\Atom\Entry $entry, string $status, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )

Declares the match status for the current person the specified search result entry.

Declares the match status for the current person the specified search result entry.

Parameters

$entry
$status
$options

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState

Methods inherited from Gedcomx\Rs\Client\PersonSearchResultsState

getResults(), readFirstPage(), readLastPage(), readNextPage(), readPersonFromConclusion(), readPersonFromEntry(), readPreviousPage(), readRecord()

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