\PhpOffice\PhpWord\StyleTOC

__construct()

__construct() 

Create a new TOC Style

getType()

getType() : string

Get stop type

Returns

setType()

setType(string  $value) : self

Set stop type

Parameters

Returns

getLeader()

getLeader() : string

Get leader

Returns

setLeader()

setLeader(string  $value) : self

Set leader

Parameters

Returns

getPosition()

getPosition() : integer|float

Get position

Returns

setPosition()

setPosition(integer|float  $value) : self

Set position

Parameters

Returns

getStyleName()

getStyleName() : string

Get style name

Returns

setStyleName()

setStyleName(string  $value) : self

Set style name

Parameters

Returns

getIndex()

getIndex() : integer|null

Get index number

Returns

setIndex()

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

Set index number

Parameters

Returns

isAuto()

isAuto() : boolean

Get is automatic style flag

Returns

setAuto()

setAuto(boolean  $value = true) : self

Set is automatic style flag

Parameters

Returns

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

Returns

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

Returns

setStyleByArray()

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

Set style by using associative array

Parameters

Returns

setArrayStyle()

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

Set style using associative array

Parameters

Returns

getTabPos()

getTabPos() : integer|float

Get Tab Position

Returns

setTabPos()

setTabPos(integer|float  $value) : self

Set Tab Position

Parameters

Returns

getTabLeader()

getTabLeader() : string

Get Tab Leader

Returns

setTabLeader()

setTabLeader(string  $value = self::TAB_LEADER_DOT) : self

Set Tab Leader

Parameters

Returns

getIndent()

getIndent() : integer|float

Get Indent

Returns

setIndent()

setIndent(integer|float  $value) : self

Set Indent

Parameters

Returns

setNonEmptyVal()

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

Set default for null and empty value

Parameters

Returns

(was: mixed)

setBoolVal()

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

Set bool value

Parameters

Returns

setNumericVal()

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

Set numeric value

Parameters

Returns

setIntVal()

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

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

Parameters

Returns

setFloatVal()

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

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

Parameters

Returns

setEnumVal()

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

Set enum value

Parameters

Throws

\InvalidArgumentException

Returns

setObjectVal()

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

Set object value

Parameters

Returns

setPairedVal()

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

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

Parameters

Returns