importContents

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

importContents

PREMIUM

TRIAL / ADVANCED

Imports contents from a document.

Description

public importContents (string $document, array $referenceNode)

Parameters

document

DOCX to be imported.

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), bookmark, break, chart, endnote (content reference), footnote (content reference), image, list, math, paragraph (also for links and lists), section, shape, table, table-row, table-cell, table-cell-paragraph.
contains	string	Contains a text string.
occurrence	int or string	Exact occurrence (int) or range of contents (e.g.: 2..9, 2.., ..9) (string) or first() or last(). If empty iterate all elements.
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/...).
customQuery	string	Custom xpath query, overwrites any other reference.

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);

// import the first paragraph that contains 'heading'
$referenceNode = array(
    'type' => 'paragraph',
    'occurrence' => 1,
    'contains' => 'heading',
);

$docx->importContents('document_1.docx', $referenceNode);

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

// import charts
$referenceNode = array(
    'type' => 'chart',
);

$docx->importContents('document_2.docx', $referenceNode);

$docx->createDocx('output');

Example #2

require_once 'classes/CreateDocx.php';

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

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

$docx->addText('Import images:', $paragraphOptions);

// import images
$referenceNode = array(
    'type' => 'image',
);

$docx->importContents('document_1.docx', $referenceNode);

$docx->importContents('document_2.docx', $referenceNode);

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

$docx->addText('Import tables:', $paragraphOptions);

// import tables
$referenceNode = array(
    'type' => 'table',
);

$docx->importContents('document_1.docx', $referenceNode);

$docx->importContents('document_4.docx', $referenceNode);

$docx->createDocx('output');

Release notes

phpdocx 15.5:
- math type.
- inks contents.
- SmartArt contents.
- extra check to parse numbering styles.
- prevent duplicated numbering IDs when calling the method multiple times using the same document.
- handle invalid OOXML IDs assigned to images in shapes.
- added new XML namespaces to the default numbering base XML template.

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

phpdocx 14.0:
- improved working with notes with external relationships.

phpdocx 13.5:
- OLE objects.
- multiple list level overrides.

phpdocx 13.0:
- importEmbeddedFonts option.
- OLE objects without bin extensions.

phpdocx 12.5:
- links with mixed IDs and anchors.
- OLE objects embedded in equations.
- added new XML namespaces.
- don't add webSettings and theme1 relationships if the first DOCX to be merged doesn't include them.

phpdocx 12.0:
- improved embedded images in shapes, SVG images, numbering styles applied to custom styles, multiple altChunk tag, hyperlinks in images tags with the same ID and external charts.
- improved working with multiple sections that contain multiple headers and footers.

phpdocx 11.0:
- override styles in level lists.

phpdocx 10.0:
- new method.