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

  • Comment
  • Discussion

Class Discussion

Class Discussion

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a Discussion from a (parsed) JSON hash

Constructs a Discussion from a (parsed) JSON hash

Parameters

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

Throws

Exception

Overrides

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

the one-line summary text

the one-line summary text

Returns

string
public
# setTitle( string $title )

the one-line summary text

the one-line summary text

Parameters

$title
public string
# getDetails( )

The text or "message body" of the discussion

The text or "message body" of the discussion

Returns

string
public
# setDetails( string $details )

The text or "message body" of the discussion

The text or "message body" of the discussion

Parameters

$details
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 discussion

contributor of discussion

Returns

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

contributor of discussion

contributor of discussion

Parameters

$contributor
public integer
# getModified( )

Date of last modification

Date of last modification

Returns

integer
public
# setModified( integer $modified )

Date of last modification

Date of last modification

Parameters

$modified
public integer
# getNumberOfComments( )

Number of comments

Number of comments

Returns

integer
public
# setNumberOfComments( integer $numberOfComments )

Number of comments

Number of comments

Parameters

$numberOfComments
public Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment[]
# getComments( )

The comments on this discussion.

The comments on this discussion.

Returns

Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment[]
public
# setComments( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment[] $comments )

The comments on this discussion.

The comments on this discussion.

Parameters

$comments
public
# addComment( Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment $comment )

Add a comment.

Add a comment.

Parameters

$comment
public array
# toArray( )

Returns the associative array for this Discussion

Returns the associative array for this Discussion

Returns

array

Overrides

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

Initializes this Discussion from an associative array

Initializes this Discussion 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 Discussion to an XML writer.

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

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