Numbering extends AbstractStyle
Numbering style.
Tags
Table of Contents
- $aliases : array<string|int, mixed>
- Aliases.
- $index : null|int
- Index number in Style collection for named style.
- $styleName : string
- Style name.
- $isAuto : bool
- Is this an automatic style? (Used primarily in OpenDocument driver).
- $levels : array<string|int, NumberingLevel>
- Numbering levels.
- $numId : int
- Numbering definition instance ID.
- $type : string
- Multilevel type singleLevel|multilevel|hybridMultilevel.
- getChildStyleValue() : mixed
- Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.
- getIndex() : null|int
- Get index number.
- getLevels() : array<string|int, NumberingLevel>
- Get levels.
- getNumId() : int
- Get Id.
- getStyleName() : string
- Get style name.
- getType() : string
- Get multilevel type.
- isAuto() : bool
- Get is automatic style flag.
- setAuto() : self
- Set is automatic style flag.
- setIndex() : self
- Set index number.
- setLevels() : self
- Set multilevel type.
- setNumId() : self
- Set Id.
- setStyleByArray() : self
- Set style by using associative array.
- setStyleName() : self
- Set style name.
- setStyleValue() : self
- Set style value template method.
- setType() : self
- Set multilevel type.
- setBoolVal() : bool
- Set bool value.
- setEnumVal() : mixed
- Set enum value.
- setFloatVal() : null|float
- Set float value: Convert string that contains only numeric into float.
- setIntVal() : null|int
- Set integer value: Convert string that contains only numeric into integer.
- setNonEmptyVal() : string
- Set default for null and empty value.
- setNumericVal() : null|float|int
- Set numeric value.
- setObjectVal() : mixed
- Set object value.
- setPairedVal() : self
- Set $property value and set $pairProperty = false when $value = true.
Properties
$aliases
Aliases.
protected
array<string|int, mixed>
$aliases
= []
$index
Index number in Style collection for named style.
protected
null|int
$index
This number starts from one and defined in Style::setStyleValues()
$styleName
Style name.
protected
string
$styleName
$isAuto
Is this an automatic style? (Used primarily in OpenDocument driver).
private
bool
$isAuto
= false
Tags
$levels
Numbering levels.
private
array<string|int, NumberingLevel>
$levels
= []
$numId
Numbering definition instance ID.
private
int
$numId
Tags
$type
Multilevel type singleLevel|multilevel|hybridMultilevel.
private
string
$type
Tags
Methods
getChildStyleValue()
Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.
public
getChildStyleValue(AbstractStyle $substyleObject, string $substyleProperty) : mixed
Parameters
- $substyleObject : AbstractStyle
- $substyleProperty : string
Tags
Return values
mixed —getIndex()
Get index number.
public
getIndex() : null|int
Return values
null|int —getLevels()
Get levels.
public
getLevels() : array<string|int, NumberingLevel>
Return values
array<string|int, NumberingLevel> —getNumId()
Get Id.
public
getNumId() : int
Return values
int —getStyleName()
Get style name.
public
getStyleName() : string
Return values
string —getType()
Get multilevel type.
public
getType() : string
Return values
string —isAuto()
Get is automatic style flag.
public
isAuto() : bool
Return values
bool —setAuto()
Set is automatic style flag.
public
setAuto([bool $value = true ]) : self
Parameters
- $value : bool = true
Return values
self —setIndex()
Set index number.
public
setIndex([null|int $value = null ]) : self
Parameters
- $value : null|int = null
Return values
self —setLevels()
Set multilevel type.
public
setLevels(array<string|int, mixed> $values) : self
Parameters
- $values : array<string|int, mixed>
Return values
self —setNumId()
Set Id.
public
setNumId(int $value) : self
Parameters
- $value : int
Return values
self —setStyleByArray()
Set style by using associative array.
public
setStyleByArray([array<string|int, mixed> $values = [] ]) : self
Parameters
- $values : array<string|int, mixed> = []
Return values
self —setStyleName()
Set style name.
public
setStyleName(string $value) : self
Parameters
- $value : string
Return values
self —setStyleValue()
Set style value template method.
public
setStyleValue(string $key, string $value) : self
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
- $key : string
- $value : string
Return values
self —setType()
Set multilevel type.
public
setType(string $value) : self
Parameters
- $value : string
Return values
self —setBoolVal()
Set bool value.
protected
setBoolVal(bool $value, bool $default) : bool
Parameters
- $value : bool
- $default : bool
Return values
bool —setEnumVal()
Set enum value.
protected
setEnumVal([mixed $value = null ][, array<string|int, mixed> $enum = [] ][, mixed $default = null ]) : mixed
Parameters
- $value : mixed = null
- $enum : array<string|int, mixed> = []
- $default : mixed = null
Return values
mixed —setFloatVal()
Set float value: Convert string that contains only numeric into float.
protected
setFloatVal(mixed $value[, null|float $default = null ]) : null|float
Parameters
- $value : mixed
- $default : null|float = null
Return values
null|float —setIntVal()
Set integer value: Convert string that contains only numeric into integer.
protected
setIntVal(null|int $value[, null|int $default = null ]) : null|int
Parameters
- $value : null|int
- $default : null|int = null
Return values
null|int —setNonEmptyVal()
Set default for null and empty value.
protected
setNonEmptyVal(string $value, string $default) : string
Parameters
- $value : string
-
(was: mixed)
- $default : string
-
(was: mixed)
Return values
string —(was: mixed)
setNumericVal()
Set numeric value.
protected
setNumericVal(mixed $value[, null|float|int $default = null ]) : null|float|int
Parameters
- $value : mixed
- $default : null|float|int = null
Return values
null|float|int —setObjectVal()
Set object value.
protected
setObjectVal(mixed $value, string $styleName, mixed &$style) : mixed
Parameters
- $value : mixed
- $styleName : string
- $style : mixed
Return values
mixed —setPairedVal()
Set $property value and set $pairProperty = false when $value = true.
protected
setPairedVal(bool &$property, bool &$pairProperty, bool $value) : self
Parameters
- $property : bool
- $pairProperty : bool
- $value : bool