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 SourceDescription

Represents a description of a source.

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a SourceDescription from a (parsed) JSON hash

Constructs a SourceDescription from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

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

The URI (if applicable) of the actual source.

The URI (if applicable) of the actual source.

Returns

string
public
# setAbout( string $about )

The URI (if applicable) of the actual source.

The URI (if applicable) of the actual source.

Parameters

$about
public string
# getMediaType( )

Hint about the media (MIME) type of the resource being described.

Hint about the media (MIME) type of the resource being described.

Returns

string
public
# setMediaType( string $mediaType )

Hint about the media (MIME) type of the resource being described.

Hint about the media (MIME) type of the resource being described.

Parameters

$mediaType
public string
# getResourceType( )

The type of the resource being described.

The type of the resource being described.

Returns

string
public
# setResourceType( string $resourceType )

The type of the resource being described.

The type of the resource being described.

Parameters

$resourceType
public Gedcomx\Source\SourceCitation[]
# getCitations( )

The bibliographic citations for this source.

The bibliographic citations for this source.

Returns

Gedcomx\Source\SourceCitation[]
public
# setCitations( Gedcomx\Source\SourceCitation[] $citations )

The bibliographic citations for this source.

The bibliographic citations for this source.

Parameters

$citations
public Gedcomx\Common\ResourceReference
# getMediator( )

A reference to the entity that mediates access to the described source.

A reference to the entity that mediates access to the described source.

Returns

Gedcomx\Common\ResourceReference
public
# setMediator( Gedcomx\Common\ResourceReference $mediator )

A reference to the entity that mediates access to the described source.

A reference to the entity that mediates access to the described source.

Parameters

$mediator
public Gedcomx\Source\SourceReference[]
# getSources( )

References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).

References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).

Returns

Gedcomx\Source\SourceReference[]
public
# setSources( Gedcomx\Source\SourceReference[] $sources )

References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).

References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).

Parameters

$sources
public Gedcomx\Common\ResourceReference
# getAnalysis( )

A reference to the analysis document explaining the analysis that went into this description of the source.

A reference to the analysis document explaining the analysis that went into this description of the source.

Returns

Gedcomx\Common\ResourceReference
public
# setAnalysis( Gedcomx\Common\ResourceReference $analysis )

A reference to the analysis document explaining the analysis that went into this description of the source.

A reference to the analysis document explaining the analysis that went into this description of the source.

Parameters

$analysis
public Gedcomx\Source\SourceReference
# getComponentOf( )

A reference to the source that contains this source.

A reference to the source that contains this source.

Returns

Gedcomx\Source\SourceReference
public
# setComponentOf( Gedcomx\Source\SourceReference $componentOf )

A reference to the source that contains this source.

A reference to the source that contains this source.

Parameters

$componentOf
public Gedcomx\Common\TextValue[]
# getTitles( )

A list of titles for this source.

A list of titles for this source.

Returns

Gedcomx\Common\TextValue[]
public
# setTitles( Gedcomx\Common\TextValue[] $titles )

A list of titles for this source.

A list of titles for this source.

Parameters

$titles
public Gedcomx\Common\TextValue
# getTitleLabel( )

A label for the title of this description.

A label for the title of this description.

Returns

Gedcomx\Common\TextValue
public
# setTitleLabel( Gedcomx\Common\TextValue $titleLabel )

A label for the title of this description.

A label for the title of this description.

Parameters

$titleLabel
public Gedcomx\Common\Note[]
# getNotes( )

Notes about a source.

Notes about a source.

Returns

Gedcomx\Common\Note[]
public
# setNotes( Gedcomx\Common\Note[] $notes )

Notes about a source.

Notes about a source.

Parameters

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

The attribution metadata for this source description.

The attribution metadata for this source description.

Returns

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

The attribution metadata for this source description.

The attribution metadata for this source description.

Parameters

$attribution
public string
# getSortKey( )

A sort key to be used in determining the position of this source relative to other sources in the same collection.

A sort key to be used in determining the position of this source relative to other sources in the same collection.

Returns

string
public
# setSortKey( string $sortKey )

A sort key to be used in determining the position of this source relative to other sources in the same collection.

A sort key to be used in determining the position of this source relative to other sources in the same collection.

Parameters

$sortKey
public Gedcomx\Common\TextValue[]
# getDescriptions( )

Human-readable descriptions of the source.

Human-readable descriptions of the source.

Returns

Gedcomx\Common\TextValue[]
public
# setDescriptions( Gedcomx\Common\TextValue[] $description )

Human-readable descriptions of the source.

Human-readable descriptions of the source.

Parameters

$description
public Gedcomx\Conclusion\Identifier[]
# getIdentifiers( )

The list of identifiers for the source.

The list of identifiers for the source.

Returns

Gedcomx\Conclusion\Identifier[]
public
# setIdentifiers( Gedcomx\Conclusion\Identifier[] $identifiers )

The list of identifiers for the source.

The list of identifiers for the source.

Parameters

$identifiers
public integer
# getCreated( )

The date the source was created.

The date the source was created.

Returns

integer
public
# setCreated( integer $created )

The date the source was created.

The date the source was created.

Parameters

$created
public integer
# getModified( )

The date the source was last modified.

The date the source was last modified.

Returns

integer
public
# setModified( integer $modified )

The date the source was last modified.

The date the source was last modified.

Parameters

$modified
public Gedcomx\Source\Coverage[]
# getCoverage( )

Declarations of the coverage of the source.

Declarations of the coverage of the source.

Returns

Gedcomx\Source\Coverage[]
public
# setCoverage( Gedcomx\Source\Coverage[] $coverage )

Declarations of the coverage of the source.

Declarations of the coverage of the source.

Parameters

$coverage
public string[]
# getRights( )

The rights for this source.

The rights for this source.

Returns

string[]
public
# setRights( string[] $rights )

The rights for this source.

The rights for this source.

Parameters

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

The fields that are applicable to the resource being described.

The fields that are applicable to the resource being described.

Returns

Gedcomx\Records\Field[]
public
# setFields( Gedcomx\Records\Field[] $fields )

The fields that are applicable to the resource being described.

The fields that are applicable to the resource being described.

Parameters

$fields
public Gedcomx\Common\ResourceReference
# getRepository( )

Reference to an agent describing the repository in which the source is found.

Reference to an agent describing the repository in which the source is found.

Returns

Gedcomx\Common\ResourceReference
public
# setRepository( Gedcomx\Common\ResourceReference $repository )

Reference to an agent describing the repository in which the source is found.

Reference to an agent describing the repository in which the source is found.

Parameters

$repository
public Gedcomx\Common\ResourceReference
# getDescriptorRef( )

Reference to a descriptor of fields and type of data that can be expected to be extracted from the source.

Reference to a descriptor of fields and type of data that can be expected to be extracted from the source.

Returns

Gedcomx\Common\ResourceReference
public
# setDescriptorRef( Gedcomx\Common\ResourceReference $descriptorRef )

Reference to a descriptor of fields and type of data that can be expected to be extracted from the source.

Reference to a descriptor of fields and type of data that can be expected to be extracted from the source.

Parameters

$descriptorRef
public array
# toArray( )

Returns the associative array for this SourceDescription

Returns the associative array for this SourceDescription

Returns

array

Overrides

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

Initializes this SourceDescription from an associative array

Initializes this SourceDescription 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 SourceDescription to an XML writer.

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

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