replaceList

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

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

require_once 'classes/CreateDocx.php';

$bulk = new BulkProcessing('template.docx');

// replace list placeholders using bulk methods, generate a DOCX for each array value

$variables =
array(
    // first DOCX
    array(
        array('LIST_A' => array('First item', 'Second item', 'Third item')),
        array('LIST_B' => array('Item 1', 'Item 2', 'Item 3')),
    ),
    // second DOCX
    array(
        array('LIST_A' => array('1st item', '2nd item', '3rd item')),
        array('LIST_B' => array('Item A', 'Item B', 'Item C')),
    ),
    // third DOCX
    array(
        array('LIST_A' => array('I item', 'II item', 'III item')),
        array('LIST_B' => array('Item I', 'Item II', 'Item III')),
    ),
);

$bulk->replaceList($variables, $options);
$documents = $bulk->getDocuments();

// save documents
for ($i = 0; $i < count($documents); $i++) {
    $documents[$i]->saveDocx('output_' . ($i + 1));
}

Release notes

phpdocx 13.0:
- parseLineBreaks option.

phpdocx 12.0:
- supported sub-arrays.

phpdocx 10.0:
- new method.