replaceWordContent

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

replaceWordContent

ADVANCED / PREMIUM

TRIAL

Replaces existing contents by a WordFragment.

Description

public replaceWordContent (WordFragment $wordFragment, array $referenceNode, [string $location, bool $forceAppend])

Parameters

wordFragment

WordFragment to be inserted.

referenceNode

An array to get the refence node.
The possible keys and values of this array are:

Key	Type	Description
type	string	* (all, default value) break chart endnote (content reference) footnote (content reference) image math paragraph (also for bookmarks, links and lists) section shape table table-row table-cell table-cell-paragraph
contains	string	Contains a text string.
occurrence	mixed	(int) exact occurrence (from 1) (array) occurrences (string) range of contents (e.g.: '2..9', '2..', '..9') or 'first()' or 'last()'
attributes	array	Contains a specific attribute key and value.
parent	string	Main document body as default, allows to set any parent or a specific one. w:body (default), '/' (any parent) or any other specific parent (/w:tbl/, /w:tc/, /w:r/...).
target	string	document (default) header footer
reference	array	To be used with header and footer targets: positions (array) 1, 2... based on the sectPr contents order, sections (array) 1, 2..., types (array) first, even, default
customQuery	string	Custom xpath query, overwrites any other reference.

location

after (default), before, inlineBefore or inlineAfter. Inline locations don't create a new w:p and add the WordFragment before or after the referenceNode (only inline elements).

forceAppend

If true appends the WordFragment if the reference node could not be found (false as default).

Exceptions

Method not available.

Adding a wrong content.

Not valid location.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$text = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, ' .
    'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut ' .
    'enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut' .
    'aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit ' .
    'in voluptate velit esse cillum dolore eu fugiat nulla pariatur. ' .
    'Excepteur sint occaecat cupidatat non proident, sunt in culpa qui ' .
    'officia deserunt mollit anim id est laborum.';

$paragraphOptions = array(
    'bold' => true,
    'font' => 'Arial',
);

$docx->addText($text, $paragraphOptions);

$text = 'Sed ut perspiciatis unde omnis iste natus error sit voluptatem ' .
    'accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ' .
    'ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt ' .
    'explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut ' .
    'odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem ' .
    'sequi nesciunt.';

$docx->addText($text, $paragraphOptions);

$content = new WordFragment($docx, 'document');

$content->addText('New text.', array('fontSize' => 20, 'color' => '#0000ff'));

$referenceNode = array(
    'type' => 'paragraph',
    'contains' => 'Lorem',
);

$docx->replaceWordContent($content, $referenceNode);

$docx->createDocx('output');

Example #2

require_once 'classes/CreateDocx.php';

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

$content = new WordFragment($docx, 'document');

$valuesTable = array(
    array(
        'AAA',
        'BBB',
    ),
    array(
        'Text',
        'Text: More text',
    ),

);
$paramsTable = array(
    'border' => 'single',
    'tableAlign' => 'center',
    'borderWidth' => 10,
    'borderColor' => 'B70000',
    'textProperties' => array('bold' => true),
);
$content->addTable($valuesTable, $paramsTable);

$referenceNode = array(
    'type' => 'table',
    'occurrence' => 1,
);

$docx->replaceWordContent($content, $referenceNode);

$docx->createDocx('output');

Release notes

phpdocx 17.0:
- occurrence option allows setting an array.
- improved working with header and footer targets when the document include sections without headers or footers.

phpdocx 15.5:
- math type.

phpdocx 15.0:
- table-row, table-cell and table-cell-paragraph types.

phpdocx 12.0:
- improved working with multiple sections that contain multiple headers and footers.

phpdocx 9.5:
- header and footer targets.
- after, before, inlineBefore and inlineAfter locations.

phpdocx 7.0:
- range of elements, iterate all elements not only the first one, siblings.

phpdocx 6.0:
- new method.