Class PersonChildrenState

The PersonChildrenState exposes management functions for person children.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Rs\Client\PersonsState

Gedcomx\Rs\Client\PersonChildrenState

Direct known subclasses

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

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

Namespaces

Classes

Interfaces

Class PersonChildrenState

Direct known subclasses

Methods summary

Parameters

Overrides

Returns

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Methods inherited from Gedcomx\Rs\Client\PersonsState

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState