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

  • Conclusion
  • DateInfo
  • DisplayProperties
  • Document
  • Event
  • EventRole
  • Fact
  • Gender
  • Identifier
  • Name
  • NameForm
  • NamePart
  • Person
  • PlaceDescription
  • PlaceDisplayProperties
  • PlaceReference
  • Relationship
  • Subject

Interfaces

  • HasFacts

Class PlaceDescription

A PlaceDescription is used to describe the details of a place in terms of its name and possibly its type, time period, and/or a geospatial description -- a description of a place as a snapshot in time.

Gedcomx\Common\ExtensibleData
Extended by Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks
Extended by Gedcomx\Conclusion\Conclusion implements Gedcomx\Common\Attributable, Gedcomx\Source\ReferencesSources, Gedcomx\Common\HasNotes
Extended by Gedcomx\Conclusion\Subject implements Gedcomx\Common\Attributable
Extended by Gedcomx\Conclusion\PlaceDescription
Namespace: Gedcomx\Conclusion
Located at Conclusion/PlaceDescription.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a PlaceDescription from a (parsed) JSON hash

Constructs a PlaceDescription from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

Gedcomx\Conclusion\Subject::__construct
public string
# getType( )

An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).

An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).

Returns

string
public
# setType( string $type )

An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).

An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).

Parameters

$type
public Gedcomx\Common\TextValue[]
# getNames( )

An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place.

An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place.

Returns

Gedcomx\Common\TextValue[]
public
# setNames( array $names )

An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place.

An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place.

Parameters

$names
public Gedcomx\Conclusion\DateInfo
# getTemporalDescription( )

A description of the time period to which this place description is relevant.

A description of the time period to which this place description is relevant.

Returns

Gedcomx\Conclusion\DateInfo
public
# setTemporalDescription( Gedcomx\Conclusion\DateInfo $temporalDescription )

A description of the time period to which this place description is relevant.

A description of the time period to which this place description is relevant.

Parameters

$temporalDescription
public float
# getLatitude( )

Degrees north or south of the Equator.

Degrees north or south of the Equator.

Returns

float
public
# setLatitude( float $latitude )

Degrees north or south of the Equator.

Degrees north or south of the Equator.

Parameters

$latitude
public float
# getLongitude( )

Angular distance in degrees, relative to the Prime Meridian.

Angular distance in degrees, relative to the Prime Meridian.

Returns

float
public
# setLongitude( float $longitude )

Angular distance in degrees, relative to the Prime Meridian.

Angular distance in degrees, relative to the Prime Meridian.

Parameters

$longitude
public Gedcomx\Common\ResourceReference
# getSpatialDescription( )

A reference to a geospatial description of this place.

A reference to a geospatial description of this place.

Returns

Gedcomx\Common\ResourceReference
public
# setSpatialDescription( Gedcomx\Common\ResourceReference $spatialDescription )

A reference to a geospatial description of this place.

A reference to a geospatial description of this place.

Parameters

$spatialDescription
public Gedcomx\Common\ResourceReference
# getJurisdiction( )

A reference to a description of the jurisdiction this place.

A reference to a description of the jurisdiction this place.

Returns

Gedcomx\Common\ResourceReference
public
# setJurisdiction( Gedcomx\Common\ResourceReference $jurisdiction )

A reference to a description of the jurisdiction this place.

A reference to a description of the jurisdiction this place.

Parameters

$jurisdiction
public Gedcomx\Conclusion\PlaceDisplayProperties
# getDisplayExtension( )

Display properties for the place. Display properties are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Display properties for the place. Display properties are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Returns

Gedcomx\Conclusion\PlaceDisplayProperties
public
# setDisplayExtension( Gedcomx\Conclusion\PlaceDisplayProperties $displayExtension )

Display properties for the place. Display properties are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Display properties for the place. Display properties are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Parameters

$displayExtension
public array
# toArray( )

Returns the associative array for this PlaceDescription

Returns the associative array for this PlaceDescription

Returns

array

Overrides

Gedcomx\Conclusion\Subject::toArray
public
# initFromArray( array $o )

Initializes this PlaceDescription from an associative array

Initializes this PlaceDescription from an associative array

Parameters

$o

Overrides

Gedcomx\Conclusion\Subject::initFromArray
public
# accept( Gedcomx\Rt\GedcomxModelVisitor $visitor )
public
# writeXmlContents( XMLWriter $writer )

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

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

Parameters

$writer
The XML writer.

Overrides

Gedcomx\Conclusion\Subject::writeXmlContents

Methods inherited from Gedcomx\Conclusion\Subject

getEvidence(), getExtracted(), getIdentifiers(), getMedia(), setEvidence(), setExtracted(), setIdentifiers(), setMedia()

Methods inherited from Gedcomx\Conclusion\Conclusion

getAnalysis(), getAttribution(), getConfidence(), getLang(), getNotes(), getSources(), setAnalysis(), setAttribution(), setConfidence(), setLang(), setNotes(), setSources()

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