Field
extends Text
in package
Field element writer.
Tags
Table of Contents
Properties
- $part : null|AbstractPart
- $withoutP : bool
- Without paragraph.
- $element : AbstractElement
- Element.
- $xmlWriter : XMLWriter
- XML writer.
Methods
- __construct() : mixed
- Create new instance.
- getPart() : AbstractPart|null
- setPart() : self
- write() : void
- Write field element.
- endElementP() : void
- End w:p DOM element.
- getElement() : AbstractElement
- Get element.
- getText() : string
- Convert text to valid format.
- getXmlWriter() : XMLWriter
- Get XML Writer.
- startElementP() : void
- Start w:p DOM element.
- writeClosingTrackChange() : void
- Write ending.
- writeCommentRangeEnd() : void
- Writes the w:commentRangeEnd DOM element.
- writeCommentRangeStart() : void
- Writes the w:commentRangeStart DOM element.
- writeFontStyle() : void
- Write ending.
- writeMacrobutton() : void
- Writes a macrobutton field.
- writeOpeningTrackChange() : void
- Write opening of changed element.
- writeParagraphStyle() : void
- Write ending.
- writeRef() : void
- Writes a REF field.
- writeText() : bool
- Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled().
- buildPropertiesAndOptions() : mixed
- convertRefOption() : string
- writeDefault() : void
- writeTextStyle() : void
- Write text style.
Properties
$part
protected
null|AbstractPart
$part
$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
getPart()
public
getPart() : AbstractPart|null
Return values
AbstractPart|nullsetPart()
public
setPart(AbstractPart|null $part) : self
Parameters
- $part : AbstractPart|null
Return values
selfwrite()
Write field element.
public
write() : void
endElementP()
End w:p DOM element.
protected
endElementP() : void
getElement()
Get element.
protected
getElement() : AbstractElement
Return values
AbstractElementgetText()
Convert text to valid format.
protected
getText(string $text) : string
Parameters
- $text : string
Return values
stringgetXmlWriter()
Get XML Writer.
protected
getXmlWriter() : XMLWriter
Return values
XMLWriterstartElementP()
Start w:p DOM element.
protected
startElementP() : void
Tags
writeClosingTrackChange()
Write ending.
protected
writeClosingTrackChange() : void
writeCommentRangeEnd()
Writes the w:commentRangeEnd DOM element.
protected
writeCommentRangeEnd() : void
writeCommentRangeStart()
Writes the w:commentRangeStart DOM element.
protected
writeCommentRangeStart() : void
writeFontStyle()
Write ending.
protected
writeFontStyle() : void
writeMacrobutton()
Writes a macrobutton field.
protected
writeMacrobutton(Field $element) : void
//TODO A lot of code duplication with general method, should maybe be refactored
Parameters
- $element : Field
writeOpeningTrackChange()
Write opening of changed element.
protected
writeOpeningTrackChange() : void
writeParagraphStyle()
Write ending.
protected
writeParagraphStyle() : void
writeRef()
Writes a REF field.
protected
writeRef(Field $element) : void
Parameters
- $element : Field
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
buildPropertiesAndOptions()
private
buildPropertiesAndOptions(Field $element) : mixed
Parameters
- $element : Field
convertRefOption()
private
convertRefOption(string $optionKey, string $optionValue) : string
Parameters
- $optionKey : string
- $optionValue : string
Return values
stringwriteDefault()
private
writeDefault(Field $element) : void
Parameters
- $element : Field
writeTextStyle()
Write text style.
private
writeTextStyle(string $styleType) : void
Parameters
- $styleType : string
-
Font|Paragraph