Comments
extends AbstractPart
in package
Word2007 comments part writer: word/comments.xml.
Table of Contents
Properties
- $dateFormat : string
- $elements : array<string|int, Comment>
- Comments collection to be written.
- $parentWriter : AbstractWriter
- Parent writer.
Methods
- getParentWriter() : AbstractWriter
- Get parent writer.
- setElements() : self
- Set element.
- setParentWriter() : void
- Set parent writer.
- write() : string
- Write part.
- getXmlWriter() : XMLWriter
- Get XML Writer.
- writeComment() : void
- Write comment item.
- writeText() : bool
- Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled().
Properties
$dateFormat
protected
string
$dateFormat
= 'Y-m-d\TH:i:sP'
Date format
$elements
Comments collection to be written.
protected
array<string|int, Comment>
$elements
$parentWriter
Parent writer.
protected
AbstractWriter
$parentWriter
Methods
getParentWriter()
Get parent writer.
public
getParentWriter() : AbstractWriter
Return values
AbstractWritersetElements()
Set element.
public
setElements(array<string|int, Comment> $elements) : self
Parameters
- $elements : array<string|int, Comment>
Return values
selfsetParentWriter()
Set parent writer.
public
setParentWriter([AbstractWriter|null $writer = null ]) : void
Parameters
- $writer : AbstractWriter|null = null
write()
Write part.
public
write() : string
Return values
stringgetXmlWriter()
Get XML Writer.
protected
getXmlWriter() : XMLWriter
Return values
XMLWriterwriteComment()
Write comment item.
protected
writeComment(XMLWriter $xmlWriter, Comment $comment) : void
Parameters
writeText()
Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled().
protected
writeText(string $content) : bool
Parameters
- $content : string
-
The text string to write
Return values
bool —Returns true on success or false on failure