Class PersonsState

The PersonsState exposes management functions for a persons collection.

Class PersonsState

Gedcomx\Rs\Client\GedcomxApplicationState

Extended by

Gedcomx\Rs\Client\PersonsState

Direct known subclasses

Gedcomx\Rs\Client\PersonChildrenState, Gedcomx\Rs\Client\PersonParentsState, Gedcomx\Rs\Client\PersonSpousesState

Indirect known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonChildrenState, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonParentsState

Namespace: Gedcomx\Rs\Client
Package: Gedcomx\Rs\Client
Located at Rs/Client/PersonsState.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 persons state using the specified client, request, response, access token, and state factory. Constructs a new persons 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\Conclusion\Person[]\|null`	# `getPersons( )` Gets the array of persons represented by this current instance. Gets the array of persons represented by this current instance. Returns `Gedcomx\Conclusion\Person[]`\|null
`public Gedcomx\Conclusion\Person\|null`	# `getPerson( Gedcomx\Common\ResourceReference\|string $personReference )` Get the specified person if it's available in the response Get the specified person if it's available in the response Parameters `$personReference` Returns `Gedcomx\Conclusion\Person`\|null
`public Gedcomx\Rs\Client\CollectionState\|null`	# `readCollection( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the collection specified by this state instance. Reads the collection specified by this state instance. Parameters `$option` Returns `Gedcomx\Rs\Client\CollectionState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `addPerson( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a person to the current collection. Adds a person to the current collection. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null

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