addTableFigures

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

addTableFigures

TRIAL / ADVANCED / PREMIUM

Inserts a Table of Figures into the Word document.

Description

public addTableFigures ( [array $options [, array $legend]] )

This method allows you to include a Table of Figures in the Word document.

Parameters

options

The possible keys and values are:

Key	Type	Description
autoUpdate	boolean	If true it will try to update the content when first opened.
scope	string	Contents to display: table (default), figure and other custom values based on the content style ID.

legend

The possible keys and values are:

Key	Type	Description
text	array	The placeholder text that will be shown if the autoupdate option is not activated.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$docx->addText('Table of Figures', array('bold' => true, 'fontSize' => 14));
$legend = array(
    'text' => 'Click here to update the table of figures',
    'color' => 'B70000',
    'bold' => true,
    'fontSize' => 12,
);
$docx->addTableFigures(array('autoUpdate' => true, 'scope' => 'Table'), $legend);

$docx->addText('Table of Figures', array('bold' => true, 'fontSize' => 14));
$legend = array(
    'text' => 'Click here to update the table of figures',
    'fontSize' => 11,
);
$docx->addTableFigures(array('autoUpdate' => true, 'scope' => 'Figure'), $legend);

$valuesTable = array(
    array(
        11,
        12,
        13,
        14
    ),
    array(
        21,
        22,
        23,
        24
    ),
    array(
        31,
        32,
        33,
        34
    ),

);

$paramsTable = array(
    'border' => 'single',
    'tableAlign' => 'center',
    'borderWidth' => 10,
    'borderColor' => 'B70000',
    'textProperties' => array('bold' => true, 'font' => 'Algerian', 'fontSize' => 18),
    'caption' => array('showLabel' => true, 'text' => ' Sample Table', 'align' => 'right', 'styleName' => 'Table'),
);

$docx->addTable($valuesTable, $paramsTable);

$options = array(
    'src' => 'image.png',
    'imageAlign' => 'center',
    'scaling' => 50,
    'spacingTop' => 10,
    'spacingBottom' => 0,
    'spacingLeft' => 0,
    'spacingRight' => 20,
    'textWrap' => 0,
    'borderStyle' => 'lgDash',
    'borderWidth' => 6,
    'borderColor' => 'FF0000',
    'caption' => array('showLabel' => false, 'text' => ' Sample Image 2', 'styleName' => 'Figure')
);

$docx->addImage($options);

$options = array(
    'src' => 'image.png',
    'imageAlign' => 'center',
    'scaling' => 50,
    'spacingTop' => 10,
    'spacingBottom' => 0,
    'spacingLeft' => 0,
    'spacingRight' => 20,
    'textWrap' => 0,
    'borderStyle' => 'lgDash',
    'borderWidth' => 6,
    'borderColor' => 'FF0000',
    'caption' => array('showLabel' => false, 'text' => ' Sample Image 2', 'styleName' => 'Figure')
);

$docx->addImage($options);

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 10.0:
- new method.