Class Document

An abstract document that contains derived (conclusionary) text -- for example, a transcription or researcher analysis.

Gedcomx\Common\ExtensibleData

Extended by

Gedcomx\Links\HypermediaEnabledData implements Gedcomx\Links\SupportsLinks

Extended by

Gedcomx\Conclusion\Conclusion implements Gedcomx\Common\Attributable, Gedcomx\Source\ReferencesSources, Gedcomx\Common\HasNotes

Extended by

Gedcomx\Conclusion\Document

Namespace: Gedcomx\Conclusion
Located at Conclusion/Document.php

Methods summary

`public`	# `__construct( mixed $o = null )` Constructs a Document from a (parsed) JSON hash Constructs a Document from a (parsed) JSON hash Parameters `$o` Either an array (JSON) or an XMLReader. Throws Exception Overrides `Gedcomx\Conclusion\Conclusion::__construct`
`public string`	# `getTextType( )` The text type of the document. The text type of the document. Returns string
`public`	# `setTextType( string $textType )` The text type of the document. The text type of the document. Parameters `$textType`
`public boolean`	# `getExtracted( )` Whether this document has been identified as "extracted". Whether this document has been identified as "extracted". Returns boolean
`public`	# `setExtracted( boolean $extracted )` Whether this document has been identified as "extracted". Whether this document has been identified as "extracted". Parameters `$extracted`
`public string`	# `getType( )` The type of the document. The type of the document. Returns string
`public`	# `setType( string $type )` The type of the document. The type of the document. Parameters `$type`
`public string`	# `getText( )` The document text. The document text. Returns string
`public`	# `setText( string $text )` The document text. The document text. Parameters `$text`
`public array`	# `toArray( )` Returns the associative array for this Document Returns the associative array for this Document Returns array Overrides `Gedcomx\Conclusion\Conclusion::toArray`
`public`	# `initFromArray( array $o )` Initializes this Document from an associative array Initializes this Document from an associative array Parameters `$o` Overrides `Gedcomx\Conclusion\Conclusion::initFromArray`
`public`	# `accept( Gedcomx\Rt\GedcomxModelVisitor $visitor )`
`public`	# `toXml( XMLWriter $writer, boolean $includeNamespaces = true )` Writes this Document to an XML writer. Writes this Document 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 Document to an XML writer. The startElement is expected to be already provided. Writes the contents of this Document to an XML writer. The startElement is expected to be already provided. Parameters `$writer` The XML writer. Overrides `Gedcomx\Conclusion\Conclusion::writeXmlContents`

Methods inherited from Gedcomx\Conclusion\Conclusion

getAnalysis(), getAttribution(), getConfidence(), getLang(), getNotes(), getSources(), setAnalysis(), setAttribution(), setConfidence(), setLang(), setNotes(), setSources()

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()