setTemplateSymbol

setTemplateSymbol

BASIC / ADVANCED / PREMIUM

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

Description
public setTemplateSymbol (string $templateSymbolStart = $, [string $templateSymbolEnd = null])

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.

The character or symbol used to wrap template variables may be:

  • The same at the beginning and the end (setting only $templateSymbolStart): $VAR$, #VAR#...
  • Different at the beginning and the end: ${VAR}. phpdocx requires using ${ } to wrap placeholders that don't use the same symbol at the beginning and the end, to use other symbols the public static variable CreateDocxFromTemplate::$regExprVariableSymbols must be customized.

Parameters

templateSymbolStart

The character or symbol to be used for identifying placeholder variables within templates. If templateSymbolEnd is null, it uses templateSymbolStart at the beginning and the end of the variable.

templateSymbolEnd

The character or symbol to be used at the end for identifying placeholder variables within templates. If null, it uses templateSymbolStart at the beginning and the end of the variable. If it has a value, it uses templateSymbolStart at the beginning and templateSymbolEnd at the end.

phpdocx requires using ${ } to wrap placeholders that don't use the same symbol at the beginning and the end, to use other symbols the public static variable CreateDocxFromTemplate::$regExprVariableSymbols must be customized.

Code samples

Example #1

The resulting Word document looks like:

Example #2