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

  • CitationField
  • Coverage
  • SourceCitation
  • SourceDescription
  • SourceReference

Interfaces

  • ReferencesSources

Class SourceCitation

Represents a source citation.

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a SourceCitation from a (parsed) JSON hash

Constructs a SourceCitation 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 Gedcomx\Common\ResourceReference
# getCitationTemplate( )

A reference to the citation template for this citation.

A reference to the citation template for this citation.

Returns

Gedcomx\Common\ResourceReference
public
# setCitationTemplate( Gedcomx\Common\ResourceReference $citationTemplate )

A reference to the citation template for this citation.

A reference to the citation template for this citation.

Parameters

$citationTemplate
public Gedcomx\Source\CitationField[]
# getFields( )

The list of citation fields.

The list of citation fields.

Returns

Gedcomx\Source\CitationField[]
public
# setFields( Gedcomx\Source\CitationField[] $fields )

The list of citation fields.

The list of citation fields.

Parameters

$fields
public string
# getValue( )

A rendering (as a string) of a source citation. This rendering should be the most complete rendering available.

A rendering (as a string) of a source citation. This rendering should be the most complete rendering available.

Returns

string
public
# setValue( string $value )

A rendering (as a string) of a source citation. This rendering should be the most complete rendering available.

A rendering (as a string) of a source citation. This rendering should be the most complete rendering available.

Parameters

$value
public array
# toArray( )

Returns the associative array for this SourceCitation

Returns the associative array for this SourceCitation

Returns

array

Overrides

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

Initializes this SourceCitation from an associative array

Initializes this SourceCitation from an associative array

Parameters

$o

Overrides

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

Parameters

$visitor
public
# writeXmlContents( XMLWriter $writer )

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

Writes the contents of this SourceCitation 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-client API documentation generated by ApiGen