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

  • Category
  • CommonAttributes
  • Content
  • Entry
  • ExtensibleElement
  • Feed
  • Generator
  • Person

Class Category

conveys information about a category associated with an entry or feed.

Gedcomx\Atom\CommonAttributes
Extended by Gedcomx\Atom\Category
Namespace: Gedcomx\Atom
Located at Atom/Category.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a Category from a (parsed) JSON hash

Constructs a Category from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

Gedcomx\Atom\CommonAttributes::__construct
public string
# getScheme( )

identifies a categorization scheme

identifies a categorization scheme

Returns

string
public
# setScheme( string $scheme )

identifies a categorization scheme

identifies a categorization scheme

Parameters

$scheme
public string
# getTerm( )

identifies the category to which the entry or feed belongs

identifies the category to which the entry or feed belongs

Returns

string
public
# setTerm( string $term )

identifies the category to which the entry or feed belongs

identifies the category to which the entry or feed belongs

Parameters

$term
public string
# getLabel( )

a human-readable label for display in end-user applications

a human-readable label for display in end-user applications

Returns

string
public
# setLabel( string $label )

a human-readable label for display in end-user applications

a human-readable label for display in end-user applications

Parameters

$label
public array
# toArray( )

Returns the associative array for this Category

Returns the associative array for this Category

Returns

array

Overrides

Gedcomx\Atom\CommonAttributes::toArray
public
# initFromArray( array $o )

Initializes this Category from an associative array

Initializes this Category from an associative array

Parameters

$o

Overrides

Gedcomx\Atom\CommonAttributes::initFromArray
public
# writeXmlContents( XMLWriter $writer )

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

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

Parameters

$writer
The XML writer.

Overrides

Gedcomx\Atom\CommonAttributes::writeXmlContents

Methods inherited from Gedcomx\Atom\CommonAttributes

getBase(), getLang(), initFromReader(), setBase(), setLang(), toJson()

gedcomx-php API documentation generated by ApiGen