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

  • Address
  • Agent
  • OnlineAccount

Class Agent

An agent, e.g. person, organization, or group. In genealogical research, an agent often takes the role of a contributor.

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a Agent from a (parsed) JSON hash

Constructs a Agent from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

Gedcomx\Links\HypermediaEnabledData::__construct
public Gedcomx\Agent\OnlineAccount[]
# getAccounts( )

The accounts that belong to this person or organization.

The accounts that belong to this person or organization.

Returns

Gedcomx\Agent\OnlineAccount[]
public
# setAccounts( Gedcomx\Agent\OnlineAccount[] $accounts )

The accounts that belong to this person or organization.

The accounts that belong to this person or organization.

Parameters

$accounts
public Gedcomx\Agent\Address[]
# getAddresses( )

The addresses that belong to this person or organization.

The addresses that belong to this person or organization.

Returns

Gedcomx\Agent\Address[]
public
# setAddresses( Gedcomx\Agent\Address[] $addresses )

The addresses that belong to this person or organization.

The addresses that belong to this person or organization.

Parameters

$addresses
public Gedcomx\Common\ResourceReference[]
# getEmails( )

The emails that belong to this person or organization.

The emails that belong to this person or organization.

Returns

Gedcomx\Common\ResourceReference[]
public
# setEmails( Gedcomx\Common\ResourceReference[] $emails )

The emails that belong to this person or organization.

The emails that belong to this person or organization.

Parameters

$emails
public Gedcomx\Common\ResourceReference
# getHomepage( )

The homepage.

The homepage.

Returns

Gedcomx\Common\ResourceReference
public
# setHomepage( Gedcomx\Common\ResourceReference $homepage )

The homepage.

The homepage.

Parameters

$homepage
public Gedcomx\Conclusion\Identifier[]
# getIdentifiers( )

The list of identifiers for the agent.

The list of identifiers for the agent.

Returns

Gedcomx\Conclusion\Identifier[]
public
# setIdentifiers( Gedcomx\Conclusion\Identifier[] $identifiers )

The list of identifiers for the agent.

The list of identifiers for the agent.

Parameters

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

The list of names for the agent.

The list of names for the agent.

Returns

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

The list of names for the agent.

The list of names for the agent.

Parameters

$names
public Gedcomx\Common\ResourceReference
# getOpenid( )

The <a href="http://openid.net/">openid</a> of the person or organization.

The <a href="http://openid.net/">openid</a> of the person or organization.

Returns

Gedcomx\Common\ResourceReference
public
# setOpenid( Gedcomx\Common\ResourceReference $openid )

The <a href="http://openid.net/">openid</a> of the person or organization.

The <a href="http://openid.net/">openid</a> of the person or organization.

Parameters

$openid
public Gedcomx\Common\ResourceReference[]
# getPhones( )

The phones that belong to this person or organization.

The phones that belong to this person or organization.

Returns

Gedcomx\Common\ResourceReference[]
public
# setPhones( Gedcomx\Common\ResourceReference[] $phones )

The phones that belong to this person or organization.

The phones that belong to this person or organization.

Parameters

$phones
public array
# toArray( )

Returns the associative array for this Agent

Returns the associative array for this Agent

Returns

array

Overrides

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

Initializes this Agent from an associative array

Initializes this Agent from an associative array

Parameters

$o

Overrides

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

Writes this Agent to an XML writer.

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

Writes the contents of this Agent 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-client API documentation generated by ApiGen