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 Name

A name conclusion.

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\Name
Namespace: Gedcomx\Conclusion
Located at Conclusion/Name.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a Name from a (parsed) JSON hash

Constructs a Name from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

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

The type of the name.

The type of the name.

Returns

string
public
# setType( string $type )

The type of the name.

The type of the name.

Parameters

$type
public boolean
# getPreferred( )

Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes.

Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes.

Returns

boolean
public
# setPreferred( boolean $preferred )

Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes.

Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes.

Parameters

$preferred
public Gedcomx\Conclusion\DateInfo
# getDate( )

The date the name was first applied or adopted.

The date the name was first applied or adopted.

Returns

Gedcomx\Conclusion\DateInfo
public
# setDate( Gedcomx\Conclusion\DateInfo $date )

The date the name was first applied or adopted.

The date the name was first applied or adopted.

Parameters

$date
public Gedcomx\Conclusion\NameForm[]
# getNameForms( )

Alternate forms of the name, such as the romanized form of a non-latin name.

Alternate forms of the name, such as the romanized form of a non-latin name.

Returns

Gedcomx\Conclusion\NameForm[]
public
# setNameForms( array $nameForms )

Alternate forms of the name, such as the romanized form of a non-latin name.

Alternate forms of the name, such as the romanized form of a non-latin name.

Parameters

$nameForms
public array
# toArray( )

Returns the associative array for this Name

Returns the associative array for this Name

Returns

array

Overrides

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

Initializes this Name from an associative array

Initializes this Name from an associative array

Parameters

$o

Overrides

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

Parameters

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

Writes this Name to an XML writer.

Writes this Name 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 Name to an XML writer. The startElement is expected to be already provided.

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

Parameters

$writer
The XML writer.

Overrides

Gedcomx\Conclusion\Conclusion::writeXmlContents
public string
# toString( )

String value of Name

String value of Name

Returns

string

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