XML API - pdx:replaceVariableByText

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:replaceVariableByText

Replaces placeholder variables by text.

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:replaceVariableByText pdx:target="" pdx:firstMatch="" pdx:parseLineBreaks="" pdx:raw="">
        <pdx:variable pdx:variableName="" >
            <pdx:data pdx:dataId="" pdx:dataType="text">text</pdx:data>
        </pdx:variable>
        <pdx:variable pdx:variableName="" >
            <pdx:data pdx:dataId="" pdx:dataType="text">text</pdx:data>
        </pdx:variable>
    </pdx:replaceVariableByText>
</pdx:templateVariables>

This element is designed to replace a set of placeholder variables by plain text.

Remember that the phpdocx template variables should be surrounded by $ symbols or whatever symbol you have chosen via the setTemplateSymbol element.

Attributes and sub-elements

variableName

The template variable name to be replaced by the text content.

options

The possible keys and values of this array are:

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.
parseLineBreaks	If true (default is false) parses the line breaks to include them in the Word document.
target	Possible values are: document (default), header, footer, footnote, endnote, comment. This option sets the scope of the replacement procedure.
raw	If true (default is false) replaces the variable by a string regardless the variable scope (tag values, attributes...). Only allows to replace a variable by a plain string. Use with caution.

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/TemplateSimpleText.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:replaceVariableByText pdx:parseLineBreaks="true">
            <pdx:variable pdx:variableName="FIRSTTEXT" >
                <pdx:data pdx:dataId="" pdx:dataType="text">phpdocx</pdx:data>
            </pdx:variable>
            <pdx:variable pdx:variableName="MULTILINETEXT" >
                <pdx:data pdx:dataId="" pdx:dataType="text">This is the first line.\nThis is the second line of text.</pdx:data>
            </pdx:variable>
        </pdx:replaceVariableByText>
    </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: