Class PersonState

The PersonState exposes management functions for a person.

Gedcomx\Rs\Client\GedcomxApplicationState

Gedcomx\Rs\Client\PersonState

Direct known subclasses

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

Namespace: Gedcomx\Rs\Client
Located at Rs/Client/PersonState.php

Methods summary

`public`	# `__construct( GuzzleHttp\Client $client, GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Response $response, string $accessToken, Gedcomx\Rs\Client\StateFactory $stateFactory )` Constructs a new person state using the specified client, request, response, access token, and state factory. Constructs a new person state using the specified client, request, response, access token, and state factory. Parameters `$client` `$request` `$response` `$accessToken` `$stateFactory` Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::__construct`
`public string`	# `getSelfRel( )` The fall back rel definition if Rel::SELF and the location header are undefined. The fall back rel definition if Rel::SELF and the location header are undefined. Returns string Overrides `Gedcomx\Rs\Client\GedcomxApplicationState::getSelfRel`
`public Gedcomx\Conclusion\Person`	# `getPerson( )` Get the Person object off the GedcomX entity Get the Person object off the GedcomX entity Returns `Gedcomx\Conclusion\Person`
`public Gedcomx\Conclusion\Relationship[]\|null`	# `getRelationships( )` Get the relationships associated with this person Get the relationships associated with this person Returns `Gedcomx\Conclusion\Relationship[]`\|null
`public array\|Gedcomx\Conclusion\Relationship[]\|null`	# `getSpouseRelationships( )` Get the spouse relationship(s), if any, for this person. Get the spouse relationship(s), if any, for this person. Returns array\|`Gedcomx\Conclusion\Relationship[]`\|null
`public array\|Gedcomx\Conclusion\Relationship[]\|null`	# `getChildRelationships( )` Get the children, if any, of this person. Get the children, if any, of this person. Returns array\|`Gedcomx\Conclusion\Relationship[]`\|null
`public Gedcomx\Conclusion\Relationship[]\|null`	# `getParentRelationships( )` Get parents, if known, of this person. Get parents, if known, of this person. Returns `Gedcomx\Conclusion\Relationship[]`\|null
`public Gedcomx\Conclusion\DisplayProperties\|null`	# `getDisplayProperties( )` Get the display extension values for this person Get the display extension values for this person Returns `Gedcomx\Conclusion\DisplayProperties`\|null
`public Gedcomx\Conclusion\Conclusion\|null`	# `getConclusion( )` Return a conclusion about this person Return a conclusion about this person Returns `Gedcomx\Conclusion\Conclusion`\|null
`public Gedcomx\Conclusion\Name\|null`	# `getName( )` Get the name of this person Get the name of this person Returns `Gedcomx\Conclusion\Name`\|null
`public Gedcomx\Conclusion\Gender\|null`	# `getGender( )` Get the gender of this person Get the gender of this person Returns `Gedcomx\Conclusion\Gender`\|null
`public Gedcomx\Conclusion\Fact\|null`	# `getFact( )` Get a fact about this person Get a fact about this person Returns `Gedcomx\Conclusion\Fact`\|null
`public Gedcomx\Common\Note\|null`	# `getNote( )` Get a note about this person Get a note about this person Returns `Gedcomx\Common\Note`\|null
`public Gedcomx\Source\SourceReference\|null`	# `getSourceReference( )` Get a source reference about this person Get a source reference about this person Returns `Gedcomx\Source\SourceReference`\|null
`public Gedcomx\Common\EvidenceReference\|null`	# `getEvidenceReference( )` Get an evidence reference about this person Get an evidence reference about this person Returns `Gedcomx\Common\EvidenceReference`\|null
`public Gedcomx\Common\EvidenceReference\|null`	# `getPersonaReference( )` Get a persona reference about this person Get a persona reference about this person Returns `Gedcomx\Common\EvidenceReference`\|null
`public Gedcomx\Source\SourceReference\|null`	# `getMediaReference( )` Get a media reference about this person Get a media reference about this person Returns `Gedcomx\Source\SourceReference`\|null
`public Gedcomx\Rs\Client\CollectionState\|null`	# `readCollection( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Create a new collection state. Create a new collection state. Parameters `$option` Returns `Gedcomx\Rs\Client\CollectionState`\|null
`public Gedcomx\Rs\Client\AncestryResultsState\|null`	# `readAncestry( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the ancestry of this person. Read the ancestry of this person. Parameters `$option` Returns `Gedcomx\Rs\Client\AncestryResultsState`\|null
`public Gedcomx\Rs\Client\DescendancyResultsState\|null`	# `readDescendancy( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Reads the descendancy of the current person. Reads the descendancy of the current person. Parameters `$option` Returns `Gedcomx\Rs\Client\DescendancyResultsState`\|null
`public Gedcomx\Rs\Client\PersonState`	# `addPersonaPersonState( Gedcomx\Rs\Client\PersonState $persona, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a persona reference to the current person. Adds a persona reference to the current person. Parameters `$persona` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addPersonaReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a persona reference to the current person. Adds a persona reference to the current person. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addPersonaReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds the persona references to the current person. Adds the persona references to the current person. Parameters `$refs` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updatePersonaReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the persona reference for the current person. Updates the persona reference for the current person. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public mixed`	# `updatePersonaReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the persona references for the current person. Updates the persona references for the current person. Parameters `$refs` `$option` Returns mixed
`public mixed`	# `deletePersonaReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Deletes the specified persona reference for the current person. Deletes the specified persona reference for the current person. Parameters `$reference` `$option` Returns mixed
`public Gedcomx\Rs\Client\PersonState`	# `loadConclusions( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load any Conclusions associated with this person. Load any Conclusions associated with this person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState` $this
`public Gedcomx\Rs\Client\PersonState`	# `loadSourceReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load any SourceReferences associated with this person. Load any SourceReferences associated with this person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState` $this
`public Gedcomx\Rs\Client\PersonState`	# `loadMediaReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load any MediaReferences associated with this person. Load any MediaReferences associated with this person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState` $this
`public Gedcomx\Rs\Client\PersonState`	# `loadEvidenceReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load any Evidence References associated with this person. Load any Evidence References associated with this person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState` $this
`public Gedcomx\Rs\Client\PersonState`	# `loadNotes( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load any Notes associated with this person. Load any Notes associated with this person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState` $this
`public Gedcomx\Rs\Client\PersonState`	# `loadPersonaReferences( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Loads persona references for the current person. Loads persona references for the current person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `readNote( Gedcomx\Common\Note $note, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read a specific note associated with this person. Read a specific note associated with this person. Parameters `$note` `$option` Returns `Gedcomx\Rs\Client\PersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState`	# `loadParentRelationships( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load any parent relationships associated with this person. Load any parent relationships associated with this person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState` $this
`public Gedcomx\Rs\Client\PersonState`	# `loadSpouseRelationships( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load any spouse relationships associated with this person. Load any spouse relationships associated with this person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState` $this
`public Gedcomx\Rs\Client\PersonState`	# `loadChildRelationships( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load any child relationships associated with this person. Load any child relationships associated with this person. Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState` $this
`public Gedcomx\Rs\Client\PersonState`	# `update( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a person Update a person Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addGender( Gedcomx\Conclusion\Gender $gender, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a gender conclusion to this person. Add a gender conclusion to this person. Parameters `$gender` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateGender( Gedcomx\Conclusion\Gender $gender, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the gender conclusion on this person. Update the gender conclusion on this person. Parameters `$gender` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `deleteGender( Gedcomx\Conclusion\Gender $gender, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Remove the gender conclusion on this person. Remove the gender conclusion on this person. Parameters `$gender` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addName( Gedcomx\Conclusion\Name $name, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a name to this person. Add a name to this person. Parameters `$name` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addNames( array $names, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add multiple names to this person. Add multiple names to this person. Parameters `$names` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateName( Gedcomx\Conclusion\Name $name, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a name on this person. Update a name on this person. Parameters `$name` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateNames( array $names, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update multiple names on this person. Update multiple names on this person. Parameters `$names` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `deleteName( Gedcomx\Conclusion\Name $name, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Remove a name from this person. Remove a name from this person. Parameters `$name` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a fact to this person. Add a fact to this person. Parameters `$fact` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addFacts( array $facts, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add multiple facts to this person. Add multiple facts to this person. Parameters `$facts` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a fact on this person. Update a fact on this person. Parameters `$fact` `$option` or an array of StateTransitionOption objects Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateFacts( array $facts, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update multiple facts on this person. Update multiple facts on this person. Parameters `$facts` `$option` or an array of StateTransitionOption objects Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `deleteFact( Gedcomx\Conclusion\Fact $fact, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Remove a fact from this person. Remove a fact from this person. Parameters `$fact` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateConclusions( Gedcomx\Gedcomx\|Gedcomx\Conclusion\Person $obj, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update this person with the current conclusion objects. Update this person with the current conclusion objects. Parameters `$obj` `$option` Returns `Gedcomx\Rs\Client\PersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState\|null`	# `addSourceReferenceRecord( Gedcomx\Rs\Client\RecordState $record, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a source reference to this person based on a RecordState. Add a source reference to this person based on a RecordState. Parameters `$record` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState\|null`	# `addSourceReferenceObj( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a source reference to this person based on a SourceReference. Add a source reference to this person based on a SourceReference. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState\|null`	# `addSourceReferenceState( Gedcomx\Rs\Client\SourceDescriptionState $stateObj, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a source reference to this person based on a SourceDescription. Add a source reference to this person based on a SourceDescription. Parameters `$stateObj` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState\|null`	# `addSourceReferences( array $refs, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add multiple source references to this person. Add multiple source references to this person. Parameters `$refs` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState`	# `updateSourceReference( Gedcomx\Source\SourceReference $sourceReference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a source reference on this person. Update a source reference on this person. Parameters `$sourceReference` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateSourceReferences( Gedcomx\Conclusion\Person\|Gedcomx\Source\SourceReference[] $source, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update multiple source references on this person. Update multiple source references on this person. Parameters `$source` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `deleteSourceReference( Gedcomx\Source\SourceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Remove a source reference from this person. Remove a source reference from this person. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\PersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState`	# `addMediaDescription( Gedcomx\Rs\Client\SourceDescriptionState $description, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a media reference to the current person. Adds a media reference to the current person. Parameters `$description` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addMediaReference( Gedcomx\Source\SourceReference $mediaReference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds a media reference to the current person. Adds a media reference to the current person. Parameters `$mediaReference` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addMediaReferences( array $mediaReferences, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds media references to the current person. Adds media references to the current person. Parameters `$mediaReferences` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateMediaReference( Gedcomx\Source\SourceReference $mediaReference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the media reference for the current person. Updates the media reference for the current person. Parameters `$mediaReference` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateMediaReferences( array $mediaReferences, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the media references for the current person. Updates the media references for the current person. Parameters `$mediaReferences` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `deleteMediaReference( Gedcomx\Source\SourceReference $mediaReference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Deletes the specified media reference from the current person. Deletes the specified media reference from the current person. Parameters `$mediaReference` `$option` Returns `Gedcomx\Rs\Client\PersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState`	# `addPersonEvidence( Gedcomx\Rs\Client\PersonState $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds an evidence reference to the current person. Adds an evidence reference to the current person. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addEvidenceReference( Gedcomx\Common\EvidenceReference $evidenceReference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds an evidence reference to the current person. Adds an evidence reference to the current person. Parameters `$evidenceReference` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addEvidenceReferences( array $evidenceReferences, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds the evidence references to the current person. Adds the evidence references to the current person. Parameters `$evidenceReferences` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateEvidenceReference( Gedcomx\Common\EvidenceReference $evidenceReference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update the evidence reference for the current person. Update the evidence reference for the current person. Parameters `$evidenceReference` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateEvidenceReferences( array $evidenceReferences, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Updates the evidence references for the current person. Updates the evidence references for the current person. Parameters `$evidenceReferences` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `deleteEvidenceReference( Gedcomx\Common\EvidenceReference $reference, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Deletes the evidence reference from the current person. Deletes the evidence reference from the current person. Parameters `$reference` `$option` Returns `Gedcomx\Rs\Client\PersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState`	# `addNote( Gedcomx\Common\Note $note, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a note to this person. Add a note to this person. Parameters `$note` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `addNotes( array $notes, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add multiple notes to this person. Add multiple notes to this person. Parameters `$notes` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateNote( Gedcomx\Common\Note $note, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update a note on this person. Update a note on this person. Parameters `$note` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updateNotes( array $notes, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update multiple notes on this person. Update multiple notes on this person. Parameters `$notes` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `updatePersonNotes( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Update notes added to a person. Update notes added to a person. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState`
`public Gedcomx\Rs\Client\PersonState`	# `deleteNote( Gedcomx\Common\Note $note, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Remove a note from a person. Remove a note from a person. Parameters `$note` `$option` Returns `Gedcomx\Rs\Client\PersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\RelationshipState\|null`	# `readRelationship( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Get a RelationshipState associated with the relationship object. Get a RelationshipState associated with the relationship object. Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\RelationshipState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readRelative( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the relative given by a specific relationship definition Read the relative given by a specific relationship definition Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonParentsState`	# `readParents( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the PersonParentsState for this person. (A Family Search extension.) Read the PersonParentsState for this person. (A Family Search extension.) Parameters `$option` Returns `Gedcomx\Rs\Client\PersonParentsState`
`public Gedcomx\Rs\Client\PersonChildrenState`	# `readChildren( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the PersonChildrenState for this person. (A Family Search extension.) Read the PersonChildrenState for this person. (A Family Search extension.) Parameters `$option` Returns `Gedcomx\Rs\Client\PersonChildrenState`
`public Gedcomx\Rs\Client\PersonState\|null`	# `readFirstChild( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the first child associated with this person Read the first child associated with this person Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readChildByIndex( integer $index, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the child at a given position Read the child at a given position Parameters `$index` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readChild( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the child defined by this relationship Read the child defined by this relationship Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState`	# `addChild( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a child to this person Add a child to this person Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonState\|null`	# `readFirstParent( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the first parent associated with this person Read the first parent associated with this person Parameters `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readParentByIndex( integer $index, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the parent at a given position Read the parent at a given position Parameters `$index` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState\|null`	# `readParent( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the parent defined by this relationship Read the parent defined by this relationship Parameters `$relationship` `$option` Returns `Gedcomx\Rs\Client\PersonState`\|null
`public Gedcomx\Rs\Client\PersonState`	# `addParent( Gedcomx\Conclusion\Person $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Adds the specified person as a parent to the current person. Adds the specified person as a parent to the current person. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\PersonState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\PersonSpousesState\|null`	# `readFirstSpouse( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the first spouse record for this person Read the first spouse record for this person Parameters `$option` Returns `Gedcomx\Rs\Client\PersonSpousesState`\|null
`public Gedcomx\Rs\Client\PersonSpousesState\|null`	# `readSpouseFromIndex( integer $index, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the PersonSpousesState for this person based on the index in the relationship array. (A Family Search extension.) Read the PersonSpousesState for this person based on the index in the relationship array. (A Family Search extension.) Parameters `$index` `$option` Returns `Gedcomx\Rs\Client\PersonSpousesState`\|null
`public mixed`	# `readSpouse( Gedcomx\Conclusion\Relationship $relationship, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the spouse based on a Relationship object Read the spouse based on a Relationship object Parameters `$relationship` `$option` Returns mixed
`public Gedcomx\Rs\Client\PersonSpousesState`	# `readSpouses( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the spouses for this person Read the spouses for this person Parameters `$option` Returns `Gedcomx\Rs\Client\PersonSpousesState`
`public Gedcomx\Rs\Client\RelationshipState`	# `addSpouse( Gedcomx\Rs\Client\PersonState $person, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add a PersonState to this person as a spouse. Add a PersonState to this person as a spouse. Parameters `$person` `$option` Returns `Gedcomx\Rs\Client\RelationshipState` Throws `Gedcomx\Rs\Client\Exception\GedcomxApplicationException`
`public Gedcomx\Rs\Client\SourceDescriptionState\|null`	# `readArtifacts( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read any artifacts associated with this person Read any artifacts associated with this person Parameters `$option` Returns `Gedcomx\Rs\Client\SourceDescriptionState`\|null
`public Gedcomx\Rs\Client\SourceDescriptionState\|null`	# `readSources( Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Read the list of sources associated with this person Read the list of sources associated with this person Parameters `$option` Returns `Gedcomx\Rs\Client\SourceDescriptionState`\|null
`public Gedcomx\Rs\Client\SourceDescriptionState\|null`	# `addArtifact( Gedcomx\Rs\Client\Util\DataSource $data, Gedcomx\Source\SourceDescription $description = null, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Add an artifact to this person Add an artifact to this person Parameters `$data` `$description` `$option` Returns `Gedcomx\Rs\Client\SourceDescriptionState`\|null
`public Gedcomx\Rs\Client\PersonState`	# `loadEmbeddedResources( array $rels, Gedcomx\Rs\Client\Options\StateTransitionOption $option = null )` Load a list of embedded resources for this person. Load a list of embedded resources for this person. Parameters `$rels` `$option` Returns `Gedcomx\Rs\Client\PersonState`

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

Namespaces

Classes

Interfaces

Class PersonState

Direct known subclasses

Methods summary

Parameters

Overrides

Returns

Overrides

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

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

Parameters

Returns

Parameters

Returns