replaceWordFragment

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

replaceWordFragment

PREMIUM

TRIAL / ADVANCED

Bulk processing. Replaces placeholder variables by WordFragment.

Description

public replaceWordFragment (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.
target	array	Possible values are: document (default).
type	string	Possible values are: block (default): replaces the variable and removes its containing paragraph. inline: only replaces the variable by the WordFragment inline content (it may be used to replace a variable by formatted text).

Code samples

Example #1

require_once 'classes/CreateDocx.php';

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

// replace placeholders by WordFragments using bulk methods, generate a single DOCX output

$nameA = new WordFragment();
$nameA->addText('John', array('bold' => true, 'font' => 'Arial'));

$nameB = new WordFragment();
$nameB->addText('Mary', array('bold' => true, 'font' => 'Arial'));

$nameC = new WordFragment();
$nameC->addText('Tom', array('bold' => true, 'font' => 'Arial'));

$linkA = new WordFragment();
$linkA->addLink('link to phpdocx', array('url'=> 'http://www.phpdocx.com', 'color' => '0000FF', 'u' => 'single'));

$linkB = new WordFragment();
$linkB->addLink('link to javadocx', array('url'=> 'http://www.javadocx.com', 'color' => '0000FF', 'u' => 'single'));

$linkC = new WordFragment();
$linkC->addLink('link to xmldocx', array('url'=> 'http://www.xmldocx.com', 'color' => '0000FF', 'u' => 'single'));

$variables =
array(
    // first DOCX
    array('url' => $linkA, 'name' => $nameA),
    // second DOCX
    array('url' => $linkB, 'name' => $nameB),
    // third DOCX
    array('url' => $linkC, 'name' => $nameC),
);
$options = array(
    'type' => 'inline',
);

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

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

Release notes

phpdocx 12.0:
- supported values that contain external file dependencies (images, charts and external files).

phpdocx 10.0:
- new method.