replaceList

replaceList

PREMIUM TRIAL / ADVANCED

Bulk processing. Replaces a single variable within a list by a list of items.

Description
public replaceList (array $variables, array $options)
Parameters

variables

This is an array that each position sets a DOCX document. In this array, another array set the new contents.

options

The possible keys and values of this array are:

Key Type Description
firstMatch boolean If the variable appears more than once within the Word document and firstMatch is set to true, phpdocx will only replace the first occurrence of the variable within the Word document.
parseLineBreaks boolean If true (default is false) parses the line breaks to include them in the Word document.
target array Possible values are: document, header, footer (all as default).
Code samples

Example #1

Release notes
  • phpdocx 13.0:
    • parseLineBreaks option.
  • phpdocx 12.0:
    • supported sub-arrays.
  • phpdocx 10.0:
    • new method.