XML API - pdx:replaceVariableByWordML

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:replaceVariableByWordML

Replaces placeholder variables by plain WordML code.

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:replaceVariableByWordML pdx:type="inline|block" pdx:target="" pdx:firstMatch="">
        <pdx:variable pdx:name="">
            <pdx:data pdx:dataId="" pdx:dataType="text"><![CDATA[WordML code]]></pdx:data>
        </pdx:variable>
        <pdx:variable pdx:name="">
            <pdx:data pdx:dataId="" pdx:dataType="text"><![CDATA[WordML code]]></pdx:data>
        </pdx:variable>
    </pdx:replaceVariableByWordML>
</pdx:templateVariables>

This element (avalaible for the seasoned phpdocx user) allows the direct substitution of placeholder variables by WordML code.

Only use this element if you really understand the OOXML standard. phpdocx does not validate the WordML against any scheme so you have to make sure by your own that the WordML is correctly encoded. Moreover, this element does not take care by its own of internal/external relationships included in the WordML code.

Attributes and sub-elements

variable

The names of the placeholder template variables and the WordFragment instances that should replace them as 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. This option sets the scope of the replacement procedure.
replaceType	Possible values are: block (default): replaces the variable and removes its containing paragraph. inline: only replaces the variable by the WordFragment inline content (it may be used to replace a variable by formatted text).

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/TemplateWordML.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:replaceVariableByWordML>
            <pdx:variable pdx:name="WORDML">
                <pdx:data pdx:dataId="" pdx:dataType="text">
                    <![CDATA[<w:p><w:r><w:t xml:space="preserve">This is a simple paragraph with some </w:t></w:r><w:r><w:rPr><w:b/></w:rPr><w:t>bold</w:t></w:r><w:r><w:t xml:space="preserve"> text.</w:t></w:r></w:p>]]>
                </pdx:data>
            </pdx:variable>
        </pdx:replaceVariableByWordML>
    </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: