replaceText

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

replaceText

PREMIUM

TRIAL / ADVANCED

Bulk processing. Replaces placeholder variables by text.

Description

public replaceText (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 (default), header, footer

Code samples

Example #1

require_once 'classes/CreateDocx.php';

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

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

$variables =
array(
    // first DOCX
    array(
        'date' => date('Y/m/d'),
        'name' => 'John',
        'address' => 'Acme Street 1',
        'url' => 'https://www.phpdocx.com',
        'signature' => 'phpdocx',
        'footer' => 'phpdocx\nfooter',
    ),
    // second DOCX
    array(
        'date' => date('Y/m/d'),
        'name' => 'Mary',
        'address' => 'Acme Street 2',
        'url' => 'https://www.phpdocx.com',
        'signature' => 'phpdocx',
        'footer' => 'phpdocx\nfooter',
    ),
    // third DOCX
    array(
        'date' => date('Y/m/d'),
        'name' => 'Tom',
        'address' => 'Acme Street 3',
        'url' => 'https://www.phpdocx.com',
        'signature' => 'phpdocx',
        'footer' => 'phpdocx\nfooter',
    ),
);
$options = array(
    'parseLineBreaks' => true,
);

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

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

Release notes

phpdocx 12.5:
- replace multiple placeholders inside the same w:t tag.

phpdocx 12.0:
- applied htmlspecialchars to values.

phpdocx 10.0:
- new method.