PageBreak extends AbstractElement
PageBreak element writer
Table of Contents
- $withoutP : bool
- Without paragraph
- $element : AbstractElement
- Element
- $xmlWriter : XMLWriter
- XML writer
- __construct() : mixed
- Create new instance
- write() : mixed
- Write element
- endElementP() : mixed
- End w:p DOM element.
- getElement() : AbstractElement
- Get element
- getText() : string
- Convert text to valid format
- getXmlWriter() : XMLWriter
- Get XML Writer
- startElementP() : mixed
- Start w:p DOM element.
- writeCommentRangeEnd() : mixed
- Writes the w:commentRangeEnd DOM element
- writeCommentRangeStart() : mixed
- Writes the w:commentRangeStart DOM element
- writeFontStyle() : mixed
- Write ending.
- writeParagraphStyle() : mixed
- Write ending.
- writeText() : bool
- Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled()
- writeTextStyle() : mixed
- Write text style.
Properties
$withoutP
Without paragraph
protected
bool
$withoutP
= false
$element
Element
private
AbstractElement
$element
$xmlWriter
XML writer
private
XMLWriter
$xmlWriter
Methods
__construct()
Create new instance
public
__construct(XMLWriter $xmlWriter, AbstractElement $element[, bool $withoutP = false ]) : mixed
Parameters
- $xmlWriter : XMLWriter
- $element : AbstractElement
- $withoutP : bool = false
Return values
mixed —write()
Write element
public
write() : mixed
Return values
mixed —endElementP()
End w:p DOM element.
protected
endElementP() : mixed
Return values
mixed —getElement()
Get element
protected
getElement() : AbstractElement
Return values
AbstractElement —getText()
Convert text to valid format
protected
getText(string $text) : string
Parameters
- $text : string
Return values
string —getXmlWriter()
Get XML Writer
protected
getXmlWriter() : XMLWriter
Return values
XMLWriter —startElementP()
Start w:p DOM element.
protected
startElementP() : mixed
Tags
Return values
mixed —writeCommentRangeEnd()
Writes the w:commentRangeEnd DOM element
protected
writeCommentRangeEnd() : mixed
Return values
mixed —writeCommentRangeStart()
Writes the w:commentRangeStart DOM element
protected
writeCommentRangeStart() : mixed
Return values
mixed —writeFontStyle()
Write ending.
protected
writeFontStyle() : mixed
Return values
mixed —writeParagraphStyle()
Write ending.
protected
writeParagraphStyle() : mixed
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
writeTextStyle()
Write text style.
private
writeTextStyle(string $styleType) : mixed
Parameters
- $styleType : string
-
Font|Paragraph