Class FamilyTreePersonState

The PersonState exposes management functions for a person.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState

Namespace: Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree
Located at Extensions/FamilySearch/Rs/Client/FamilyTree/FamilyTreePersonState.php

Methods summary

Methods inherited from Gedcomx\Rs\Client\PersonState

addArtifact(), addChild(), addEvidenceReference(), addEvidenceReferences(), addFact(), addFacts(), addGender(), addMediaDescription(), addMediaReference(), addMediaReferences(), addName(), addNames(), addNote(), addNotes(), addParent(), addPersonEvidence(), addPersonaPersonState(), addPersonaReference(), addPersonaReferences(), addSourceReferenceObj(), addSourceReferenceRecord(), addSourceReferenceState(), addSourceReferences(), addSpouse(), deleteEvidenceReference(), deleteFact(), deleteGender(), deleteMediaReference(), deleteName(), deleteNote(), deletePersonaReference(), deleteSourceReference(), getChildRelationships(), getConclusion(), getDisplayProperties(), getEvidenceReference(), getFact(), getGender(), getMediaReference(), getName(), getNote(), getParentRelationships(), getPerson(), getPersonaReference(), getRelationships(), getSelfRel(), getSourceReference(), getSpouseRelationships(), loadChildRelationships(), loadConclusions(), loadEmbeddedResources(), loadEvidenceReferences(), loadMediaReferences(), loadNotes(), loadParentRelationships(), loadPersonaReferences(), loadSourceReferences(), loadSpouseRelationships(), readAncestry(), readArtifacts(), readChild(), readChildByIndex(), readChildren(), readCollection(), readDescendancy(), readFirstChild(), readFirstParent(), readFirstSpouse(), readNote(), readParent(), readParentByIndex(), readParents(), readRelationship(), readRelative(), readSources(), readSpouse(), readSpouseFromIndex(), readSpouses(), update(), updateConclusions(), updateEvidenceReference(), updateEvidenceReferences(), updateFact(), updateFacts(), updateGender(), updateMediaReference(), updateMediaReferences(), updateName(), updateNames(), updateNote(), updateNotes(), updatePersonNotes(), updatePersonaReference(), updatePersonaReferences(), updateSourceReference(), updateSourceReferences()

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(), getSelfUri(), getStatus(), getUri(), hasClientError(), hasError(), hasServerError(), hasStatus(), head(), ifSuccessful(), inject(), isAuthenticated(), loadAllEmbeddedResources(), logout(), options(), post(), put(), readAttributableContributor(), readContributor(), readReferenceContributor(), send()

`public`	# `__construct( GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken, Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeStateFactory $stateFactory )` Create new instance of FamilyTreePersonState Create new instance of FamilyTreePersonState Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\PersonState::__construct`
`public Gedcomx\Conclusion\Person[]\|null`	# `getPersons( )` Return the Person conclusion objects on this state Return the Person conclusion objects on this state Returns `Gedcomx\Conclusion\Person[]`\|null
`public Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[]\|null`	# `getChildAndParentsRelationships( )` Return the ChildAndParentsRelationship objects on this state Return the ChildAndParentsRelationship objects on this state Returns `Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[]`\|null
`public Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[]\|null`	# `getRelationshipsToChildren( )` Return the ChildAndParentsRelationship objects where this person is the child Return the ChildAndParentsRelationship objects where this person is the child Returns `Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship[]`\|null
`public`	# `getRelationshipsToParents( )`
`public mixed`	# `loadDiscussionReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load discussion references for this person Load discussion references for this person Parameters `$option` Returns mixed
`public Gedcomx\Rs\Client\SourceDescriptionsState`	# `readPortraits( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load portraits associated with this person Load portraits associated with this person Parameters `$option` Returns `Gedcomx\Rs\Client\SourceDescriptionsState`
`public GuzzleHttp\Psr7\Response`	# `readPortrait( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the portrait for this person Read the portrait for this person Parameters `$option` Returns GuzzleHttp\Psr7\Response
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `addDiscussionState( Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState $discussion, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a discussion reference to this person using a state object Add a discussion reference to this person using a state object Parameters `$discussion` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `addDiscussionReference( Gedcomx\Extensions\FamilySearch\Platform\Tree\DiscussionReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a discussion reference to this person using a DiscussionReference object Add a discussion reference to this person using a DiscussionReference object Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `addDiscussionReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a list of discussion references to this person Add a list of discussion references to this person Parameters `$refs` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `updateDiscussionReference( Gedcomx\Extensions\FamilySearch\Platform\Tree\DiscussionReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a discussion reference on this person Update a discussion reference on this person Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `updateDiscussionReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a list of discussion references on this person Update a list of discussion references on this person Parameters `$refs` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `updatePersonDiscussionReferences( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the discussion references on a Person object Update the discussion references on a Person object Parameters `$person` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `deleteDiscussionReference( Gedcomx\Extensions\FamilySearch\Platform\Tree\DiscussionReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Delete a discussion reference Delete a discussion reference Parameters `$reference` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`	# `readChildAndParentsRelationship( Gedcomx\Extensions\FamilySearch\Platform\Tree\ChildAndParentsRelationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the child and parent relationships for this person Read the child and parent relationships for this person Parameters `$relationship` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChildAndParentsRelationshipState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChangeHistoryState`	# `readChangeHistory( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the change history for this person Read the change history for this person Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChangeHistoryState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState`	# `readMatches( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Get the person records flagged as possible matches to this record Get the person records flagged as possible matches to this record Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState`	# `readNonMatches( Gedcomx\Rs\Client\Options\StateTransitionOption $options = null )` Read persons that have been marked as not a match for this person Read persons that have been marked as not a match for this person Parameters `$options` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`	# `restore( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Restore this person if it has been deleted Restore this person if it has been deleted Parameters `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState`	# `readMergeOptions( Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState $candidate, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads merge options for merging the candidate with the current person Reads merge options for merging the candidate with the current person Parameters `$candidate` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState`	# `readMergeAnalysis( Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState $candidate, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the merge analysis resulting from comparing the current person with the candidate Reads the merge analysis resulting from comparing the current person with the candidate Parameters `$candidate` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState`	# `addNonMatchState( Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Flag the Person passed as not a match to the current person using a state object Flag the Person passed as not a match to the current person using a state object Parameters `$person` `$option` ,.. Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState`
`public Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState\|null`	# `addNonMatchPerson( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Flag the Person passed as not a match to the current person using a Person conclusion object Flag the Person passed as not a match to the current person using a Person conclusion object Parameters `$person` `$option` Returns `Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState`\|null

Namespaces

Classes

Interfaces

Class FamilyTreePersonState

Methods summary

Parameters

Overrides

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from Gedcomx\Rs\Client\PersonState

Methods inherited from Gedcomx\Rs\Client\GedcomxApplicationState