Class RelationshipsState

Class RelationshipsState

Gedcomx\Rs\Client\GedcomxApplicationState

Extended by

Gedcomx\Rs\Client\RelationshipsState

Direct known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeRelationshipsState

Namespace: Gedcomx\Rs\Client
Package: Gedcomx\Rs\Client
Located at Rs/Client/RelationshipsState.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 relationships state using the specified client, request, response, access token, and state factory. Constructs a new relationships 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 null\|string`	# `getSelfRel( )` Define the rel name for this state as a fall back if it cannot be determined from state data. Define the rel name for this state as a fall back if it cannot be determined from state data. Returns null\|string Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::getSelfRel`
`public Gedcomx\Conclusion\Relationship[]\|null`	# `getRelationships( )` Gets the relationships represented by the current entity collection Gedcomx->getRelationships(). Gets the relationships represented by the current entity collection Gedcomx->getRelationships(). Returns `Gedcomx\Conclusion\Relationship[]`\|null
`public Gedcomx\Rs\Client\CollectionState\|null`	# `readCollection( )` Reads the collection specified by this state instance. Reads the collection specified by this state instance. Returns `Gedcomx\Rs\Client\CollectionState`\|null The collection that contains these collections.
`public Gedcomx\Rs\Client\RelationshipState`	# `addRelationship( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Creates a relationship between the persons specified in the relationship parameter. Creates a relationship between the persons specified in the relationship parameter. Parameters `$relationship` `$options` Returns `Gedcomx\Rs\Client\RelationshipState`
`public mixed`	# `addSpouseRelationship( Gedcomx\Conclusion\Person $person1, Gedcomx\Conclusion\Person $person2, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Creates a spouse relationship between the two specified persons. The person1 parameter does not have to be the husband, it could be the wife; however, person2 must be the opposite. So if you specify a husband for person1 then person2 must be the wife. Conversely, if you specify a wife for person1 then person2 must be the husband. Creates a spouse relationship between the two specified persons. The person1 parameter does not have to be the husband, it could be the wife; however, person2 must be the opposite. So if you specify a husband for person1 then person2 must be the wife. Conversely, if you specify a wife for person1 then person2 must be the husband. Parameters `$person1` `$person2` `$options` Returns mixed
`public mixed`	# `addParentChildRelationship( Gedcomx\Conclusion\Person $parent, Gedcomx\Conclusion\Person $child, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Creates a parent child relationship for the specified persons. * Creates a parent child relationship for the specified persons. * Parameters `$parent` `$child` `$options` Returns mixed

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