XML API - pdx:replaceListVariable

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:replaceListVariable

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

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:replaceListVariable pdx:variableName="" pdx:firstMatch="" pdx:parseLineBreaks="" pdx:target="">
        <pdx:data pdx:dataId="" pdx:type="list">
            <pdx:item pdx:wordFragmentName="" pdx:depth="">item text</pdx:item>
            <pdx:item pdx:wordFragmentName="" pdx:depth="">item text</pdx:item>
            <pdx:item pdx:wordFragmentName="" pdx:depth="">item text</pdx:item>
        </pdx:data>
    </pdx:replaceListVariable>
</pdx:templateVariables>

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

variableName

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

options

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

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:template pdx:path="/var/www/phpdocx/samples/files/TemplateList.docx" />
        <pdx:output pdx:name="output" pdx:type="docx" />
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:templateVariables pdx:preprocessedTemplate="">
        <pdx:replaceListVariable pdx:variableName="LISTVAR">
            <pdx:data pdx:dataId="" pdx:type="list">
                <pdx:item>First item</pdx:item>
                <pdx:item>Second item</pdx:item>
                <pdx:item>Third item</pdx:item>
            </pdx:data>
        </pdx:replaceListVariable>
    </pdx:templateVariables>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </pdx:settings>
</pdx:document>

PHP code

require_once 'path_to_phpdocx/classes/CreateDocx.php';

$docx = new XMLAPI('config.xml');
$docx->setDocumentProperties('settings.xml');
$docx->addContent('content.xml');

$docx->render();

The resulting Word document looks like: