Properties

$styleName

$styleName : string

Style name

Type

string

$index

$index : integer|null

Index number in Style collection for named style

This number starts from one and defined in Style::setStyleValues()

Type

integer|null

$aliases

$aliases : array

Aliases

Type

array

$isAuto

$isAuto : boolean

Is this an automatic style? (Used primarily in OpenDocument driver)

Type

boolean

$level

$level : integer

Level number, 0 to 8 (total 9 levels)

Type

integer

$start

$start : integer

Starting value w:start

Type

integer

$format

$format : string

Numbering format w:numFmt, one of PhpOffice\PhpWord\SimpleType\NumberFormat

Type

string

$restart

$restart : integer

Restart numbering level symbol w:lvlRestart

Type

integer

$pStyle

$pStyle : string

Related paragraph style

Type

string

$suffix

$suffix : string

Content between numbering symbol and paragraph text w:suff

Type

string — tab|space|nothing

$text

$text : string

Numbering level text e.g. %1 for nonbullet or bullet character

Type

string

$alignment

$alignment : \PhpOffice\PhpWord\Style\string,

Justification, w:lvlJc

Type

\PhpOffice\PhpWord\Style\string, — one of PhpOffice\PhpWord\SimpleType\Jc

$left

$left : integer

Left

Type

integer

$hanging

$hanging : integer

Hanging

Type

integer

$tabPos

$tabPos : integer

Tab position

Type

integer

$font

$font : string

Font family

Type

string

$hint

$hint : string

Hint default|eastAsia|cs

Type

string

Methods

getStyleName()

getStyleName() : string

Get style name

Returns

string

setStyleName()

setStyleName(string  $value) : self

Set style name

Parameters

string $value

Returns

self

getIndex()

getIndex() : integer|null

Get index number

Returns

integer|null

setIndex()

setIndex(integer|null  $value = null) : self

Set index number

Parameters

integer|null $value

Returns

self

isAuto()

isAuto() : boolean

Get is automatic style flag

Returns

boolean

setAuto()

setAuto(boolean  $value = true) : self

Set is automatic style flag

Parameters

boolean $value

Returns

self

getChildStyleValue()

getChildStyleValue(\PhpOffice\PhpWord\Style\AbstractStyle  $substyleObject, string  $substyleProperty) : mixed

Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`

Parameters

\PhpOffice\PhpWord\Style\AbstractStyle $substyleObject
string $substyleProperty

Returns

mixed

setStyleValue()

setStyleValue(string  $key, string  $value) : self

Set style value template method

Some child classes have their own specific overrides. Backward compability check for versions < 0.10.0 which use underscore prefix for their private properties. Check if the set method is exists. Throws an exception?

Parameters

string $key
string $value

Returns

self

setStyleByArray()

setStyleByArray(array  $values = array()) : self

Set style by using associative array

Parameters

array $values

Returns

self

setArrayStyle()

setArrayStyle(array  $style = array()) : self

Set style using associative array

Parameters

array $style

Returns

self

getLevel()

getLevel() : integer

Get level

Returns

integer

setLevel()

setLevel(integer  $value) : self

Set level

Parameters

integer $value

Returns

self

getStart()

getStart() : integer

Get start

Returns

integer

setStart()

setStart(integer  $value) : self

Set start

Parameters

integer $value

Returns

self

getFormat()

getFormat() : string

Get format

Returns

string

setFormat()

setFormat(string  $value) : self

Set format

Parameters

string $value

Returns

self

getRestart()

getRestart() : integer

Get restart

Returns

integer

setRestart()

setRestart(integer  $value) : self

Set restart

Parameters

integer $value

Returns

self

getPStyle()

getPStyle() : string

Get related paragraph style

Returns

string

setPStyle()

setPStyle(string  $value) : self

Set related paragraph style

Parameters

string $value

Returns

self

getSuffix()

getSuffix() : string

Get suffix

Returns

string

setSuffix()

setSuffix(string  $value) : self

Set suffix

Parameters

string $value

Returns

self

getText()

getText() : string

Get text

Returns

string

setText()

setText(string  $value) : self

Set text

Parameters

string $value

Returns

self

getAlignment()

getAlignment() : string

Returns

string

setAlignment()

setAlignment(string  $value) : self

Parameters

string $value

Returns

self

getAlign()

getAlign() : string

Returns

string

setAlign()

setAlign(string  $value) : self

Parameters

string $value

Returns

self

getLeft()

getLeft() : integer

Get left

Returns

integer

setLeft()

setLeft(integer  $value) : self

Set left

Parameters

integer $value

Returns

self

getHanging()

getHanging() : integer

Get hanging

Returns

integer

setHanging()

setHanging(integer  $value) : self

Set hanging

Parameters

integer $value

Returns

self

getTabPos()

getTabPos() : integer

Get tab

Returns

integer

setTabPos()

setTabPos(integer  $value) : self

Set tab

Parameters

integer $value

Returns

self

getFont()

getFont() : string

Get font

Returns

string

setFont()

setFont(string  $value) : self

Set font

Parameters

string $value

Returns

self

getHint()

getHint() : string

Get hint

Returns

string

setHint()

setHint(string  $value = null) : self

Set hint

Parameters

string $value

Returns

self

setNonEmptyVal()

setNonEmptyVal(string  $value, string  $default) : string

Set default for null and empty value

Parameters

string $value

(was: mixed)

string $default

(was: mixed)

Returns

string —

(was: mixed)

setBoolVal()

setBoolVal(boolean  $value, boolean  $default) : boolean

Set bool value

Parameters

boolean $value
boolean $default

Returns

boolean

setNumericVal()

setNumericVal(mixed  $value, integer|float|null  $default = null) : integer|float|null

Set numeric value

Parameters

mixed $value
integer|float|null $default

Returns

integer|float|null

setIntVal()

setIntVal(integer|null  $value, integer|null  $default = null) : integer|null

Set integer value: Convert string that contains only numeric into integer

Parameters

integer|null $value
integer|null $default

Returns

integer|null

setFloatVal()

setFloatVal(mixed  $value, float|null  $default = null) : float|null

Set float value: Convert string that contains only numeric into float

Parameters

mixed $value
float|null $default

Returns

float|null

setEnumVal()

setEnumVal(mixed  $value = null, array  $enum = array(), mixed  $default = null) : mixed

Set enum value

Parameters

mixed $value
array $enum
mixed $default

Throws

\InvalidArgumentException

Returns

mixed

setObjectVal()

setObjectVal(mixed  $value, string  $styleName,   $style) : mixed

Set object value

Parameters

mixed $value
string $styleName
$style

Returns

mixed

setPairedVal()

setPairedVal(  $property,   $pairProperty, boolean  $value) : self

Set $property value and set $pairProperty = false when $value = true

Parameters

$property
$pairProperty
boolean $value

Returns

self