Class FamilySearchPlaces

The FamilySearchPlaces is a collection of FamilySearch places and exposes management of those places.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Rs\Client\CollectionState

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchPlaces

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

Methods summary

`public Gedcomx\Rs\Client\VocabElementListState\|null`	# `readPlaceTypeGroups( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the list of place type groups Read the list of place type groups Parameters `$option` Returns `Gedcomx\Rs\Client\VocabElementListState`\|null the list of place type groups
`public Gedcomx\Rs\Client\VocabElementListState`	# `readPlaceTypes( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the list of place types Read the list of place types Parameters `$option` Returns `Gedcomx\Rs\Client\VocabElementListState` the list of place types
`public Gedcomx\Rs\Client\VocabElementListState\|null`	# `readPlaceTypeGroupById( string $id, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the place type group with the given id Read the place type group with the given id Parameters `$id` `$option` Returns `Gedcomx\Rs\Client\VocabElementListState`\|null the place type group with the given id
`public Gedcomx\Rs\Client\VocabElementState\|null`	# `readPlaceTypeById( string $id, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the place type with the given id Read the place type with the given id Parameters `$id` `$option` Returns `Gedcomx\Rs\Client\VocabElementState`\|null the place type group with the given id
`public Gedcomx\Rs\Client\PlaceGroupState\|null`	# `readPlaceGroupById( string $id, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Return the PlaceGroup with the given id Return the PlaceGroup with the given id Parameters `$id` `$option` Returns `Gedcomx\Rs\Client\PlaceGroupState`\|null
`public Gedcomx\Rs\Client\PlaceSearchResultsState\|null`	# `searchForPlaces( Gedcomx\Rs\Client\GedcomxSearchQuery\|string $query, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Searches for places based off the specified query. Searches for places based off the specified query. Parameters `$query` `$option` Returns `Gedcomx\Rs\Client\PlaceSearchResultsState`\|null Throws `Gedcomx\Rs\Client\Exception\GedcomxInvalidQueryParameter`

Methods inherited from Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

__construct(), addDiscussion(), addProcessingTime(), getCollection(), normalizeDate(), readCurrentUser(), readCurrentUserHistory(), readDiscussions(), readPerson(), searchForPersonMatches()

Methods inherited from Gedcomx\Rs\Client\CollectionState

AddParentChildRelationship(), addArtifact(), addCollection(), addPerson(), addRecord(), addRelationship(), addRelationships(), addSourceDescription(), addSpouseRelationship(), readCollection(), readPersonForCurrentUser(), readPersons(), readRecords(), readRelationships(), readResourcesOfCurrentUser(), readSourceDescriptions(), readSubcollections(), searchForPersons(), update()

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

`public Gedcomx\Rs\Client\VocabElementListState\|null`	# `readPlaceTypeGroups( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the list of place type groups Read the list of place type groups Parameters `$option` Returns `Gedcomx\Rs\Client\VocabElementListState`\|null the list of place type groups
`public Gedcomx\Rs\Client\VocabElementListState`	# `readPlaceTypes( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the list of place types Read the list of place types Parameters `$option` Returns `Gedcomx\Rs\Client\VocabElementListState` the list of place types
`public Gedcomx\Rs\Client\VocabElementListState\|null`	# `readPlaceTypeGroupById( string $id, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the place type group with the given id Read the place type group with the given id Parameters `$id` `$option` Returns `Gedcomx\Rs\Client\VocabElementListState`\|null the place type group with the given id
`public Gedcomx\Rs\Client\VocabElementState\|null`	# `readPlaceTypeById( string $id, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the place type with the given id Read the place type with the given id Parameters `$id` `$option` Returns `Gedcomx\Rs\Client\VocabElementState`\|null the place type group with the given id
`public Gedcomx\Rs\Client\PlaceGroupState\|null`	# `readPlaceGroupById( string $id, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Return the PlaceGroup with the given id Return the PlaceGroup with the given id Parameters `$id` `$option` Returns `Gedcomx\Rs\Client\PlaceGroupState`\|null
`public Gedcomx\Rs\Client\PlaceSearchResultsState\|null`	# `searchForPlaces( Gedcomx\Rs\Client\GedcomxSearchQuery\|string $query, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Searches for places based off the specified query. Searches for places based off the specified query. Parameters `$query` `$option` Returns `Gedcomx\Rs\Client\PlaceSearchResultsState`\|null Throws `Gedcomx\Rs\Client\Exception\GedcomxInvalidQueryParameter`

Namespaces

Classes

Class FamilySearchPlaces

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Methods inherited from Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchCollectionState

Methods inherited from Gedcomx\Rs\Client\CollectionState

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState