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

  • Error
  • FamilySearchPlatform
  • Feature
  • HealthConfig
  • Tag

Class Feature

A description of a FamilySearch feature.

Namespace: Gedcomx\Extensions\FamilySearch
Located at Extensions/FamilySearch/Feature.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a Feature from a (parsed) JSON hash

Constructs a Feature from a (parsed) JSON hash

Parameters

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

The name of the feature.

The name of the feature.

Returns

string
public
# setName( string $name )

The name of the feature.

The name of the feature.

Parameters

$name
public string
# getDescription( )

A description of the feature.

A description of the feature.

Returns

string
public
# setDescription( string $description )

A description of the feature.

A description of the feature.

Parameters

$description
public boolean
# getEnabled( )

Whether the feature is enabled for the current request.

Whether the feature is enabled for the current request.

Returns

boolean
public
# setEnabled( boolean $enabled )

Whether the feature is enabled for the current request.

Whether the feature is enabled for the current request.

Parameters

$enabled
public integer
# getActivationDate( )

The date that this feature is scheduled to activate permanently.

The date that this feature is scheduled to activate permanently.

Returns

integer
public
# setActivationDate( integer $activationDate )

The date that this feature is scheduled to activate permanently.

The date that this feature is scheduled to activate permanently.

Parameters

$activationDate
public array
# toArray( )

Returns the associative array for this Feature

Returns the associative array for this Feature

Returns

array
public string
# toJson( )

Returns the JSON string for this Feature

Returns the JSON string for this Feature

Returns

string
public
# initFromArray( array $o )

Initializes this Feature from an associative array

Initializes this Feature from an associative array

Parameters

$o
public
# initFromReader( XMLReader $xml )

Initializes this Feature from an XML reader.

Initializes this Feature from an XML reader.

Parameters

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

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

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