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

  • AgentState
  • AncestryResultsState
  • CollectionsState
  • CollectionState
  • DescendancyResultsState
  • GedcomxApplicationState
  • GedcomxSearchQuery
  • PersonChildrenState
  • PersonParentsState
  • PersonSearchResultsState
  • PersonSpousesState
  • PersonsState
  • PersonState
  • PlaceDescriptionsState
  • PlaceDescriptionState
  • PlaceGroupState
  • PlaceSearchResultsState
  • RecordsState
  • RecordState
  • Rel
  • RelationshipsState
  • RelationshipState
  • SearchParameter
  • SourceDescriptionsState
  • SourceDescriptionState
  • StateFactory
  • VocabConstants
  • VocabElementListState
  • VocabElementState

Interfaces

  • SupportsExtensionElements

Class PlaceDescriptionsState

The PlaceDescriptionsState exposes management functions for place descriptions.

Gedcomx\Rs\Client\GedcomxApplicationState
Extended by Gedcomx\Rs\Client\PlaceDescriptionsState
Namespace: Gedcomx\Rs\Client
Located at Rs/Client/PlaceDescriptionsState.php

Methods summary

public
# getPlaceDescriptions( )
public Gedcomx\Rs\Client\PlaceDescriptionState
# addPlaceDescription( Gedcomx\Conclusion\PlaceDescription $place, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Adds a place description to the current collection of place descriptions.

Adds a place description to the current collection of place descriptions.

Parameters

$place
$option

Returns

Gedcomx\Rs\Client\PlaceDescriptionState
public mixed|null
# readCollection( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )

Reads the collection specified by this state instance.

Reads the collection specified by this state instance.

Parameters

$option

Returns

mixed|null

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState

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

gedcomx-php-client API documentation generated by ApiGen