Class SourceDescriptionsState

The SourceDescriptionsState exposes management functions for a collection of source descriptions.

Gedcomx\Rs\Client\GedcomxApplicationState

Extended by

Gedcomx\Rs\Client\SourceDescriptionsState

Namespace: Gedcomx\Rs\Client
Located at Rs/Client/SourceDescriptionsState.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 descriptions state using the specified client, request, response, access token, and state factory. Constructs a source descriptions 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\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
`public Gedcomx\Rs\Client\SourceDescriptionState\|null`	# `addSourceDescription( Gedcomx\Source\SourceDescription $source, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a source description the current collection of source descriptions. Adds a source description the current collection of source descriptions. Parameters `$source` `$option` Returns `Gedcomx\Rs\Client\SourceDescriptionState`\|null

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