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 CitationField

Represents a citation field -- its name and value.

Namespace: Gedcomx\Source
Located at Source/CitationField.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a CitationField from a (parsed) JSON hash

Constructs a CitationField from a (parsed) JSON hash

Parameters

$o
Either an array (JSON) or an XMLReader.
public string
# getName( )

The citation field's name.

The citation field's name.

Returns

string
public
# setName( string $name )

The citation field's name.

The citation field's name.

Parameters

$name
public string
# getValue( )

The citation field's value.

The citation field's value.

Returns

string
public
# setValue( string $value )

The citation field's value.

The citation field's value.

Parameters

$value
public array
# toArray( )

Returns the associative array for this CitationField

Returns the associative array for this CitationField

Returns

array
public string
# toJson( )

Returns the JSON string for this CitationField

Returns the JSON string for this CitationField

Returns

string
public
# initFromArray( array $o )

Initializes this CitationField from an associative array

Initializes this CitationField from an associative array

Parameters

$o
public
# initFromReader( XMLReader $xml )

Initializes this CitationField from an XML reader.

Initializes this CitationField from an XML reader.

Parameters

$xml
The reader to use to initialize this object.
public
# writeXmlContents( XMLWriter $writer )

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

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

Parameters

$writer
The XML writer.
gedcomx-php-client API documentation generated by ApiGen