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

  • Comment
  • Discussion

Class Comment

Class Comment

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a Comment from a (parsed) JSON hash

Constructs a Comment from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

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

The text or "message body" of the comment

The text or "message body" of the comment

Returns

string
public
# setText( string $text )

The text or "message body" of the comment

The text or "message body" of the comment

Parameters

$text
public integer
# getCreated( )

date of creation

date of creation

Returns

integer
public
# setCreated( integer $created )

date of creation

date of creation

Parameters

$created
public Gedcomx\Common\ResourceReference
# getContributor( )

contributor of comment

contributor of comment

Returns

Gedcomx\Common\ResourceReference
public
# setContributor( Gedcomx\Common\ResourceReference $contributor )

contributor of comment

contributor of comment

Parameters

$contributor
public array
# toArray( )

Returns the associative array for this Comment

Returns the associative array for this Comment

Returns

array

Overrides

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

Initializes this Comment from an associative array

Initializes this Comment from an associative array

Parameters

$o

Overrides

Gedcomx\Links\HypermediaEnabledData::initFromArray
public
# accept( Gedcomx\Extensions\FamilySearch\Rt\FamilySearchPlatformModelVisitor $visitor )
public
# writeXmlContents( XMLWriter $writer )

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

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