Snippets

INTRODUCTION

PRACTICAL PHPDOCX

CONVERSION PLUGIN

COOKBOOK

SNIPPETS

API DOCUMENTATION

HTML API DOCUMENTATION

JSON API DOCUMENTATION

JAVASCRIPT API DOCUMENTATION

XML API DOCUMENTATION

CASE STUDIES

Clone blocks replacing placeholders

When cloning blocks with the cloneBlock method, you may replace the placeholders of the cloned blocks. There are two different approaches to do it:

Using the available replacement options of the cloneBlock method itself. These options allow to replace the placeholders with texts or WordFragments at the same time the blocks are getting cloned.
Using the firstMatch option. This one clones the blocks first and replace the placeholders afterwards.

Replacing placeholders using cloneBlock options

$image = new WordFragment($docx, 'document');
$image->addImage(array('src' => 'image.png' , 'scaling' => 50));

$link = new WordFragment($docx, 'document');
$link->addLink('Link to website', array('url'=> 'https://www.phpdocx.com'));

// each array sets a new clone of the block
$variables = array(
    array(
        'VAR_MEMBER' => 'John Doe',
        'VAR_CONTENT' => $image,
        'VAR_DATE' => '11/08/2021',
        'images' => array(
            'VAR_IMAGE' => 'image1.png',
        ),
    ),
    array(
        'VAR_MEMBER' => 'Jane Doe',
        'VAR_CONTENT' => $link,
        'VAR_DATE' => '21/08/2021',
        'images' => array(
            'VAR_IMAGE' => 'image2.png',
        )
    ),
);

// clone block setting the variables to be replaced
$docx->cloneBlock('FIRST', 1, $variables, array('removeBlockPlaceholder' => true));

// remaining block can be removed if needed using deleteBlock
$docx->deleteBlock('FIRST');

Replacing placeholders using the firstMatch option available in template methods

// clone block
$docx->cloneBlock('FIRST');
$docx->cloneBlock('FIRST');

// replace values in the new blocks using the firstMatch option available in template methods

// first block
$variablesText = array('VAR_INLINE_TEXT' => 'New text 1', 'VAR_TEXT' => 'New block text 1');
$docx->replaceVariableByText($variablesText, array('firstMatch' => true));
$docx->replacePlaceholderImage('IMAGE','image.png', array('firstMatch' => true));
$dataTable = array(
    array(
        'ITEM' => 'Product A',
        'REFERENCE' => '107AW3',
    ),
    array(
        'ITEM' => 'Product B',
        'REFERENCE' => '204RS67O',
    ),
);
$docx->replaceTableVariable($dataTable, array('firstMatch' => true));

// second block
$variablesText = array('VAR_INLINE_TEXT' => 'New text 2', 'VAR_TEXT' => 'New block text 2');
$docx->replaceVariableByText($variablesText, array('firstMatch' => true));
$docx->replacePlaceholderImage('IMAGE','image.png', array('firstMatch' => true));
$dataTable = array(
    array(
        'ITEM' => 'Product 1',
        'REFERENCE' => 'Ref W3',
    ),
    array(
        'ITEM' => 'Product 2',
        'REFERENCE' => 'Ref 70',
    ),
);
$docx->replaceTableVariable($dataTable, array('firstMatch' => true));

// third block (remaining block, it can be removed if needed using deleteBlock)
$variablesText = array('VAR_INLINE_TEXT' => 'New text 3', 'VAR_TEXT' => 'New block text 3');
$docx->replaceVariableByText($variablesText, array('firstMatch' => true));
$docx->replacePlaceholderImage('IMAGE', 'image.png', array('firstMatch' => true));
$dataTable = array(
    array(
        'ITEM' => 'Product I',
        'REFERENCE' => 'Ref10',
    ),
    array(
        'ITEM' => 'Product II',
        'REFERENCE' => 'Ref20',
    ),
);
$docx->replaceTableVariable($dataTable, array('firstMatch' => true));