gedcomx-php
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • Attribution
  • CustomEntity
  • CustomKeyedItem
  • EvidenceReference
  • ExtensibleData
  • Note
  • Qualifier
  • ResourceReference
  • TextValue
  • UniqueCustomKeyedItem

Interfaces

  • Attributable
  • HasNotes

Class Note

A note about a genealogical resource (e.g. conclusion or source).

Gedcomx\Common\ExtensibleData
Extended by Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks
Extended by Gedcomx\Common\Note
Namespace: Gedcomx\Common
Located at Common/Note.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a Note from a (parsed) JSON hash

Constructs a Note from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

Gedcomx\Links\HypermediaEnabledData::__construct
public string
# getLang( )

The language of the note.

The language of the note.

Returns

string
public
# setLang( string $lang )

The language of the note.

The language of the note.

Parameters

$lang
public string
# getSubject( )

The subject of the note.

The subject of the note.

Returns

string
public
# setSubject( string $subject )

The subject of the note.

The subject of the note.

Parameters

$subject
public string
# getText( )

The text of the note.

The text of the note.

Returns

string
public
# setText( string $text )

The text of the note.

The text of the note.

Parameters

$text
public Gedcomx\Common\Attribution
# getAttribution( )

Attribution metadata for a note.

Attribution metadata for a note.

Returns

Gedcomx\Common\Attribution
public
# setAttribution( Gedcomx\Common\Attribution $attribution )

Attribution metadata for a note.

Attribution metadata for a note.

Parameters

$attribution
public array
# toArray( )

Returns the associative array for this Note

Returns the associative array for this Note

Returns

array

Overrides

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

Initializes this Note from an associative array

Initializes this Note from an associative array

Parameters

$o

Overrides

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

Parameters

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

Writes this Note to an XML writer.

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

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

Parameters

$writer
The XML writer.

Overrides

Gedcomx\Links\HypermediaEnabledData::writeXmlContents

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 API documentation generated by ApiGen