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 Coverage

A description of the coverage of a resource.

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a Coverage from a (parsed) JSON hash

Constructs a Coverage from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

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

The type of record being covered.

The type of record being covered.

Returns

string
public
# setRecordType( string $recordType )

The type of record being covered.

The type of record being covered.

Parameters

$recordType
public Gedcomx\Conclusion\PlaceReference
# getSpatial( )

Spatial coverage.

Spatial coverage.

Returns

Gedcomx\Conclusion\PlaceReference
public
# setSpatial( Gedcomx\Conclusion\PlaceReference $spatial )

Spatial coverage.

Spatial coverage.

Parameters

$spatial
public Gedcomx\Conclusion\DateInfo
# getTemporal( )

Temporal coverage.

Temporal coverage.

Returns

Gedcomx\Conclusion\DateInfo
public
# setTemporal( Gedcomx\Conclusion\DateInfo $temporal )

Temporal coverage.

Temporal coverage.

Parameters

$temporal
public array
# toArray( )

Returns the associative array for this Coverage

Returns the associative array for this Coverage

Returns

array

Overrides

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

Initializes this Coverage from an associative array

Initializes this Coverage from an associative array

Parameters

$o

Overrides

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

Writes this Coverage to an XML writer.

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

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