Class PersonParentsState

The PersonParentsState exposes management functions for person parents.

Class PersonParentsState

Gedcomx\Rs\Client\GedcomxApplicationState

Extended by

Gedcomx\Rs\Client\PersonsState

Extended by

Gedcomx\Rs\Client\PersonParentsState

Direct known subclasses

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

Namespace: Gedcomx\Rs\Client
Package: Gedcomx\Rs\Client
Located at Rs/Client/PersonParentsState.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 parents state using the specified client, request, response, access token, and state factory. Constructs a new person parents state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\PersonsState::__construct`
`public Gedcomx\Conclusion\Person[]\|null`	# `getPersons( )` Gets the list of parents for the person represented by this state instance. Gets the list of parents for the person represented by this state instance. Returns `Gedcomx\Conclusion\Person[]`\|null Overrides `Gedcomx\Rs\Client\PersonsState::getPersons`
`public Gedcomx\Conclusion\Relationship[]\|null`	# `getRelationships( )` Gets the list of relationships for the person's parents. Gets the list of relationships for the person's parents. Returns `Gedcomx\Conclusion\Relationship[]`\|null
`public Gedcomx\Conclusion\Relationship\|null`	# `findRelationshipTo( Gedcomx\Conclusion\Person $parent )` Finds the relationship to the specified parent. This method iterates over the current person's relationships, and each item is examined to determine if the parent ID in the relationship matches the parent ID for the specified parent. If one is found, that relationship object containing that parent ID is returned, and no other relationships are examined further. Finds the relationship to the specified parent. This method iterates over the current person's relationships, and each item is examined to determine if the parent ID in the relationship matches the parent ID for the specified parent. If one is found, that relationship object containing that parent ID is returned, and no other relationships are examined further. Parameters `$parent` Returns `Gedcomx\Conclusion\Relationship`\|null
`public Gedcomx\Rs\Client\PersonState`	# `readPerson( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the current person represented by this state instance. Reads the current person represented by this state instance. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `readParent( Gedcomx\Conclusion\Person $parent, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the specified person, which is a parent to the current person. This person could come the array of persons for the current person. Reads the specified person, which is a parent to the current person. This person could come the array of persons for the current person. Parameters `$parent` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\RelationshipState`	# `readRelationship( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the specified relationship, which is a relationship between the current person and a parent. This relationship could come from the array of relationships for the current person. Reads the specified relationship, which is a relationship between the current person and a parent. This relationship could come from the array of relationships for the current person. Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `removeRelationship( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Removes the specified relationship, which is a relationship between the current person and a parent. Removes the specified relationship, which is a relationship between the current person and a parent. Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\RelationshipState`	# `removeRelationshipTo( Gedcomx\Conclusion\Person $parent, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Removes the relationship from the current person to the specified person. Removes the relationship from the current person to the specified person. Parameters `$parent` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`

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