Documentation

NumberingLevel extends AbstractStyle
in package

Numbering level definition.

Tags
see
http://www.schemacentral.com/sc/ooxml/e-w_lvl-1.html
since
0.10.0

Table of Contents

Properties

$aliases  : array<string|int, mixed>
Aliases.
$index  : null|int
Index number in Style collection for named style.
$styleName  : string|null
Style name.
$alignment  : mixed
Justification, w:lvlJc.
$font  : string
Font family.
$format  : string
Numbering format w:numFmt, one of PhpOffice\PhpWord\SimpleType\NumberFormat.
$hanging  : int
Hanging.
$hint  : string
Hint default|eastAsia|cs.
$isAuto  : bool
Is this an automatic style? (Used primarily in OpenDocument driver).
$left  : int
Left.
$level  : int
Level number, 0 to 8 (total 9 levels).
$pStyle  : string
Related paragraph style.
$restart  : int
Restart numbering level symbol w:lvlRestart.
$start  : int
Starting value w:start.
$suffix  : string
Content between numbering symbol and paragraph text w:suff.
$tabPos  : int
Tab position.
$text  : string
Numbering level text e.g. %1 for nonbullet or bullet character.

Methods

getAlignment()  : string
getChildStyleValue()  : mixed
Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.
getFont()  : string
Get font.
getFormat()  : string
Get format.
getHanging()  : int
Get hanging.
getHint()  : string
Get hint.
getIndex()  : null|int
Get index number.
getLeft()  : int
Get left.
getLevel()  : int
Get level.
getPStyle()  : string
Get related paragraph style.
getRestart()  : int
Get restart.
getStart()  : int
Get start.
getStyleName()  : string|null
Get style name.
getSuffix()  : string
Get suffix.
getTabPos()  : int
Get tab.
getText()  : string
Get text.
isAuto()  : bool
Get is automatic style flag.
setAlignment()  : self
setAuto()  : self
Set is automatic style flag.
setFont()  : self
Set font.
setFormat()  : self
Set format.
setHanging()  : self
Set hanging.
setHint()  : self
Set hint.
setIndex()  : self
Set index number.
setLeft()  : self
Set left.
setLevel()  : self
Set level.
setPStyle()  : self
Set related paragraph style.
setRestart()  : self
Set restart.
setStart()  : self
Set start.
setStyleByArray()  : self
Set style by using associative array.
setStyleName()  : self
Set style name.
setStyleValue()  : self
Set style value template method.
setSuffix()  : self
Set suffix.
setTabPos()  : self
Set tab.
setText()  : self
Set text.
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()

$alignment

Justification, w:lvlJc.

private mixed $alignment = ''
Tags
@var

string, one of PhpOffice\PhpWord\SimpleType\Jc

$isAuto

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

private bool $isAuto = false
Tags
since
0.11.0

$level

Level number, 0 to 8 (total 9 levels).

private int $level = 0

Methods

getAlignment()

public getAlignment() : string
Tags
since
0.13.0
Return values
string

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
since
0.12.0

getFont()

Get font.

public getFont() : string
Return values
string

getFormat()

Get format.

public getFormat() : string
Return values
string

getHanging()

Get hanging.

public getHanging() : int
Return values
int

getHint()

Get hint.

public getHint() : string
Return values
string

getIndex()

Get index number.

public getIndex() : null|int
Return values
null|int

getLevel()

Get level.

public getLevel() : int
Return values
int

getPStyle()

Get related paragraph style.

public getPStyle() : string
Return values
string

getRestart()

Get restart.

public getRestart() : int
Return values
int

getStart()

Get start.

public getStart() : int
Return values
int

getStyleName()

Get style name.

public getStyleName() : string|null
Return values
string|null

getSuffix()

Get suffix.

public getSuffix() : string
Return values
string

getTabPos()

Get tab.

public getTabPos() : int
Return values
int

getText()

Get text.

public getText() : string
Return values
string

isAuto()

Get is automatic style flag.

public isAuto() : bool
Return values
bool

setAlignment()

public setAlignment(string $value) : self
Parameters
$value : string
Tags
since
0.13.0
Return values
self

setAuto()

Set is automatic style flag.

public setAuto([bool $value = true ]) : self
Parameters
$value : bool = true
Return values
self

setFont()

Set font.

public setFont(string $value) : self
Parameters
$value : string
Return values
self

setFormat()

Set format.

public setFormat(string $value) : self
Parameters
$value : string
Return values
self

setHanging()

Set hanging.

public setHanging(int $value) : self
Parameters
$value : int
Return values
self

setHint()

Set hint.

public setHint([string $value = null ]) : self
Parameters
$value : string = null
Return values
self

setIndex()

Set index number.

public setIndex([null|int $value = null ]) : self
Parameters
$value : null|int = null
Return values
self

setLeft()

Set left.

public setLeft(int $value) : self
Parameters
$value : int
Return values
self

setLevel()

Set level.

public setLevel(int $value) : self
Parameters
$value : int
Return values
self

setPStyle()

Set related paragraph style.

public setPStyle(string $value) : self
Parameters
$value : string
Return values
self

setRestart()

Set restart.

public setRestart(int $value) : self
Parameters
$value : int
Return values
self

setStart()

Set start.

public setStart(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, array<string|int, mixed>|int|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 : array<string|int, mixed>|int|string
Return values
self

setSuffix()

Set suffix.

public setSuffix(string $value) : self
Parameters
$value : string
Return values
self

setTabPos()

Set tab.

public setTabPos(int $value) : self
Parameters
$value : int
Return values
self

setText()

Set text.

public setText(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

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|float|int|string $value[, null|int $default = null ]) : null|int
Parameters
$value : null|float|int|string
$default : null|int = null
Return values
null|int

setNonEmptyVal()

Set default for null and empty value.

protected setNonEmptyVal(string|null $value, string $default) : string
Parameters
$value : string|null
$default : string
Return values
string

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

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
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results