XmlApi - pdx:setTemplateSymbol

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:setTemplateSymbol

Sets the character used to identify placeholder variables within a given template.

Note

You are reading the XMLAPI documentation. For the API method please go to setTemplateSymbol.

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:setTemplateSymbol pdx:symbolValue="" />
</pdx:templateVariables>

By default the phpdocx template variables have to be wrapped by dollar symbols ($).

You can change that symbol by any other you wish with the help of this method. It is, of course, convenient to use a symbol reasonably distinguishable from standard text characters.

Make sure that all variables in your template are surrounded by the symbol you have chosen.

Attributes and sub-elements

symbolValue

The symbol you want to use for identifying placeholder variables within templates.

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/TemplatePipeSymbol.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:setTemplateSymbol pdx:symbolValue="|" />
        <pdx:replaceVariableByText pdx:parseLineBreaks="true">
            <pdx:variable pdx:variableName="FIRST" >
                <pdx:data pdx:dataId="" pdx:dataType="text">Hello World!</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: