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

  • User

Class User

Class User

Gedcomx\Common\ExtensibleData
Extended by Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks
Extended by Gedcomx\Extensions\FamilySearch\Platform\Users\User
Namespace: Gedcomx\Extensions\FamilySearch\Platform\Users
Package: Gedcomx\Extensions\FamilySearch\Platform\Users
Located at Extensions/FamilySearch/Platform/Users/User.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a User from a (parsed) JSON hash

Constructs a User from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

Gedcomx\Links\HypermediaEnabledData::__construct
public string
# getAlternateEmail( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setAlternateEmail( string $alternateEmail )

(no documentation provided)

(no documentation provided)

Parameters

$alternateEmail
public string
# getBirthDate( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setBirthDate( string $birthDate )

(no documentation provided)

(no documentation provided)

Parameters

$birthDate
public string
# getContactName( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setContactName( string $contactName )

(no documentation provided)

(no documentation provided)

Parameters

$contactName
public string
# getCountry( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setCountry( string $country )

(no documentation provided)

(no documentation provided)

Parameters

$country
public string
# getDisplayName( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setDisplayName( string $displayName )

(no documentation provided)

(no documentation provided)

Parameters

$displayName
public string
# getEmail( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setEmail( string $email )

(no documentation provided)

(no documentation provided)

Parameters

$email
public string
# getFamilyName( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setFamilyName( string $familyName )

(no documentation provided)

(no documentation provided)

Parameters

$familyName
public string
# getFullName( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setFullName( string $fullName )

(no documentation provided)

(no documentation provided)

Parameters

$fullName
public string
# getGender( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setGender( string $gender )

(no documentation provided)

(no documentation provided)

Parameters

$gender
public string
# getGivenName( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setGivenName( string $givenName )

(no documentation provided)

(no documentation provided)

Parameters

$givenName
public string
# getHelperAccessPin( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setHelperAccessPin( string $helperAccessPin )

(no documentation provided)

(no documentation provided)

Parameters

$helperAccessPin
public boolean
# getLdsMemberAccount( )

(no documentation provided)

(no documentation provided)

Returns

boolean
public
# setLdsMemberAccount( boolean $ldsMemberAccount )

(no documentation provided)

(no documentation provided)

Parameters

$ldsMemberAccount
public string
# getMailingAddress( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setMailingAddress( string $mailingAddress )

(no documentation provided)

(no documentation provided)

Parameters

$mailingAddress
public string
# getPersonId( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setPersonId( string $personId )

(no documentation provided)

(no documentation provided)

Parameters

$personId
public string
# getPhoneNumber( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setPhoneNumber( string $phoneNumber )

(no documentation provided)

(no documentation provided)

Parameters

$phoneNumber
public string
# getPreferredLanguage( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setPreferredLanguage( string $preferredLanguage )

(no documentation provided)

(no documentation provided)

Parameters

$preferredLanguage
public string
# getTreeUserId( )

(no documentation provided)

(no documentation provided)

Returns

string
public
# setTreeUserId( string $treeUserId )

(no documentation provided)

(no documentation provided)

Parameters

$treeUserId
public array
# toArray( )

Returns the associative array for this User

Returns the associative array for this User

Returns

array

Overrides

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

Initializes this User from an associative array

Initializes this User from an associative array

Parameters

$o

Overrides

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

Writes this User to an XML writer.

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

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