XML API - pdx:replaceTableVariable

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:replaceTableVariable

Replaces a group of variables within a set of table rows (text strings or WordFragments).

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:replaceTableVariable pdx:firstMatch="" pdx:parseLineBreaks="" pdx:target="">
        <pdx:data pdx:dataId="" pdx:type="table">
            <pdx:row>
                <pdx:item pdx:variableName="" pdx:wordFragmentName="">item text</pdx:item>
            </pdx:row>
            <pdx:row>
                <pdx:item pdx:variableName="" pdx:wordFragmentName="">item text</pdx:item>
            </pdx:row>
        </pdx:data>
    </pdx:replaceTableVariable>
</pdx:templateVariables>

This element is designed to generate a Word table with an, a priori, indetermined number of rows.

If one includes a set of placeholder variables in a set of rows phpdocx wil clone those rows the required number of times and populate the variables with the provided values.

Attributes and sub-elements

variableName

Template variable name. The keys of the associative array should match the names of the variables that you want to replace by their corresponding values.

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 ocurrence 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/TemplateSimpleTable.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:replaceTableVariable>
            <pdx:data pdx:dataId="" pdx:type="table">
                <pdx:row>
                    <pdx:item pdx:variableName="ITEM" pdx:wordFragmentName="">Product A</pdx:item>
                    <pdx:item pdx:variableName="REFERENCE" pdx:wordFragmentName="">107AW3</pdx:item>
                </pdx:row>
                <pdx:row>
                    <pdx:item pdx:variableName="ITEM" pdx:wordFragmentName="">Product B</pdx:item>
                    <pdx:item pdx:variableName="REFERENCE" pdx:wordFragmentName="">204RS67O</pdx:item>
                </pdx:row>
                <pdx:row>
                    <pdx:item pdx:variableName="ITEM" pdx:wordFragmentName="">Product C</pdx:item>
                    <pdx:item pdx:variableName="REFERENCE" pdx:wordFragmentName="">25GTR56</pdx:item>
                </pdx:row>
            </pdx:data>
        </pdx:replaceTableVariable>
    </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: