replaceTableVariable

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

replaceTableVariable

TRIAL / ADVANCED / PREMIUM

Replaces a group of variables within a set of table rows.

Description

public replaceTableVariable (array $vars [, array $options])

This method is intended to generate a Word table with an initially undetermined number of rows.

If a set of placeholder variables is included in a group of rows, phpdocx will clone those rows as many times as needed and populate the variables with the provided values.

Parameters

vars

This has to be an array of associative arrays. The keys of the associative array should match the names of the variables that you want to replace by their corresponding values (text strings or WordFragments).

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	string	Possible values are: document (default), header, footer. This option sets the scope of the replacement procedure.
parseLineBreaks	boolean	If true (default is false) parses the line breaks to include them in the Word document.
type	string	inline (default) or block; used by WordFragment values.
addExtraSiblingNodes	boolean	If true (default is false) parses and adds nodes that don't have placeholders between placeholders.
wordFragmentOptions (Available in Premium licenses)	array	stylesReplacementType (string): usePlaceholderStyles (keep placeholder styles, styles from the imported HTML are ignored), mixPlaceholderStyles (mix placeholder styles, placeholder styles overwrite HTML styles with the same name). Applies to the following styles: pPr, rPr stylesReplacementTypeIgnore (array): styles to be ignored from the imported WordFragment. Use with mixPlaceholderStyles stylesReplacementTypeOverwrite (bool): if true, overwrite the placeholder styles don't set in stylesReplacementTypeIgnore. Use with mixPlaceholderStyles. Default as false

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocxFromTemplate('document.docx');

$data = array(
    array(
        'ITEM' => 'Product A',
        'REFERENCE' => '107AW3',
    ),
    array(
        'ITEM' => 'Product B',
        'REFERENCE' => '204RS67O',
    ),
    array(
        'ITEM' => 'Product C',
        'REFERENCE' => '25GTR56',
    ),
);
$docx->replaceTableVariable($data);

$docx->createDocx('output');

The resulting Word document looks like:

Example #2

require_once 'classes/CreateDocx.php';

$docx = new CreateDocxFromTemplate('document.docx');

$docx->setTemplateSymbol('@');
$data = array(
    array(
        'ITEM' => 'Product A',
        'REFERENCE' => '107AW3',
        'PRICE' => '5.45',
    ),
    array(
        'ITEM' => 'Product B',
        'REFERENCE' => '204RS67O',
        'PRICE' => '30.12',
    ),
    array(
        'ITEM' => 'Product C',
        'REFERENCE' => '25GTR56',
        'PRICE' => '7.00',
    ),
);
$docx->replaceTableVariable($data);

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 17.0:
- wordFragmentOptions option.

phpdocx 12.5:
- addExtraSiblingNodes option.

phpdocx 7.0:
- header and footer targets.

phpdocx 6.5:
- supported WordFragments as values.

phpdocx 6.0:
- supported literals like '\n' and carriage returns like "\n" with the parseLineBreaks option.