Class FamilySearchStateFactory
The state factory is responsible for instantiating state classes from REST API responses.
Class FamilySearchStateFactory
- Gedcomx\Rs\Client\StateFactory
- Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchStateFactory
Direct known subclasses
Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeStateFactory
Package: Gedcomx\Extensions\FamilySearch\Rs\Client
Located at Extensions/FamilySearch/Rs/Client/FamilySearchStateFactory.php
Methods summary
public
|
#
newCollectionState( string $uri = null, string $method = "GET", GuzzleHttp\Client $client = null )
Creates a new FamilySearch collection state from the specified parameters. Since a response is provided as a parameter, a REST API request will not be invoked. |
public
|
#
newPlacesState( string $uri = null, string $method = "GET", GuzzleHttp\Client $client = null )
Create a new places state with the given URI |
public
|
#
newMemoriesState( null $uri = null, string $method = "GET", GuzzleHttp\Client $client = null )
Create a new memories state |
Methods inherited from Gedcomx\Rs\Client\StateFactory
__construct()
,
createState()
,
newCollectionsState()
,
newDiscoveryState()
,
newPersonState()
Constants summary
string |
PLACES_URI
The default production environment URI for the places collection. |
#
"https://familysearch.org/platform/collections/places"
|
string |
PLACES_SANDBOX_URI
The default sandbox environment URI for the places collection. |
#
"https://sandbox.familysearch.org/platform/collections/places"
|
string |
MEMORIES_URI
The default production environment URI for the memories collection. |
#
"https://familysearch.org/platform/collections/memories"
|
string |
MEMORIES_SANDBOX_URI
The default sandbox environment URI for the memories collection. |
#
"https://sandbox.familysearch.org/platform/collections/memories"
|
Constants inherited from Gedcomx\Rs\Client\StateFactory
PRODUCTION_DISCOVERY_URI
,
PRODUCTION_URI
,
SANDBOX_DISCOVERY_URI
,
SANDBOX_URI