Log in
Contact
Forum
replaceListVariable
- addBibliography
- addBookmark
- addBreak
- addChart
- addCitation
- addComment
- addCrossReference
- addDateAndHour
- addEndnote
- addExternalFile
- addFootnote
- addFormElement
- addHeading
- addImage
- addLink
- addList
- addMathEquation
- addMergeField
- addOLE
- addOnlineVideo
- addPageNumber
- addShape
- addSimpleField
- addSource
- addStructuredDocumentTag
- addSVG
- addTab
- addTable
- addTableContents
- addTableFigures
- addText
- addTextBox
- addWordFragment
- addWordML
- embedHTML
- addBackgroundImage
- addFooter
- addFooterSection
- addHeader
- addHeaderSection
- addLineNumbering
- addMacroFromDoc
- addPageBorders
- addProperties
- addSection
- createDocx
- createDocxAndDownload
- createCharacterStyle
- createListStyle
- createParagraphStyle
- createTableStyle
- docxSettings
- embedFont
- importChartStyle
- importHeadersAndFooters
- importListStyle
- importStyles
- importStylesWordDefault
- modifyPageLayout
- parseStyles
- removeFooters
- removeHeaders
- setBackgroundColor
- setDecimalSymbol
- setDefaultFont
- setDocumentDefaultStyles
- setEncodeUTF8
- setLanguage
- setMarkAsFinal
- setRTL
- clearBlocks
- cloneBlock
- deleteBlock
- getTemplateVariables
- getTemplateVariablesType
- modifyInputFields
- modifyMergeFields
- processTemplate
- removeTemplateVariable
- removeTemplateVariableImage
- replaceBlock
- replaceListVariable
- replacePlaceholderImage
- replaceTableVariable
- replaceVariableByExternalFile
- replaceVariableByHtml
- replaceVariableByText
- replaceVariableByWordFragment
- replaceVariableByWordML
- setTemplateSymbol
- setTemplateBlockSymbol
- tickCheckboxes
replaceListVariable
TRIAL / ADVANCED / PREMIUM
Replaces a single variable within a list by a list of items.
This method is designed to generate a Word list with an, a priori, indetermined number of items.
If one includes the placeholder variable as a list item phpdocx will clone that entry the required number of times and populate the resulting items with the values provided by the $listValues array.
variable
The name of the variable that you want to replace by a list of items.
listValues
The array with the values (text strings or WordFragments) you want to use to populate the list.
options
The possible keys and values of this array are:
| Key | Type | Description |
|---|---|---|
| firstMatch | boolean | If the variable appears more than once within the Word document and firstMatch is set to true, phpdocx will only replace the first occurrence of the variable within the Word document. |
| target | string | Possible values are: document (default), header, footer. This option sets the scope of the replacement procedure. |
| parseLineBreaks | boolean | If true (default is false) parses the line breaks to include them in the Word document. |
| type | string | inline (default) or block; used by WordFragment values. |
Example #1
The resulting Word document looks like:
- phpdocx 13.0:
- parseLineBreaks option.
- phpdocx 12.0:
- supported sub-arrays.
- phpdocx 7.0:
- header and footer targets.
- phpdocx 6.5:
- supported WordFragments as values.
- phpdocx 6.0:
- supported literals like '\n' and carriage returns like "\n" with the parseLineBreaks option.