AbstractPart
extends AbstractPart
in package
AbstractYes
ODText writer part abstract.
Table of Contents
Properties
- $dateFormat : string
- $objects : array<string|int, AbstractElement>
- $parentWriter : AbstractWriter
- Parent writer.
Methods
- addObject() : int
- getObjects() : array<string|int, AbstractElement>
- getParentWriter() : AbstractWriter
- Get parent writer.
- setObjects() : self
- setParentWriter() : void
- Set parent writer.
- write() : string
- Write part.
- getXmlWriter() : XMLWriter
- Get XML Writer.
- writeCommonRootAttributes() : void
- Write common root attributes.
- writeFontFaces() : void
- Write font faces declaration.
- 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:s.000'
Date format
$objects
protected
array<string|int, AbstractElement>
$objects
= []
$parentWriter
Parent writer.
protected
AbstractWriter
$parentWriter
Methods
addObject()
public
addObject(AbstractElement $object) : int
Parameters
- $object : AbstractElement
Return values
intgetObjects()
public
getObjects() : array<string|int, AbstractElement>
Return values
array<string|int, AbstractElement>getParentWriter()
Get parent writer.
public
getParentWriter() : AbstractWriter
Return values
AbstractWritersetObjects()
public
setObjects(array<string|int, AbstractElement> $objects) : self
Parameters
- $objects : array<string|int, AbstractElement>
Return values
selfsetParentWriter()
Set parent writer.
public
setParentWriter([AbstractWriter|null $writer = null ]) : void
Parameters
- $writer : AbstractWriter|null = null
write()
Write part.
public
abstract write() : string
Return values
stringgetXmlWriter()
Get XML Writer.
protected
getXmlWriter() : XMLWriter
Return values
XMLWriterwriteCommonRootAttributes()
Write common root attributes.
protected
writeCommonRootAttributes(XMLWriter $xmlWriter) : void
Parameters
- $xmlWriter : XMLWriter
writeFontFaces()
Write font faces declaration.
protected
writeFontFaces(XMLWriter $xmlWriter) : void
Parameters
- $xmlWriter : XMLWriter
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