Class PersonSpousesState

The PersonSpousesState exposes management functions for person spouses.

Class PersonSpousesState

Gedcomx\Rs\Client\GedcomxApplicationState

Extended by

Gedcomx\Rs\Client\PersonsState

Extended by

Gedcomx\Rs\Client\PersonSpousesState

Namespace: Gedcomx\Rs\Client
Package: Gedcomx\Rs\Client
Located at Rs/Client/PersonSpousesState.php

Methods summary

`public`	# `__construct( GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken, Gedcomx\Rs\Client\StateFactory $stateFactory )` Create a new PersonSpousesState Create a new PersonSpousesState Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\PersonsState::__construct`
`public Gedcomx\Conclusion\Person[]\|null`	# `getPersons( )` Get the person objects associated with this state Get the person objects associated with this state Returns `Gedcomx\Conclusion\Person[]`\|null Overrides `Gedcomx\Rs\Client\PersonsState::getPersons`
`public Gedcomx\Conclusion\Relationship[]\|null`	# `getRelationships( )` Get the relationship objects associated with this state. Get the relationship objects associated with this state. Returns `Gedcomx\Conclusion\Relationship[]`\|null
`public Gedcomx\Conclusion\Relationship\|null`	# `findRelationshipTo( Gedcomx\Conclusion\Person $spouse )` Return the spouse relationship definition of the spouse Return the spouse relationship definition of the spouse Parameters `$spouse` Returns `Gedcomx\Conclusion\Relationship`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readPerson( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the primary person Read the primary person Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readSpouse( Gedcomx\Conclusion\Person $spouse, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the spouse person Read the spouse person Parameters `$spouse` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\RelationshipState\|null`	# `readRelationship( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the relationship definition of this relationship Read the relationship definition of this relationship Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`\|null
`public Gedcomx\Rs\Client\RelationshipState`	# `removeRelationship( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Delete this relationship Delete this relationship Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\RelationshipState`	# `removeRelationshipTo( Gedcomx\Conclusion\Person $spouse, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Remove the spouse person from this relationship Remove the spouse person from this relationship Parameters `$spouse` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState\|null`	# `readAncestryWithSpouse( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the Ancestry based on this spouse Read the Ancestry based on this spouse Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readDescendancyWithSpouse( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the Decendancy based on this spouse Read the Decendancy based on this spouse Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null

Methods inherited from Gedcomx\Rs\Client\PersonsState

addPerson(), getPerson(), 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(), getSelfRel(), getSelfUri(), getStatus(), getUri(), hasClientError(), hasError(), hasServerError(), hasStatus(), head(), ifSuccessful(), inject(), isAuthenticated(), loadAllEmbeddedResources(), logout(), options(), post(), put(), readAttributableContributor(), readContributor(), readReferenceContributor(), send()