XmlApi - pdx:replaceVariableByExternalFile

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:replaceVariableByExternalFile

Replaces an array of variables by external files.

Note

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

Description

Element definition

<pdx:templateVariables>                                            
    <pdx:replaceVariableByExternalFile pdx:firstMatch="" pdx:matchSource="">
        <pdx:variable pdx:variableName="" >
            <pdx:data pdx:dataId="" pdx:dataType="text">path to external file</pdx:data>
        </pdx:variable>
    </pdx:replaceVariableByExternalFile>
</pdx:templateVariables>

With the help of this element one may replace a single placeholder variable by a whole external document.

This element accepts the following document formats: DOCX, RTF, HTML and MHT.

This element is not compatible with the phpdocx PDF conversion plugin.

Attributes and sub-elements

variableName

The placeholder variable and the path to the corresponding external document as value.

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.
matchSource	If true (default value) tries to preserve as much as possible the formatting of the inserted document.

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/TemplateExternalFile.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:replaceVariableByExternalFile pdx:matchSource="true">
            <pdx:variable pdx:variableName="EXTERNAL" >
                <pdx:data pdx:dataId="" pdx:dataType="text">/var/www/phpdocx/samples/files/External.docx</pdx:data>
            </pdx:variable>
        </pdx:replaceVariableByExternalFile>
    </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: