cloneBlock

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

cloneBlock

ADVANCED / PREMIUM

TRIAL

Clones a block in the document.

Description

public cloneBlock (string $blockName [, int $occurrence [, array $variablesBlock = array() [, array $options = array()]]])

Block placeholders must be added in their own paragraph.

Parameters

blockName

The block var.

occurrence

Position of the block to be cloned. 1 as default.

variablesBlock

This must be an array with the names of the placeholder block variables as keys and the plain text or WordFragment that should replace them as values.

The subarray 'images' can be added to do image replacements.

options

The possible keys and values of this array are:

Key	Type	Description
removeBlockPlaceholder	bool	False as default. If true, remove block placeholders from the cloned content.
type	string	Possible values are: inline (default) or block. Used by WordFragment values.

Exceptions

Method not available.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

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

$docx->cloneBlock('FIRST');

$docx->createDocx('output');

The resulting Word document looks like:

Example #2

require_once 'classes/CreateDocx.php';

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

$docx->cloneBlock('EXAMPLE');

// clone block, 1st occurrence
$docx->cloneBlock('SUB_1');

// clone block, 2nd occurrence
$docx->cloneBlock('SUB_1', 2);

// clone block, 4th occurrence
$docx->cloneBlock('SUB_1', 4);

// clone block, 2nd occurrence
$docx->cloneBlock('SUB_2', 2);

// clone block, 1st occurrence
$docx->cloneBlock('SUB_2');

// remove block placeholders
$docx->clearBlocks();

$docx->createDocx('output');

The resulting Word document looks like:

Example #3

require_once 'classes/CreateDocx.php';

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

$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',
    ),
    array(
        'VAR_MEMBER' => 'Jane Doe',
        'VAR_CONTENT' => $link,
        'VAR_DATE' => '21/08/2021',
    ),
);

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

// delete remaining block
$docx->deleteBlock('FIRST');

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 14.0:
- generate new id and name attributes for drawing object non-visual property tags.

phpdocx 13.5:
- improved using block placeholders with parent elements.
- replace image placeholders.

phpdocx 12.5:
- clone the same block multiple times.
- add and replace text placeholders with text strings or WordFragments.

phpdocx 8.2:
- block placeholders in templates don't need to be unique.

phpdocx 7.0:
- new method.