Class CollectionsState

Class CollectionsState

Gedcomx\Rs\Client\GedcomxApplicationState

Extended by

Gedcomx\Rs\Client\CollectionsState

Namespace: Gedcomx\Rs\Client
Package: Gedcomx\Rs\Client
Located at Rs/Client/CollectionsState.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 collections state using the specified client, request, response, access token, and state factory. Constructs a new collections 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\Records\Collection[]\|null`	# `getCollections( )` Gets the collections represented by the current state instance. Gets the collections represented by the current state instance. Returns `Gedcomx\Records\Collection[]`\|null
`public Gedcomx\Source\SourceDescription[]\|null`	# `getSourceDescriptions( )` Gets the source descriptions represented by the current state instance. Gets the source descriptions represented by the current state instance. Returns `Gedcomx\Source\SourceDescription[]`\|null
`public Gedcomx\Rs\Client\CollectionState\|null`	# `readCollection( Gedcomx\Records\Collection\|Gedcomx\Source\SourceDescription\|null $collection, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Reads the specified collection. Reads the specified collection. Parameters `$collection` `$options` Returns `Gedcomx\Rs\Client\CollectionState`\|null The collection that contains these collections.
`public Gedcomx\Rs\Client\CollectionState\|null`	# `updateCollection( Gedcomx\Records\Collection $collection, Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Updates the specified collection. Updates the specified collection. Parameters `$collection` `$options` Returns `Gedcomx\Rs\Client\CollectionState`\|null
`public Gedcomx\Rs\Client\CollectionState\|null`	# `addCollection( Gedcomx\Records\Collection $collection )` Adds a collection to the collection by this state instance. Adds a collection to the collection by this state instance. Parameters `$collection` the collection to add to these collections. Returns `Gedcomx\Rs\Client\CollectionState`\|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()