Footnote extends AbstractContainer
Container abstract class.
Table of Contents
- $collectionRelation : bool
- Is part of collection.
- $commentRangeEnd : Comment
- The end position for the linked comment.
- $commentRangeStart : Comment
- The start position for the linked comment.
- $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
- PhpWord object.
- $relationId : int
- Relation Id.
- $sectionId : int
- Section Id.
- $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.
- $trackChange : TrackChange
- changed element info.
- __call() : AbstractElement
- Magic method to catch all 'addElement' variation.
- __construct() : mixed
- Create new instance.
- addBookmark() :
- addChart() :
- addCheckBox() :
- addEndnote() :
- addField() :
- addFootnote() :
- addFormField() :
- addImage() :
- addLine() :
- addLink() :
- addListItem() :
- addListItemRun() :
- addObject() :
- addOLEObject() :
- addPageBreak() :
- addPreserveText() :
- addSDT() :
- addShape() :
- addTable() :
- addText() :
- addTextBox() :
- addTextBreak() :
- addTextRun() :
- addTitle() :
- addTOC() :
- countElements() : int
- Count elements.
- getCommentRangeEnd() : Comment
- Get comment end.
- getCommentRangeStart() : Comment
- Get comment start.
- 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
- Get PhpWord.
- getRelationId() : int
- Get relation Id.
- getSectionId() : int
- Get section number.
- 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.
- 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).
Properties
$collectionRelation
Is part of collection.
protected
bool
$collectionRelation
= true
$commentRangeEnd
The end position for the linked comment.
protected
Comment
$commentRangeEnd
$commentRangeStart
The start position for the linked comment.
protected
Comment
$commentRangeStart
$container
Container type Section|Header|Footer|Footnote|Endnote|Cell|TextRun|TextBox|ListItemRun|TrackChange.
protected
string
$container
= 'Footnote'
$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
$phpWord
$relationId
Relation Id.
protected
int
$relationId
$sectionId
Section Id.
protected
int
$sectionId
$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
$trackChange
changed element info.
private
TrackChange
$trackChange
Methods
__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 new instance.
public
__construct([array<string|int, mixed>|Paragraph|string $paragraphStyle = null ]) : mixed
Parameters
- $paragraphStyle : array<string|int, mixed>|Paragraph|string = null
Return values
mixed —addBookmark()
public
addBookmark(string $name) :
Parameters
- $name : string
Return values
—addChart()
public
addChart(string $type, array<string|int, mixed> $categories, array<string|int, mixed> $values, array<string|int, mixed> $style = null, mixed $seriesName) :
Parameters
- $type : string
- $categories : array<string|int, mixed>
- $values : array<string|int, mixed>
- $style = null : array<string|int, mixed>
- $seriesName : mixed
Return values
—addCheckBox()
public
addCheckBox(string $name, mixed $text, mixed $fStyle = null, mixed $pStyle = null) :
Parameters
- $name : string
- $text : mixed
- $fStyle = null : mixed
- $pStyle = null : mixed
Return values
—addEndnote()
public
addEndnote(mixed $pStyle = null) :
Parameters
- $pStyle = null : mixed
Return values
—addField()
public
addField(string $type = null, array<string|int, mixed> $properties = array() :
, array $options = array(), mixed $text = null)
Parameters
- $type = null : string
- $properties = array( : array<string|int, mixed>
Return values
—addFootnote()
public
addFootnote(mixed $pStyle = null) :
Parameters
- $pStyle = null : mixed
Return values
—addFormField()
public
addFormField(string $type, mixed $fStyle = null, mixed $pStyle = null) :
Parameters
- $type : string
- $fStyle = null : mixed
- $pStyle = null : mixed
Return values
—addImage()
public
addImage(string $source, mixed $style = null, bool $isWatermark = false, mixed $name) :
Parameters
- $source : string
- $style = null : mixed
- $isWatermark = false : bool
- $name : mixed
Return values
—addLine()
public
addLine(mixed $lineStyle = null) :
Parameters
- $lineStyle = null : mixed
Return values
—addLink()
public
addLink(string $target, string $text = null, mixed $fStyle = null, mixed $pStyle = null, bool $internal = false) :
Parameters
- $target : string
- $text = null : string
- $fStyle = null : mixed
- $pStyle = null : mixed
- $internal = false : bool
Return values
—addListItem()
public
addListItem(string $txt, int $depth = 0, mixed $font = null, mixed $list = null, mixed $para = null) :
Parameters
- $txt : string
- $depth = 0 : int
- $font = null : mixed
- $list = null : mixed
- $para = null : mixed
Return values
—addListItemRun()
public
addListItemRun(int $depth = 0, mixed $listStyle = null, mixed $pStyle = null) :
Parameters
- $depth = 0 : int
- $listStyle = null : mixed
- $pStyle = null : mixed
Return values
—addObject()
public
addObject(string $source, mixed $style = null) :
deprecated, use addOLEObject instead
Parameters
- $source : string
- $style = null : mixed
Return values
—addOLEObject()
public
addOLEObject(string $source, mixed $style = null) :
Parameters
- $source : string
- $style = null : mixed
Return values
—addPageBreak()
public
addPageBreak() :
Return values
—addPreserveText()
public
addPreserveText(string $text, mixed $fStyle = null, mixed $pStyle = null) :
Parameters
- $text : string
- $fStyle = null : mixed
- $pStyle = null : mixed
Return values
—addSDT()
public
addSDT(string $type) :
Parameters
- $type : string
Return values
—addShape()
public
addShape(string $type, mixed $style = null) :
Parameters
- $type : string
- $style = null : mixed
Return values
—addTable()
public
addTable(mixed $style = null) :
Parameters
- $style = null : mixed
Return values
—addText()
public
addText(string $text, mixed $fStyle = null, mixed $pStyle = null) :
Parameters
- $text : string
- $fStyle = null : mixed
- $pStyle = null : mixed
Return values
—addTextBox()
public
addTextBox(mixed $style = null) :
Parameters
- $style = null : mixed
Return values
—addTextBreak()
public
addTextBreak(int $count = 1, mixed $fStyle = null, mixed $pStyle = null) :
Parameters
- $count = 1 : int
- $fStyle = null : mixed
- $pStyle = null : mixed
Return values
—addTextRun()
public
addTextRun(mixed $pStyle = null) :
Parameters
- $pStyle = null : mixed
Return values
—addTitle()
public
addTitle(mixed $text, int $depth = 1) :
Parameters
- $text : mixed
- $depth = 1 : int
Return values
—addTOC()
public
addTOC(mixed $fontStyle = null, mixed $tocStyle = null, int $minDepth = 1, int $maxDepth = 9) :
Parameters
- $fontStyle = null : mixed
- $tocStyle = null : mixed
- $minDepth = 1 : int
- $maxDepth = 9 : int
Return values
—countElements()
Count elements.
public
countElements() : int
Return values
int —getCommentRangeEnd()
Get comment end.
public
getCommentRangeEnd() : Comment
Return values
Comment —getCommentRangeStart()
Get comment start.
public
getCommentRangeStart() : Comment
Return values
Comment —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
Return values
PhpWord —getRelationId()
Get relation Id.
public
getRelationId() : int
Return values
int —getSectionId()
Get section number.
public
getSectionId() : int
Return values
int —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(int|AbstractElement $toRemove) : void
Parameters
- $toRemove : int|AbstractElement
Return values
void —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
Return values
void —setCommentRangeEnd()
Set comment end.
public
setCommentRangeEnd(Comment $value) : void
Parameters
- $value : Comment
Return values
void —setCommentRangeStart()
Set comment start.
public
setCommentRangeStart(Comment $value) : void
Parameters
- $value : Comment
Return values
void —setDocPart()
Set doc part.
public
setDocPart(string $docPart[, int $docPartId = 1 ]) : void
Parameters
- $docPart : string
- $docPartId : int = 1
Return values
void —setElementId()
Set element unique ID from 6 first digit of md5.
public
setElementId() : void
Return values
void —setElementIndex()
Set element index.
public
setElementIndex(int $value) : void
Parameters
- $value : int
Return values
void —setParentContainer()
Set parent container.
public
setParentContainer(AbstractElement $container) : void
Passed parameter should be a container, except for Table (contain Row) and Row (contain Cell)
Parameters
- $container : AbstractElement
Return values
void —setPhpWord()
Set PhpWord as reference.
public
setPhpWord([PhpWord $phpWord = null ]) : void
Parameters
- $phpWord : PhpWord = null
Return values
void —setRelationId()
Set relation Id.
public
setRelationId(int $value) : void
Parameters
- $value : int
Return values
void —setTrackChange()
Sets the trackChange information.
public
setTrackChange(TrackChange $trackChange) : void
Parameters
- $trackChange : TrackChange
Return values
void —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
Tags
Return values
null|string —setNewStyle()
Set new style value.
protected
setNewStyle(mixed $styleObject[, mixed $styleValue = null ][, bool $returnObject = false ]) : mixed
Parameters
- $styleObject : mixed
-
Style object
- $styleValue : mixed = null
-
Style value
- $returnObject : bool = false
-
Always return object
Return values
mixed —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
Return values
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