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