Settings extends AbstractPart
Word2007 settings part writer: word/settings.xml
Tags
Table of Contents
- $dateFormat : string
- $parentWriter : AbstractWriter
- Parent writer
- $settings : array<string|int, mixed>
- Settings value
- getParentWriter() : AbstractWriter
- Get parent writer
- setParentWriter() : mixed
- Set parent writer.
- write() : string
- Write part
- getXmlWriter() : XMLWriter
- Get XML Writer
- writeSetting() : mixed
- Write indivual setting, recursive to any child settings.
- writeText() : bool
- Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled()
- getSettings() : mixed
- Get settings.
- setCompatibility() : mixed
- Get compatibility setting.
- setConsecutiveHyphenLimit() : mixed
- setDocumentProtection() : mixed
- Get protection settings.
- setHyphenationZone() : mixed
- setOnOffValue() : mixed
- Adds a boolean attribute to the settings array
- setProofState() : mixed
- Set the Proof state
- setRevisionView() : mixed
- Set the Revision View
- setThemeFontLang() : mixed
- Sets the language
- setZoom() : mixed
- Set the magnification
Properties
$dateFormat
protected
string
$dateFormat
= 'Y-m-d\TH:i:sP'
$parentWriter
Parent writer
protected
AbstractWriter
$parentWriter
$settings
Settings value
private
array<string|int, mixed>
$settings
= array()
Methods
getParentWriter()
Get parent writer
public
getParentWriter() : AbstractWriter
Tags
Return values
AbstractWriter —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 —writeSetting()
Write indivual setting, recursive to any child settings.
protected
writeSetting(XMLWriter $xmlWriter, string $settingKey, array<string|int, mixed>|string $settingValue) : mixed
Parameters
- $xmlWriter : XMLWriter
- $settingKey : string
- $settingValue : array<string|int, mixed>|string
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
getSettings()
Get settings.
private
getSettings() : mixed
Return values
mixed —setCompatibility()
Get compatibility setting.
private
setCompatibility() : mixed
Return values
mixed —setConsecutiveHyphenLimit()
private
setConsecutiveHyphenLimit(int|null $consecutiveHyphenLimit) : mixed
Parameters
- $consecutiveHyphenLimit : int|null
Return values
mixed —setDocumentProtection()
Get protection settings.
private
setDocumentProtection(Protection $documentProtection) : mixed
Parameters
- $documentProtection : Protection
Return values
mixed —setHyphenationZone()
private
setHyphenationZone(float|null $hyphenationZone) : mixed
Parameters
- $hyphenationZone : float|null
Return values
mixed —setOnOffValue()
Adds a boolean attribute to the settings array
private
setOnOffValue(string $settingName, bool|null $booleanValue) : mixed
Parameters
- $settingName : string
- $booleanValue : bool|null
Return values
mixed —setProofState()
Set the Proof state
private
setProofState([ProofState $proofState = null ]) : mixed
Parameters
- $proofState : ProofState = null
Return values
mixed —setRevisionView()
Set the Revision View
private
setRevisionView([TrackChangesView $trackChangesView = null ]) : mixed
Parameters
- $trackChangesView : TrackChangesView = null
Return values
mixed —setThemeFontLang()
Sets the language
private
setThemeFontLang([Language $language = null ]) : mixed
Parameters
- $language : Language = null
Return values
mixed —setZoom()
Set the magnification
private
setZoom([mixed $zoom = null ]) : mixed
Parameters
- $zoom : mixed = null