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

  • Conclusion
  • DateInfo
  • DisplayProperties
  • Document
  • Event
  • EventRole
  • Fact
  • Gender
  • Identifier
  • Name
  • NameForm
  • NamePart
  • Person
  • PlaceDescription
  • PlaceDisplayProperties
  • PlaceReference
  • Relationship
  • Subject

Interfaces

  • HasFacts

Class Relationship

A relationship between two or more persons.

Gedcomx\Common\ExtensibleData
Extended by Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks
Extended by Gedcomx\Conclusion\Conclusion implements Gedcomx\Common\Attributable, Gedcomx\Source\ReferencesSources, Gedcomx\Common\HasNotes
Extended by Gedcomx\Conclusion\Subject implements Gedcomx\Common\Attributable
Extended by Gedcomx\Conclusion\Relationship implements Gedcomx\Conclusion\HasFacts, Gedcomx\Common\HasNotes, Gedcomx\Records\HasFields
Namespace: Gedcomx\Conclusion
Located at Conclusion/Relationship.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a Relationship from a (parsed) JSON hash

Constructs a Relationship from a (parsed) JSON hash

Parameters

$o
Either an array (JSON) or an XMLReader.

Throws

Exception

Overrides

Gedcomx\Conclusion\Subject::__construct
public string
# getType( )

The type of this relationship.

The type of this relationship.

Returns

string
public Gedcomx\Types\RelationshipType|null
# getKnownType( )

Returns

Gedcomx\Types\RelationshipType|null
public
# setType( string $type )

The type of this relationship.

The type of this relationship.

Parameters

$type
public
# setKnownType( string $type )

The type of this relationship.

The type of this relationship.

Parameters

$type
public Gedcomx\Common\ResourceReference
# getPerson1( )

A reference to a person in the relationship. The name "person1" is used only to distinguish it from the other person in this relationship and implies neither order nor role. When the relationship type implies direction, it goes from "person1" to "person2".

A reference to a person in the relationship. The name "person1" is used only to distinguish it from the other person in this relationship and implies neither order nor role. When the relationship type implies direction, it goes from "person1" to "person2".

Returns

Gedcomx\Common\ResourceReference
public
# setPerson1( Gedcomx\Common\ResourceReference $person1 )

A reference to a person in the relationship. The name "person1" is used only to distinguish it from the other person in this relationship and implies neither order nor role. When the relationship type implies direction, it goes from "person1" to "person2".

A reference to a person in the relationship. The name "person1" is used only to distinguish it from the other person in this relationship and implies neither order nor role. When the relationship type implies direction, it goes from "person1" to "person2".

Parameters

$person1
public Gedcomx\Common\ResourceReference
# getPerson2( )

A reference to a person in the relationship. The name "person2" is used only to distinguish it from the other person in this relationship and implies neither order nor role. When the relationship type implies direction, it goes from "person1" to "person2".

A reference to a person in the relationship. The name "person2" is used only to distinguish it from the other person in this relationship and implies neither order nor role. When the relationship type implies direction, it goes from "person1" to "person2".

Returns

Gedcomx\Common\ResourceReference
public
# setPerson2( Gedcomx\Common\ResourceReference $person2 )

A reference to a person in the relationship. The name "person2" is used only to distinguish it from the other person in this relationship and implies neither order nor role. When the relationship type implies direction, it goes from "person1" to "person2".

A reference to a person in the relationship. The name "person2" is used only to distinguish it from the other person in this relationship and implies neither order nor role. When the relationship type implies direction, it goes from "person1" to "person2".

Parameters

$person2
public
# addFact( Gedcomx\Conclusion\Fact $fact )

Parameters

$fact
public Gedcomx\Conclusion\Fact[]|Gedcomx\Conclusion\Fact|null
# getFactsOfType( string $type )

Return a fact of a specific type.

Return a fact of a specific type.

Parameters

$type
FactType

Returns

Gedcomx\Conclusion\Fact[]|Gedcomx\Conclusion\Fact|null
public Gedcomx\Conclusion\Fact[]
# getFacts( )

The fact conclusions for the relationship.

The fact conclusions for the relationship.

Returns

Gedcomx\Conclusion\Fact[]

Implementation of

Gedcomx\Conclusion\HasFacts::getFacts()
public
# setFacts( array $facts )

The fact conclusions for the relationship.

The fact conclusions for the relationship.

Parameters

$facts

Implementation of

Gedcomx\Conclusion\HasFacts::setFacts()
public
# addField( Gedcomx\Records\Field $field )

Parameters

$field
public Gedcomx\Records\Field[]
# getFields( )

The references to the record fields being used as evidence.

The references to the record fields being used as evidence.

Returns

Gedcomx\Records\Field[]

Implementation of

Gedcomx\Records\HasFields::getFields()
public
# setFields( array $fields )

The references to the record fields being used as evidence.

The references to the record fields being used as evidence.

Parameters

$fields

Implementation of

Gedcomx\Records\HasFields::setFields()
public array
# toArray( )

Returns the associative array for this Relationship

Returns the associative array for this Relationship

Returns

array

Overrides

Gedcomx\Conclusion\Subject::toArray
public
# initFromArray( array $o )

Initializes this Relationship from an associative array

Initializes this Relationship from an associative array

Parameters

$o

Overrides

Gedcomx\Conclusion\Subject::initFromArray
public
# accept( Gedcomx\Rt\GedcomxModelVisitor $visitor )

Parameters

$visitor
public
# toXml( XMLWriter $writer, boolean $includeNamespaces = true )

Writes this Relationship to an XML writer.

Writes this Relationship to an XML writer.

Parameters

$writer
The XML writer.
$includeNamespaces
Whether to write out the namespaces in the element.
public
# writeXmlContents( XMLWriter $writer )

Writes the contents of this Relationship to an XML writer. The startElement is expected to be already provided.

Writes the contents of this Relationship to an XML writer. The startElement is expected to be already provided.

Parameters

$writer
The XML writer.

Overrides

Gedcomx\Conclusion\Subject::writeXmlContents

Methods inherited from Gedcomx\Conclusion\Subject

getEvidence(), getExtracted(), getIdentifiers(), getMedia(), setEvidence(), setExtracted(), setIdentifiers(), setMedia()

Methods inherited from Gedcomx\Conclusion\Conclusion

getAnalysis(), getAttribution(), getConfidence(), getLang(), getNotes(), getSources(), setAnalysis(), setAttribution(), setConfidence(), setLang(), setNotes(), setSources()

Methods inherited from Gedcomx\Links\HypermediaEnabledData

addLink(), addLinkRelation(), addTemplatedLink(), getLink(), getLinks(), getLinksByRel(), setLinks()

Methods inherited from Gedcomx\Common\ExtensibleData

addExtensionElement(), findExtensionOfType(), findExtensionsOfType(), getExtensionElements(), getId(), initFromReader(), removeExtensionElements(), setExtensionElement(), setExtensionElements(), setId(), toJson()

gedcomx-php-client API documentation generated by ApiGen