Class SourceDescriptionState

The SourceDescriptionState exposes management functions for a source description.

Gedcomx\Rs\Client\GedcomxApplicationState

Extended by

Gedcomx\Rs\Client\SourceDescriptionState

Direct known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchSourceDescriptionState

Namespace: Gedcomx\Rs\Client
Located at Rs/Client/SourceDescriptionState.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 source description state using the specified client, request, response, access token and state factory. Constructs a source description 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 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`
`public Gedcomx\Source\SourceDescription\|null`	# `getSourceDescription( )` Gets the source description represented by this state instance. Gets the source description represented by this state instance. Returns `Gedcomx\Source\SourceDescription`\|null
`public Gedcomx\Rs\Client\SourceDescriptionState`	# `update( Gedcomx\Gedcomx\|Gedcomx\Source\SourceDescription $description, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the specified source description. Updates the specified source description. Parameters `$description` `$option` Returns `Gedcomx\Rs\Client\SourceDescriptionState`
`public Gedcomx\Rs\Client\PersonsState`	# `readPersons( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read persons associated with the current source description. Read persons associated with the current source description. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonsState`
`public mixed`	# `readPersonas( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read personas associated with the current source description. Read personas associated with the current source description. Parameters `$option` Returns mixed
`public Gedcomx\Rs\Client\PersonState`	# `addPersonPersona( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a persona to the current source description using a person object. Adds a persona to the current source description using a person object. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addGedcomxPersona( Gedcomx\Gedcomx $persona, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a persona to the current source description using a GEDCOM X object. Adds a persona to the current source description using a GEDCOM X object. Parameters `$persona` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\SourceDescriptionState`	# `queryAttachedReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Queries for attached references to this source description. Queries for attached references to this source description. Parameters `$option` Returns `Gedcomx\Rs\Client\SourceDescriptionState`
`public Gedcomx\Rs\Client\CollectionState`	# `readCollection( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the collection specified by this state instance. Reads the collection specified by this state instance. Parameters `$option` Returns `Gedcomx\Rs\Client\CollectionState`

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