gedcomx-php-client
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rs
          • Client
            • FamilyTree
            • Helpers
            • Memories
            • Util
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rs
      • Client
        • Exception
        • Options
        • Util
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • DiscussionsState
  • DiscussionState
  • FamilySearchClient
  • FamilySearchCollectionState
  • FamilySearchPlaceDescriptionState
  • FamilySearchPlaces
  • FamilySearchPlaceState
  • FamilySearchSourceDescriptionState
  • FamilySearchStateFactory
  • PersonMatchResultsState
  • PersonMergeState
  • PersonNonMatchesState
  • Rel
  • UserHistoryState
  • UserState

Class FamilySearchStateFactory

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

Class FamilySearchStateFactory

Gedcomx\Rs\Client\StateFactory
Extended by Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchStateFactory

Direct known subclasses

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

Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client
Package: Gedcomx\Extensions\FamilySearch\Rs\Client
Located at Extensions/FamilySearch/Rs/Client/FamilySearchStateFactory.php

Methods summary

public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState
# 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.

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.

Parameters

$uri
$method
The method.
$client
The client to use.

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState
The collection state.

Overrides

Gedcomx\Rs\Client\StateFactory::newCollectionState
public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchPlaces
# newPlacesState( string $uri = null, string $method = "GET", GuzzleHttp\Client $client = null )

Create a new places state with the given URI

Create a new places state with the given URI

Parameters

$uri
$method
$client

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchPlaces
public Gedcomx\Extensions\FamilySearch\Rs\Client\Memories\FamilySearchMemories
# newMemoriesState( null $uri = null, string $method = "GET", GuzzleHttp\Client $client = null )

Create a new memories state

Create a new memories state

Parameters

$uri
$method
$client

Returns

Gedcomx\Extensions\FamilySearch\Rs\Client\Memories\FamilySearchMemories

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.

The default production environment URI for the places collection.

# "https://api.familysearch.org/platform/collections/places"
string PLACES_INTEGRATION_URI

The default integration environment URI for the places collection.

The default integration environment URI for the places collection.

# "https://integration.familysearch.org/platform/collections/places"
string MEMORIES_URI

The default production environment URI for the memories collection.

The default production environment URI for the memories collection.

# "https://api.familysearch.org/platform/collections/memories"
string MEMORIES_INTEGRATION_URI

The default integration environment URI for the memories collection.

The default integration environment URI for the memories collection.

# "https://integration.familysearch.org/platform/collections/memories"

Constants inherited from Gedcomx\Rs\Client\StateFactory

INTEGRATION_DISCOVERY_URI, INTEGRATION_URI, PRODUCTION_DISCOVERY_URI, PRODUCTION_URI

gedcomx-php-client API documentation generated by ApiGen