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

  • CitationField
  • Coverage
  • SourceCitation
  • SourceDescription
  • SourceReference

Interfaces

  • ReferencesSources

Class SourceReference

An attributable reference to a description of a source.

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a SourceReference from a (parsed) JSON hash

Constructs a SourceReference from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

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

A reference to a description of the source being referenced.

A reference to a description of the source being referenced.

Returns

string
public
# setDescriptionRef( string $descriptionRef )

A reference to a description of the source being referenced.

A reference to a description of the source being referenced.

Parameters

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

The attribution metadata for this source reference.

The attribution metadata for this source reference.

Returns

Gedcomx\Common\Attribution

Implementation of

Gedcomx\Common\Attributable::getAttribution()
public
# setAttribution( Gedcomx\Common\Attribution $attribution )

The attribution metadata for this source reference.

The attribution metadata for this source reference.

Parameters

$attribution

Implementation of

Gedcomx\Common\Attributable::setAttribution()
public Gedcomx\Common\Qualifier[]
# getQualifiers( )

The qualifiers associated with this source reference.

The qualifiers associated with this source reference.

Returns

Gedcomx\Common\Qualifier[]
public
# setQualifiers( Gedcomx\Common\Qualifier[] $qualifiers )

The qualifiers associated with this source reference.

The qualifiers associated with this source reference.

Parameters

$qualifiers
public array
# toArray( )

Returns the associative array for this SourceReference

Returns the associative array for this SourceReference

Returns

array

Overrides

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

Initializes this SourceReference from an associative array

Initializes this SourceReference from an associative array

Parameters

$o

Overrides

Gedcomx\Links\HypermediaEnabledData::initFromArray
public
# accept( Gedcomx\Rt\GedcomxModelVisitor $visitor )
public
# toXml( XMLWriter $writer, boolean $includeNamespaces = true )

Writes this SourceReference to an XML writer.

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

Writes the contents of this SourceReference 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