XML API - pdx:replaceVariableByText


Replaces placeholder variables by text.


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


Element definition

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


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


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




PHP code

The resulting Word document looks like: