Footnotes extends AbstractPart
Word2007 footnotes part writer: word/(footnotes|endnotes).xml
Table of Contents
- $dateFormat : string
- $elementNode : string
- Name of XML node element
- $elements : Footnotes|Endnotes
- Footnotes/endnotes collection to be written
- $parentWriter : AbstractWriter
- Parent writer
- $refNode : string
- Name of XML reference element
- $refStyle : string
- Reference style name
- $rootNode : string
- Name of XML root element
- getParentWriter() : AbstractWriter
- Get parent writer
- setElements() : self
- Set element
- setParentWriter() : mixed
- Set parent writer.
- write() : string
- Write part
- getXmlWriter() : XMLWriter
- Get XML Writer
- writeNote() : mixed
- Write note 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'
$elementNode
Name of XML node element
protected
string
$elementNode
= 'w:footnote'
$elements
Footnotes/endnotes collection to be written
protected
Footnotes|Endnotes
$elements
$parentWriter
Parent writer
protected
AbstractWriter
$parentWriter
$refNode
Name of XML reference element
protected
string
$refNode
= 'w:footnoteRef'
$refStyle
Reference style name
protected
string
$refStyle
= 'FootnoteReference'
$rootNode
Name of XML root element
protected
string
$rootNode
= 'w:footnotes'
Methods
getParentWriter()
Get parent writer
public
getParentWriter() : AbstractWriter
Tags
Return values
AbstractWriter —setElements()
Set element
public
setElements(Footnotes|Endnotes $elements) : self
Parameters
Return values
self —setParentWriter()
Set parent writer.
public
setParentWriter([AbstractWriter $writer = null ]) : mixed
Parameters
- $writer : AbstractWriter = null
Return values
mixed —write()
Write part
public
write() : string
Return values
string —getXmlWriter()
Get XML Writer
protected
getXmlWriter() : XMLWriter
Return values
XMLWriter —writeNote()
Write note item.
protected
writeNote(XMLWriter $xmlWriter, Footnote|Endnote $element) : mixed
Parameters
Return values
mixed —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