XML API - pdx:replaceListVariable


Replaces a single variable within a list by a list of items.


You are reading the XML API documentation. For the API method please go to replaceListVariable.


Element definition

This element 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.

Attributes and sub-elements


The name of the variable that you want to replace by a list of items (text strings or WordFragments).


Key Description
firstMatch 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 Possible values are: document (default), header, footer. This option sets the scope of the replacement procedure.
parseLineBreaks If true (default is false) parses the line breaks to include them in the Word document.
type inline (default) or block; used by WordFragment values.
Code samples

Example #1




PHP code

The resulting Word document looks like: