Documentation

ListItemRun extends TextRun
in package

Application

List item element.

Properties

$collectionRelation : bool: Is part of collection; true for Title, Footnote, Endnote, Chart, and Comment.
$commentsRangeEnd : Comments: The end position for the linked comments.
$commentsRangeStart : Comments: The start position for the linked comments.
$container : string: Container type Section|Header|Footer|Footnote|Endnote|Cell|TextRun|TextBox|ListItemRun|TrackChange.
$docPart : string: Document part type: Section|Header|Footer|Footnote|Endnote.
$docPartId : int: Document part Id.
$elementId : string: Unique Id for element.
$elementIndex : int: Index of element in the elements collection (start with 1).
$elements : array<string|int, AbstractElement>: Elements collection.
$mediaRelation : bool: Has media relation flag; true for Link, Image, and Object.
$paragraphStyle : Paragraph|string: Paragraph style.
$phpWord : PhpWord|null: PhpWord object.
$relationId : int: Relation Id.
$sectionId : int: Section Id.
$depth : int: ListItem Depth.
$nestedLevel : int: Depth of table container nested level; Primarily used for RTF writer/reader.
$parent : null|AbstractElement: A reference to the parent.
$parentContainer : string: Parent container type.
$style : ListItem|null: ListItem Style.
$trackChange : TrackChange: changed element info.

Methods

__call() : AbstractElement: Magic method to catch all 'addElement' variation.
__construct() : mixed: Create a new ListItem.
addBookmark() : Bookmark
addChart() : Chart
addCheckBox() : CheckBox
addEndnote() : Endnote
addField() : Field
addFootnote() : Footnote
addFormField() : FormField
addFormula() : Formula
addImage() : Image
addLine() : Line
addLink() : Link
addListItem() : ListItem
addListItemRun() : ListItemRun
addObject() : OLEObject
addOLEObject() : OLEObject
addPageBreak() : PageBreak
addPreserveText() : PreserveText
addRuby() : Ruby
addSDT() : SDT
addShape() : Shape
addTable() : Table
addText() : Text
addTextBox() : TextBox
addTextBreak() : void
addTextRun() : TextRun
addTitle() : Title
addTOC() : TOC
countElements() : int: Count elements.
getCommentRangeEnd() : Comment|null: Get comment end.
getCommentRangeStart() : Comment|null: Get comment start.
getCommentsRangeEnd() : Comments|null: Get comments end.
getCommentsRangeStart() : Comments|null: Get comments start.
getDepth() : int: Get ListItem depth.
getDocPart() : string: Get doc part.
getDocPartId() : int: Get doc part Id.
getElement() : null|AbstractElement: Returns the element at the requested position.
getElementId() : string: Get element unique ID.
getElementIndex() : int: Get element index.
getElements() : array<string|int, AbstractElement>: Get all elements.
getNestedLevel() : int: Get nested level.
getParagraphStyle() : Paragraph|string: Get Paragraph style.
getParent() : null|AbstractElement: Get parent element.
getPhpWord() : PhpWord|null: Get PhpWord.
getRelationId() : int: Get relation Id.
getSectionId() : int: Get section number.
getStyle() : ListItem|null: Get ListItem style.
getText() : string
getTrackChange() : TrackChange: Gets the trackChange information.
isInSection() : bool: Check if element is located in Section doc part (as opposed to Header/Footer).
removeElement() : void: Removes the element at requested index.
setChangeInfo() : void: Set changed.
setCommentRangeEnd() : void: Set comment end.
setCommentRangeStart() : void: Set comment start.
setDocPart() : void: Set doc part.
setElementId() : void: Set element unique ID from 6 first digit of md5.
setElementIndex() : void: Set element index.
setParagraphStyle() : Paragraph|string: Set Paragraph style.
setParentContainer() : void: Set parent container.
setPhpWord() : void: Set PhpWord as reference.
setRelationId() : void: Set relation Id.
setTrackChange() : void: Sets the trackChange information.
addElement() : AbstractElement: Add element.
setEnumVal() : null|string: Set enum value.
setNewStyle() : mixed: Set new style value.
checkValidity() : bool: Check if a method is allowed for the current container.
getMediaPart() : string: Return media element (image, object, link) container name.
setCollectionRelation() : void: Set relation Id for elements that will be registered in the Collection subnamespaces.
setMediaRelation() : void: Set relation Id for media elements (link, image, object; legacy of OOXML).

$collectionRelation

Is part of collection; true for Title, Footnote, Endnote, Chart, and Comment.


    protected
        bool
    $collectionRelation
     = false

$commentsRangeEnd

The end position for the linked comments.


    protected
        Comments
    $commentsRangeEnd

$commentsRangeStart

The start position for the linked comments.


    protected
        Comments
    $commentsRangeStart

$container


    protected
        string
    $container
     = 'ListItemRun'

Container type

$docPart

Document part type: Section|Header|Footer|Footnote|Endnote.


    protected
        string
    $docPart
     = 'Section'

Used by textrun and cell container to determine where the element is located because it will affect the availability of other element, e.g. footnote will not be available when $docPart is header or footer.

$docPartId

Document part Id.


    protected
        int
    $docPartId
     = 1

For header and footer, this will be = ($sectionId - 1) * 3 + $index because the max number of header/footer in every page is 3, i.e. AUTO, FIRST, and EVEN (AUTO = ODD)

$elementId

Unique Id for element.


    protected
        string
    $elementId

$elementIndex

Index of element in the elements collection (start with 1).


    protected
        int
    $elementIndex
     = 1

$elements

Elements collection.


    protected
        array<string|int, AbstractElement>
    $elements
     = []

$mediaRelation

Has media relation flag; true for Link, Image, and Object.


    protected
        bool
    $mediaRelation
     = false

$paragraphStyle

Paragraph style.


    protected
        Paragraph|string
    $paragraphStyle

$phpWord

PhpWord object.


    protected
        PhpWord|null
    $phpWord

$relationId

Relation Id.


    protected
        int
    $relationId

$sectionId

Section Id.


    protected
        int
    $sectionId

$depth

ListItem Depth.


    private
        int
    $depth

$nestedLevel

Depth of table container nested level; Primarily used for RTF writer/reader.


    private
        int
    $nestedLevel
     = 0

0 = Not in a table; 1 = in a table; 2 = in a table inside another table, etc.

$parent

A reference to the parent.


    private
        null|AbstractElement
    $parent

$parentContainer

Parent container type.


    private
        string
    $parentContainer

$style

ListItem Style.


    private
        ListItem|null
    $style

$trackChange

changed element info.


    private
        TrackChange
    $trackChange

__call()

Magic method to catch all 'addElement' variation.


    public
                    __call(mixed $function, mixed $args) : AbstractElement

This removes addText, addTextRun, etc. When adding new element, we have to add the model in the class docblock with @method.

Warning: This makes capitalization matters, e.g. addCheckbox or addcheckbox won't work.

Parameters

$function : mixed
$args : mixed

Return values

AbstractElement

__construct()

Create a new ListItem.


    public
                    __construct([int $depth = 0 ][, null|array<string|int, mixed>|string $listStyle = null ][, mixed $paragraphStyle = null ]) : mixed

Parameters

$depth : int = 0
$listStyle : null|array<string|int, mixed>|string = null
$paragraphStyle : mixed = null

addBookmark()


    public
                    addBookmark(string $name) : Bookmark

Parameters

$name : string

Return values

Bookmark

addChart()


    public
                    addChart(string $type, array<string|int, mixed> $categories, array<string|int, mixed> $values[, array<string|int, mixed> $style =  = 'null' ][, mixed $seriesName =  = 'null' ]) : Chart

Parameters

$type : string
$categories : array<string|int, mixed>
$values : array<string|int, mixed>
$style : array<string|int, mixed> = = 'null'
$seriesName : mixed = = 'null'

Return values

Chart

addCheckBox()


    public
                    addCheckBox(string $name, mixed $text[, mixed $fStyle =  = 'null' ][, mixed $pStyle =  = 'null' ]) : CheckBox

Parameters

$name : string
$text : mixed
$fStyle : mixed = = 'null'
$pStyle : mixed = = 'null'

Return values

CheckBox

addEndnote()


    public
                    addEndnote([mixed $pStyle =  = 'null' ]) : Endnote

Parameters

$pStyle : mixed = = 'null'

Return values

Endnote

addField()


    public
                    addField([string $type =  = 'null' ][, array<string|int, mixed> $properties =  = '[]' ][, array<string|int, mixed> $options =  = '[]' ][, mixed $text =  = 'null' ]) : Field

Parameters

$type : string = = 'null'
$properties : array<string|int, mixed> = = '[]'
$options : array<string|int, mixed> = = '[]'
$text : mixed = = 'null'

Return values

Field

addFootnote()


    public
                    addFootnote([mixed $pStyle =  = 'null' ]) : Footnote

Parameters

$pStyle : mixed = = 'null'

Return values

Footnote

addFormField()


    public
                    addFormField(string $type[, mixed $fStyle =  = 'null' ][, mixed $pStyle =  = 'null' ]) : FormField

Parameters

$type : string
$fStyle : mixed = = 'null'
$pStyle : mixed = = 'null'

Return values

FormField

addFormula()


    public
                    addFormula(Math $math) : Formula

Parameters

$math : Math

Return values

Formula

addImage()


    public
                    addImage(string $source[, mixed $style =  = 'null' ][, bool $isWatermark =  = 'false' ][, mixed $name =  = 'null' ]) : Image

Parameters

$source : string
$style : mixed = = 'null'
$isWatermark : bool = = 'false'
$name : mixed = = 'null'

Return values

Image

addLine()


    public
                    addLine([mixed $lineStyle =  = 'null' ]) : Line

Parameters

$lineStyle : mixed = = 'null'

Return values

Line

addLink()


    public
                    addLink(string $target[, string $text =  = 'null' ][, mixed $fStyle =  = 'null' ][, mixed $pStyle =  = 'null' ][, bool $internal =  = 'false' ]) : Link

Parameters

$target : string
$text : string = = 'null'
$fStyle : mixed = = 'null'
$pStyle : mixed = = 'null'
$internal : bool = = 'false'

Return values

Link

addListItem()


    public
                    addListItem(string $txt[, int $depth =  = '0' ][, mixed $font =  = 'null' ][, mixed $list =  = 'null' ][, mixed $para =  = 'null' ]) : ListItem

Parameters

$txt : string
$depth : int = = '0'
$font : mixed = = 'null'
$list : mixed = = 'null'
$para : mixed = = 'null'

Return values

ListItem

addListItemRun()


    public
                    addListItemRun([int $depth =  = '0' ][, mixed $listStyle =  = 'null' ][, mixed $pStyle =  = 'null' ]) : ListItemRun

Parameters

$depth : int = = '0'
$listStyle : mixed = = 'null'
$pStyle : mixed = = 'null'

Return values

ListItemRun

addObject()


    public
                    addObject(string $source[, mixed $style =  = 'null' ]) : OLEObject

deprecated, use addOLEObject instead

Parameters

$source : string
$style : mixed = = 'null'

Return values

OLEObject

addOLEObject()


    public
                    addOLEObject(string $source[, mixed $style =  = 'null' ]) : OLEObject

Parameters

$source : string
$style : mixed = = 'null'

Return values

OLEObject

addPageBreak()


    public
                    addPageBreak() : PageBreak

Return values

PageBreak

addPreserveText()


    public
                    addPreserveText(string $text[, mixed $fStyle =  = 'null' ][, mixed $pStyle =  = 'null' ]) : PreserveText

Parameters

$text : string
$fStyle : mixed = = 'null'
$pStyle : mixed = = 'null'

Return values

PreserveText

addRuby()


    public
                    addRuby(TextRun $baseText, TextRun $rubyText, RubyProperties $properties) : Ruby

Parameters

$baseText : TextRun
$rubyText : TextRun
$properties : RubyProperties

Return values

Ruby

addSDT()


    public
                    addSDT(string $type) : SDT

Parameters

$type : string

Return values

SDT

addShape()


    public
                    addShape(string $type[, mixed $style =  = 'null' ]) : Shape

Parameters

$type : string
$style : mixed = = 'null'

Return values

Shape

addTable()


    public
                    addTable([mixed $style =  = 'null' ]) : Table

Parameters

$style : mixed = = 'null'

Return values

Table

addText()


    public
                    addText(string $text[, mixed $fStyle =  = 'null' ][, mixed $pStyle =  = 'null' ]) : Text

Parameters

$text : string
$fStyle : mixed = = 'null'
$pStyle : mixed = = 'null'

Return values

Text

addTextBox()


    public
                    addTextBox([mixed $style =  = 'null' ]) : TextBox

Parameters

$style : mixed = = 'null'

Return values

TextBox

addTextBreak()


    public
                    addTextBreak([int $count =  = '1' ][, mixed $fStyle =  = 'null' ][, mixed $pStyle =  = 'null' ]) : void

Parameters

$count : int = = '1'
$fStyle : mixed = = 'null'
$pStyle : mixed = = 'null'

addTextRun()


    public
                    addTextRun([mixed $pStyle =  = 'null' ]) : TextRun

Parameters

$pStyle : mixed = = 'null'

Return values

TextRun

addTitle()


    public
                    addTitle(mixed $text[, int $depth =  = '1' ][, int $pageNumber =  = 'null' ]) : Title

Parameters

$text : mixed
$depth : int = = '1'
$pageNumber : int = = 'null'

Return values

Title

addTOC()


    public
                    addTOC([mixed $fontStyle =  = 'null' ][, mixed $tocStyle =  = 'null' ][, int $minDepth =  = '1' ][, int $maxDepth =  = '9' ]) : TOC

Parameters

$fontStyle : mixed = = 'null'
$tocStyle : mixed = = 'null'
$minDepth : int = = '1'
$maxDepth : int = = '9'

Return values

TOC

countElements()

Count elements.


    public
                    countElements() : int

Return values

int

getCommentRangeEnd()

Get comment end.


    public
                    getCommentRangeEnd() : Comment|null

Return values

Comment|null

getCommentRangeStart()

Get comment start.


    public
                    getCommentRangeStart() : Comment|null

Return values

Comment|null

getCommentsRangeEnd()

Get comments end.


    public
                    getCommentsRangeEnd() : Comments|null

Return values

Comments|null

getCommentsRangeStart()

Get comments start.


    public
                    getCommentsRangeStart() : Comments|null

Return values

Comments|null

getDepth()

Get ListItem depth.


    public
                    getDepth() : int

Return values

int

getDocPart()

Get doc part.


    public
                    getDocPart() : string

Return values

string

getDocPartId()

Get doc part Id.


    public
                    getDocPartId() : int

Return values

int

getElement()

Returns the element at the requested position.


    public
                    getElement(int $index) : null|AbstractElement

Parameters

$index : int

Return values

null|AbstractElement

getElementId()

Get element unique ID.


    public
                    getElementId() : string

Return values

string

getElementIndex()

Get element index.


    public
                    getElementIndex() : int

Return values

int

getElements()

Get all elements.


    public
                    getElements() : array<string|int, AbstractElement>

Return values

array<string|int, AbstractElement>

getNestedLevel()

Get nested level.


    public
                    getNestedLevel() : int

Return values

int

getParagraphStyle()

Get Paragraph style.


    public
                    getParagraphStyle() : Paragraph|string

Return values

Paragraph|string

getParent()

Get parent element.


    public
                    getParent() : null|AbstractElement

Return values

null|AbstractElement

getPhpWord()

Get PhpWord.


    public
                    getPhpWord() : PhpWord|null

Return values

PhpWord|null

getRelationId()

Get relation Id.


    public
                    getRelationId() : int

Return values

int

getSectionId()

Get section number.


    public
                    getSectionId() : int

Return values

int

getStyle()

Get ListItem style.


    public
                    getStyle() : ListItem|null

Return values

ListItem|null

getText()


    public
                    getText() : string

Return values

string

getTrackChange()

Gets the trackChange information.


    public
                    getTrackChange() : TrackChange

Return values

TrackChange

isInSection()

Check if element is located in Section doc part (as opposed to Header/Footer).


    public
                    isInSection() : bool

Return values

bool

removeElement()

Removes the element at requested index.


    public
                    removeElement(AbstractElement|int $toRemove) : void

Parameters

$toRemove : AbstractElement|int

setChangeInfo()

Set changed.


    public
                    setChangeInfo(string $type, string $author[, null|DateTime|int $date = null ]) : void

Parameters

$type : string: INSERTED|DELETED
$author : string
$date : null|DateTime|int = null: allways in UTC

setCommentRangeEnd()

Set comment end.


    public
                    setCommentRangeEnd(Comment $value) : void

Parameters

$value : Comment

setCommentRangeStart()

Set comment start.


    public
                    setCommentRangeStart(Comment $value) : void

Parameters

$value : Comment

setDocPart()

Set doc part.


    public
                    setDocPart(string $docPart[, int $docPartId = 1 ]) : void

Parameters

$docPart : string
$docPartId : int = 1

setElementId()

Set element unique ID from 6 first digit of md5.


    public
                    setElementId() : void

setElementIndex()

Set element index.


    public
                    setElementIndex(int $value) : void

Parameters

$value : int

setParagraphStyle()

Set Paragraph style.


    public
                    setParagraphStyle([array<string|int, mixed>|Paragraph|string $style = null ]) : Paragraph|string

Parameters

$style : array<string|int, mixed>|Paragraph|string = null

Return values

Paragraph|string

setParentContainer()

Set parent container.


    public
                    setParentContainer(self $container) : void

Passed parameter should be a container, except for Table (contain Row) and Row (contain Cell)

Parameters

$container : self

setPhpWord()

Set PhpWord as reference.


    public
                    setPhpWord([PhpWord|null $phpWord = null ]) : void

Parameters

$phpWord : PhpWord|null = null

setRelationId()

Set relation Id.


    public
                    setRelationId(int $value) : void

Parameters

$value : int

setTrackChange()

Sets the trackChange information.


    public
                    setTrackChange(TrackChange $trackChange) : void

Parameters

$trackChange : TrackChange

addElement()

Add element.


    protected
                    addElement(string $elementName) : AbstractElement

Each element has different number of parameters passed

Parameters

$elementName : string

Return values

AbstractElement

setEnumVal()

Set enum value.


    protected
                    setEnumVal([null|string $value = null ][, array<string|int, string> $enum = [] ][, null|string $default = null ]) : null|string

Parameters

$value : null|string = null
$enum : array<string|int, string> = []
$default : null|string = null

Return values

null|string

setNewStyle()

Set new style value.


    protected
                    setNewStyle(mixed $styleObject[, null|array<string|int, mixed>|string|Style $styleValue = null ][, bool $returnObject = false ]) : mixed

Parameters

$styleObject : mixed: Style object
$styleValue : null|array<string|int, mixed>|string|Style = null: Style value
$returnObject : bool = false: Always return object

checkValidity()

Check if a method is allowed for the current container.


    private
                    checkValidity(string $method) : bool

Parameters

$method : string

Return values

bool

getMediaPart()

Return media element (image, object, link) container name.


    private
                    getMediaPart() : string

Return values

string —

section|headerx|footerx|footnote|endnote

setCollectionRelation()

Set relation Id for elements that will be registered in the Collection subnamespaces.


    private
                    setCollectionRelation() : void

setMediaRelation()

Set relation Id for media elements (link, image, object; legacy of OOXML).


    private
                    setMediaRelation() : void

Image element needs to be passed to Media object
Icon needs to be set for Object element

ListItemRun extends TextRun in package Application

Table of Contents

Properties

Methods

Properties

$collectionRelation

$commentsRangeEnd

$commentsRangeStart

$container

$docPart

$docPartId

$elementId

$elementIndex

$elements

$mediaRelation

$paragraphStyle

$phpWord

$relationId

$sectionId

$depth

$nestedLevel

$parent

$parentContainer

$style

$trackChange

Methods

__call()

Parameters

Return values

__construct()

Parameters

addBookmark()

Parameters

Return values

addChart()

Parameters

Return values

addCheckBox()

Parameters

Return values

addEndnote()

Parameters

Return values

addField()

Parameters

Return values

addFootnote()

Parameters

Return values

addFormField()

Parameters

Return values

addFormula()

Parameters

Return values

addImage()

Parameters

Return values

addLine()

Parameters

Return values

addLink()

Parameters

Return values

addListItem()

Parameters

Return values

addListItemRun()

Parameters

Return values

addObject()

Parameters

Return values

addOLEObject()

Parameters

Return values

addPageBreak()

Return values

addPreserveText()

Parameters

ListItemRun extends TextRun
in package

Application