Class StateFactory

The state factory is responsible for instantiating state classes from REST API responses.

Direct known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchStateFactory

Indirect known subclasses

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeStateFactory

Namespace: Gedcomx\Rs\Client
Located at Rs/Client/StateFactory.php

Methods summary

`public`	# `__construct( boolean $production = false )` Constructs a new instance of this state factory, using the environment specified (defaults to integration). Constructs a new instance of this state factory, using the environment specified (defaults to integration). Parameters `$production`
`public Gedcomx\Rs\Client\CollectionState`	# `newCollectionState( string $uri = null, GuzzleHttp\Client $method = "GET", GuzzleHttp\Client $client = null )` Returns a new collection state by invoking the specified URI and method, using the specified client. Returns a new collection state by invoking the specified URI and method, using the specified client. Parameters `$uri` Optional URI `$method` $client The client to use. `$client` $method The method. Returns `Gedcomx\Rs\Client\CollectionState` The collection state.
`public Gedcomx\Rs\Client\CollectionsState`	# `newCollectionsState( string $uri = null, GuzzleHttp\Client $method = "GET", GuzzleHttp\Client $client = null )` Returns a new collections state by invoking the specified URI and method, using the specified client. Returns a new collections state by invoking the specified URI and method, using the specified client. Parameters `$uri` Optional URI `$method` $client The client to use. `$client` $method The method. Returns `Gedcomx\Rs\Client\CollectionsState` The collections state.
`public Gedcomx\Rs\Client\CollectionState`	# `newDiscoveryState( string $uri = null, GuzzleHttp\Client $method = "GET", GuzzleHttp\Client $client = null )` Returns a new discovery state by invoking the specified URI and method, using the specified client. Returns a new discovery state by invoking the specified URI and method, using the specified client. Parameters `$uri` Optional URI `$method` $client The client to use. `$client` $method The method. Returns `Gedcomx\Rs\Client\CollectionState` The collection state.
`public Gedcomx\Rs\Client\PersonState`	# `newPersonState( string $uri, GuzzleHttp\Client $client = null, string $method = "GET" )` Returns a new person state by invoking the specified URI and method, using the specified client. Returns a new person state by invoking the specified URI and method, using the specified client. Parameters `$uri` The URI to the person. `$client` The client to use. `$method` The method. Returns `Gedcomx\Rs\Client\PersonState` The person state.
`public mixed`	# `createState( string $class, GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken )` Dynamically creates and returns a state instance for the specified class, if a state builder is defined. Dynamically creates and returns a state instance for the specified class, if a state builder is defined. Parameters `$class` The name of the state class to create `$client` `$request` `$response` `$accessToken` The access token for this session Returns mixed

Constants summary

`string`	`PRODUCTION_URI` The default production environment URI for the family tree. The default production environment URI for the family tree.	# `"https://api.familysearch.org/platform/collections/tree"`
`string`	`INTEGRATION_URI` The default integration environment URI for the family tree. The default integration environment URI for the family tree.	# `"https://api-integ.familysearch.org/platform/collections/tree"`
`string`	`PRODUCTION_DISCOVERY_URI` The default production environment URI for the discovery endpoint. The default production environment URI for the discovery endpoint.	# `"https://api.familysearch.org/platform/collection"`
`string`	`INTEGRATION_DISCOVERY_URI` The default integration environment URI for the discovery endpoint. The default integration environment URI for the discovery endpoint.	# `"https://api-integ.familysearch.org/platform/collection"`