Class PersonSearchResultsState

The PersonSearchResultsState exposes management functions for person search results.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Rs\Client\PersonSearchResultsState

Direct known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState

Namespace: Gedcomx\Rs\Client
Package: Gedcomx\Rs\Client
Located at Rs/Client/PersonSearchResultsState.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 search results state using the specified client, request, response, access token, and state factory. Constructs a new person search results state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::__construct`
`public Gedcomx\Atom\Feed`	# `getResults( )` Gets the search results from the atom feed response. Gets the search results from the atom feed response. Returns `Gedcomx\Atom\Feed`
`public Gedcomx\Rs\Client\PersonState\|null`	# `readPersonFromConclusion( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the person from the specified person model. Reads the person from the specified person model. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readPersonFromEntry( Gedcomx\Atom\Entry $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the person from the specified atom feed entry. Reads the person from the specified atom feed entry. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\RecordState\|null`	# `readRecord( Gedcomx\Atom\Entry $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the person record from the specified atom feed entry. Reads the person record from the specified atom feed entry. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\RecordState`\|null
`public Gedcomx\Rs\Client\GedcomxApplicationState`	# `readNextPage( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Parameters `$option` Returns `Gedcomx\Rs\Client\GedcomxApplicationState` The next page.
`public Gedcomx\Rs\Client\GedcomxApplicationState`	# `readPreviousPage( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Parameters `$option` Returns `Gedcomx\Rs\Client\GedcomxApplicationState` The previous page.
`public Gedcomx\Rs\Client\GedcomxApplicationState`	# `readFirstPage( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Parameters `$option` Returns `Gedcomx\Rs\Client\GedcomxApplicationState` The first page.
`public Gedcomx\Rs\Client\GedcomxApplicationState`	# `readLastPage( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Parameters `$option` Returns `Gedcomx\Rs\Client\GedcomxApplicationState` the last page.

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

Namespaces

Classes

Interfaces

Class PersonSearchResultsState

Direct known subclasses

Methods summary

Parameters

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState