Class RelationshipState

The RelationshipState exposes management functions for a relationship.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Rs\Client\RelationshipState

Direct known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeRelationshipState

Namespace: Gedcomx\Rs\Client
Located at Rs/Client/RelationshipState.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 relationship state using the specified client, request, response, access token, and state factory. Constructs a relationship 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\Relationship`	# `getRelationship( )` Gets the first relationship of the current relationships. Gets the first relationship of the current relationships. Returns `Gedcomx\Conclusion\Relationship`
`public Gedcomx\Rs\Client\RelationshipState`	# `addFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a fact to the current relationship. Adds a fact to the current relationship. Parameters `$fact` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addFacts( array $facts, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds facts to the current relationship. Adds facts to the current relationship. Parameters `$facts` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the fact of the current relationship. Updates the fact of the current relationship. Parameters `$fact` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateFacts( array $facts, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the facts of the current relationship. Updates the facts of the current relationship. Parameters `$facts` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `deleteFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Deletes the fact of the current relationship. Deletes the fact of the current relationship. Parameters `$fact` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\RelationshipState`	# `addSourceDescriptionState( Gedcomx\Rs\Client\SourceDescriptionState $source, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds the specified source reference (in the SourceDescriptionState) to the current relationship. Adds the specified source reference (in the SourceDescriptionState) to the current relationship. Parameters `$source` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addSourceReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds the specified source reference to the current relationship. Adds the specified source reference to the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addSourceReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds the specified source references to the current relationship. Adds the specified source references to the current relationship. Parameters `$refs` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateSourceReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the specified source reference for the current relationship. Updates the specified source reference for the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateSourceReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the specified source references for the current relationship. Updates the specified source references for the current relationship. Parameters `$refs` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `deleteSourceReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Deletes the specified source reference from the current relationship. Deletes the specified source reference from the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\RelationshipState`	# `addMediaReferenceState( Gedcomx\Rs\Client\SourceDescriptionState $description, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a media reference to the current relationship. Adds a media reference to the current relationship. Parameters `$description` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addMediaReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a media reference to the current relationship. Adds a media reference to the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addMediaReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds media references to the current relationship. Adds media references to the current relationship. Parameters `$refs` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateMediaReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the media reference for the current relationship. Updates the media reference for the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateMediaReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the media references for the current relationship. Updates the media references for the current relationship. Parameters `$refs` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `deleteMediaReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Deletes the specified media reference from the current relationship. Deletes the specified media reference from the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\RelationshipState`	# `addEvidenceReferenceState( Gedcomx\Rs\Client\RelationshipState $evidence, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds an evidence reference to the current relationship. Adds an evidence reference to the current relationship. Parameters `$evidence` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addEvidenceReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds an evidence reference to the current relationship. Adds an evidence reference to the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addEvidenceReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds the evidence references to the current relationship. Adds the evidence references to the current relationship. Parameters `$refs` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateEvidenceReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the evidence reference for the current relationship. Update the evidence reference for the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateEvidenceReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the evidence references for the current relationship. Updates the evidence references for the current relationship. Parameters `$refs` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `deleteEvidenceReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Deletes the evidence reference from the current relationship. Deletes the evidence reference from the current relationship. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Common\Note\|null`	# `getNote( )` Gets the first note from the current relationship notes. Gets the first note from the current relationship notes. Returns `Gedcomx\Common\Note`\|null
`public Gedcomx\Source\SourceReference\|null`	# `getSourceReference( )` Gets the first source reference from the current relationship sources. Gets the first source reference from the current relationship sources. Returns `Gedcomx\Source\SourceReference`\|null
`public Gedcomx\Rs\Client\RelationshipState`	# `readNote( Gedcomx\Common\Note $note, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Reads the specified note. Reads the specified note. Parameters `$note` `$options` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\RelationshipState`	# `addNote( Gedcomx\Common\Note $note, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a note to the current relationship. Adds a note to the current relationship. Parameters `$note` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addNotes( array $notes, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add the notes to the current relationship. Add the notes to the current relationship. Parameters `$notes` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateNote( Gedcomx\Common\Note $note, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the specified note for the current relationship. Updates the specified note for the current relationship. Parameters `$note` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateNotes( array $notes, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the specified notes for the current relationship. Update the specified notes for the current relationship. Parameters `$notes` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `updateRelationshipNotes( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the notes on the specified relationship. Update the notes on the specified relationship. Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`
`public Gedcomx\Rs\Client\RelationshipState`	# `deleteNote( Gedcomx\Common\Note $note, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Delete the specified note from the current relationship. Delete the specified note from the current relationship. Parameters `$note` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public mixed`	# `updateSelf( Gedcomx\Conclusion\Relationship $relationship )` Updates the specified relationship. Updates the specified relationship. Parameters `$relationship` Returns mixed
`public mixed`	# `loadConclusions( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Loads conclusions for the current relationship. Loads conclusions for the current relationship. Parameters `$option` Returns mixed
`public mixed`	# `loadSourceReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Loads source references for the current relationship. Loads source references for the current relationship. Parameters `$option` Returns mixed
`public mixed`	# `loadMediaReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Loads media references for the current relationship. Loads media references for the current relationship. Parameters `$option` Returns mixed
`public mixed`	# `loadEvidenceReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Loads evidence references for the current relationship. Loads evidence references for the current relationship. Parameters `$option` Returns mixed
`public mixed`	# `loadNotes( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Loads notes for the current relationship. Loads notes for the current relationship. Parameters `$option` Returns mixed
`public`	# `loadEmbeddedResources( array $rels, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Loads the embedded resources for the specified links. Loads the embedded resources for the specified links. Parameters `$rels` `$option` Returns $this
`public Gedcomx\Rs\Client\SourceDescriptionState\|null`	# `readSources( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the list of sources associated with this relationship Read the list of sources associated with this relationship Parameters `$option` Returns `Gedcomx\Rs\Client\SourceDescriptionState`\|null
`public string`	# `getSelfRel( )` Gets the rel name for the current state instance. Gets the rel name for the current state instance. Returns string Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::getSelfRel`

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

Namespaces

Classes

Interfaces

Class RelationshipState

Direct known subclasses

Methods summary

Parameters

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters