Field extends Text
Field element writer
Note: for now, only date, page and numpages fields are implemented for RTF.
Table of Contents
- $element : AbstractElement
- Element
- $escaper : Escaper|AbstractEscaper
- $fontStyle : Font
- Font style
- $paragraphStyle : Paragraph
- Paragraph style
- $parentWriter : AbstractWriter
- Parent writer
- $withoutP : bool
- Without paragraph
- __construct() : mixed
- Create new instance
- setWithoutP() : mixed
- Set without paragraph.
- write() : string
- Write field element.
- getStyles() : mixed
- Get font and paragraph styles.
- writeClosing() : string
- Write closing
- writeDate() : mixed
- writeFontStyle() : string
- Write font style
- writeNumpages() : mixed
- writeOpening() : string
- Write opening
- writePage() : mixed
- writeText() : string
- Write text
Properties
$element
Element
protected
AbstractElement
$element
$escaper
protected
Escaper|AbstractEscaper
$escaper
$fontStyle
Font style
protected
Font
$fontStyle
$paragraphStyle
Paragraph style
protected
Paragraph
$paragraphStyle
$parentWriter
Parent writer
protected
AbstractWriter
$parentWriter
$withoutP
Without paragraph
protected
bool
$withoutP
= false
Methods
__construct()
Create new instance
public
__construct(AbstractWriter $parentWriter, AbstractElement $element[, bool $withoutP = false ]) : mixed
Parameters
- $parentWriter : AbstractWriter
- $element : AbstractElement
- $withoutP : bool = false
Return values
mixed —setWithoutP()
Set without paragraph.
public
setWithoutP(bool $value) : mixed
Parameters
- $value : bool
Return values
mixed —write()
Write field element.
public
write() : string
Return values
string —getStyles()
Get font and paragraph styles.
protected
getStyles() : mixed
Return values
mixed —writeClosing()
Write closing
protected
writeClosing() : string
Return values
string —writeDate()
protected
writeDate(Field $element) : mixed
Parameters
- $element : Field
Return values
mixed —writeFontStyle()
Write font style
protected
writeFontStyle() : string
Return values
string —writeNumpages()
protected
writeNumpages() : mixed
Return values
mixed —writeOpening()
Write opening
protected
writeOpening() : string
Return values
string —writePage()
protected
writePage() : mixed
Return values
mixed —writeText()
Write text
protected
writeText(string $text) : string
Parameters
- $text : string