Documentation

ListItem extends AbstractStyle
in package

List item style.

Before version 0.10.0, numbering style is defined statically with $listType. After version 0.10.0, numbering style is defined by using Numbering and recorded by $numStyle. $listStyle is maintained for backward compatility

Table of Contents

Constants

TYPE_ALPHANUM  = 9
TYPE_BULLET_EMPTY  = 5
TYPE_BULLET_FILLED  = 3
TYPE_NUMBER  = 7
TYPE_NUMBER_NESTED  = 8
TYPE_SQUARE_FILLED  = 1

Properties

$aliases  : array<string|int, mixed>
Aliases.
$index  : null|int
Index number in Style collection for named style.
$styleName  : string|null
Style name.
$isAuto  : bool
Is this an automatic style? (Used primarily in OpenDocument driver).
$listType  : int
Legacy list type.
$numId  : int
Numbering definition instance ID.
$numStyle  : string
Numbering style name.

Methods

__construct()  : mixed
Create new instance.
getChildStyleValue()  : mixed
Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.
getIndex()  : null|int
Get index number.
getListType()  : int
Get List Type.
getNumId()  : int
Get numbering Id.
getNumStyle()  : string
Get numbering style name.
getStyleName()  : string|null
Get style name.
isAuto()  : bool
Get is automatic style flag.
setAuto()  : self
Set is automatic style flag.
setIndex()  : self
Set index number.
setListType()  : self
Set legacy list type for version < 0.10.0.
setNumId()  : void
Set numbering Id. Same numId means same list.
setNumStyle()  : self
Set numbering style name.
setStyleByArray()  : self
Set style by using associative array.
setStyleName()  : self
Set style name.
setStyleValue()  : self
Set style value template method.
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.
getListTypeStyle()  : array<string|int, mixed>
Get legacy numbering definition.

Constants

TYPE_ALPHANUM

public mixed TYPE_ALPHANUM = 9

TYPE_BULLET_EMPTY

public mixed TYPE_BULLET_EMPTY = 5

TYPE_BULLET_FILLED

public mixed TYPE_BULLET_FILLED = 3

TYPE_NUMBER

public mixed TYPE_NUMBER = 7

TYPE_NUMBER_NESTED

public mixed TYPE_NUMBER_NESTED = 8

TYPE_SQUARE_FILLED

public mixed TYPE_SQUARE_FILLED = 1

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()

$isAuto

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

private bool $isAuto = false
Tags
since
0.11.0

$listType

Legacy list type.

private int $listType

$numId

Numbering definition instance ID.

private int $numId
Tags
since
0.10.0

$numStyle

Numbering style name.

private string $numStyle
Tags
since
0.10.0

Methods

__construct()

Create new instance.

public __construct([string $numStyle = null ]) : mixed
Parameters
$numStyle : string = null

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

getIndex()

Get index number.

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

getListType()

Get List Type.

public getListType() : int
Return values
int

getNumId()

Get numbering Id.

public getNumId() : int
Return values
int

getNumStyle()

Get numbering style name.

public getNumStyle() : string
Return values
string

getStyleName()

Get style name.

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

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

setListType()

Set legacy list type for version < 0.10.0.

public setListType([int $value = self::TYPE_BULLET_FILLED ]) : self
Parameters
$value : int = self::TYPE_BULLET_FILLED
Return values
self

setNumId()

Set numbering Id. Same numId means same list.

public setNumId(mixed $numInt) : void
Parameters
$numInt : mixed

setNumStyle()

Set numbering style name.

public setNumStyle(string $value) : self
Parameters
$value : string
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

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

getListTypeStyle()

Get legacy numbering definition.

private getListTypeStyle() : array<string|int, mixed>
Tags
since
0.10.0
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results