addTable

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

addTable

TRIAL / ADVANCED / PREMIUM

Inserts a table into a Word document.

Description

public addTable (array $tableData [, array $tableProperties = array() [, array $rowProperties = array()]])

This method allows the insertion of a table into your Word document.

You may:

Create tables with complex row and col spans.
Insert in each single table cell:
- plain text
- rich text
- nested tables
- lists
- images
- charts
- footnotes and endnotes
- any combination of all of the above
Style the table as a whole and/or its individual rows and cells: set, for example, global properties like borders and margins that can be overriden for each table cell.
You may position the table by its own or make it float so the surrounding text will wrap around it.

Like in the standard MS Word interface, tables, by default, have a black border in every cell. If you want a borderless table you should specify the border option to none in $tableProperties

MS Word supports up to 63 columns in a table.

MS Word and many other DOCX readers handle automatic sizes in many cases. When adding complex tables with colspans or many columns or using DOCX readers that don't handle automatic sizes correctly (such as Google Docs), it's recommended setting column widths with the columnWidths option to get a correct output.

Parameters

tableData

This is an array of arrays. Each entry of this array of arrays contains the content and style needed to render that particular table cell.

These entries may be:

a simple string of text
a WordFragment object
itself an array

The first option is only valid for very simple tables that only contain plain text.

The WordFragments are only needed if you want to insert images, charts, nested tables or complex paragraphs.

The array option gives you whole control over the contents and formatting of a particular table cell.

The possible keys and values of each of these arrays are:

Key	Type	Description
value	mixed	The text to be inserted (string) or a Word fragment if you want to insert complex paragraphs, images, nested tables...
backgroundColor	string	Hexadecimal color value: 'FF0000', '000000'...
border	string	Border type: none, single, double, dashed, threeDEngrave, threeDEmboss, outset, inset... This value can be overridden for each side with the use 'borderTop', 'borderRight', 'borderBottom' and 'borderLeft' properties.
borderColor	string	Hexadecimal color value: 'FF0000', '000000'... This value can be overridden for each side with the use of 'borderTopColor', 'borderRightColor', 'borderBottomColor' and 'borderLeftColor' properties.
borderSpacing	int	Border spacing in points. This value can be overridden for each side with the use of 'borderTopSpacing', 'borderRightSpacing', 'borderBottomSpacing' and 'borderLeftSpacing' properties.
borderWidth	int	Border size in eigths of a point. This value can be overridden for each side with the use of 'borderTopWidth', 'borderRightWidth', 'borderBottomWidth' and 'borderLeftWidth' properties.
caption	array	'align' (string) alignment of the caption 'bookmarkName' (string) set a custom bookmark name 'color' (string) text color 'keepNext' (bool) keep in the same page the current paragraph with next paragraph. Default as false 'label' (string) set a custom label (Table by default) 'lineSpacing' (int) text line spacing 'position' (string) below (default), above 'showLabel' (bool) show default value Table 'styleName' (string) allow setting a custom style name, useful to generate table of figures based on style names 'sz' (int) text size 'text' (string) text of the caption
cellMargin	mixed	An integer or an array with keys: top, right, bottom and left. The values are given in twentieths of a point.
colspan	int	The col span of that particular table cell.
fitText	bool	If true fits the text to the size of the cell.
noWrap	bool	If true text does not wrap.
rowspan	int	The row span of that particular table cell.
textDirection	string	Sets the direction of the flow of text. Available values are: lr (default), tbRl and btLr.
vAlign	string	Vertical align of text: top, center, both or bottom.
width	int	Preferred cell width in twentieths of a point (twips).

tableProperties

This is an array including all general table options (some of them may be overriden by row or cell properties).

The possible keys and values of this array are:

Key	Type	Description
bidi	bool	Sets to 'true' for right to left languages (default value is 'false').
border	string	Border type: none, single, double, dashed, threeDEngrave, threeDEmboss, outset, inset... By default the border type is single. You should select none for borderless tables.
borderColor	string	Hexadecimal color value: 'FF0000', '000000'...
borderSpacing	int	Border spacing in points.
borderWidth	int	Border size in eigths of a point.
borderSettings	string	Possible values are: all, outside, inside. If all (default value) the border styles apply to all table borders. If the value is set to outside or inside the border styles will only apply to the outside or inside boreders respectively.
cantSplitRows	bool	Sets global row split properties (can be overriden or set for individual rows by rowProperties).
cellMargin	mixed	General cell margins for the whole table. An integer or an array with keys: top, right, bottom and left. The values are given in twentieths of a point.
cellSpacing	int	Separation among cells. Given in twentieths of a point (twips).
columnWidths	mixed	An integer or a zero-based array with the widths of each column in twentieths of a point.
conditionalFormatting	array	This option lets you control which formatting conditions declared in the corresponding table style should be applied. The possible keys and values are: 'firstRow' (boolean) first table row conditional formatting. 'lastRow' (boolean) last table row conditional formatting. 'firstCol' (boolean) first table column conditional formatting. 'lastCol' (boolean) last table column conditional formatting. 'noHBand' (boolean) does not apply row banding conditional formatting. 'noVBand' (boolean) does not apply column banding conditional formatting. The default values are: firstRow (true), firstCol (true), noVBand (true) and all other false.
descr	string	Description value.
descrTitle	string	Title description value.
float	array	With the following keys and values: 'align' (string) possible values are: left, center, right, outside, inside. 'textMarginTop' (int) in twentieths of a point. 'textMarginRight' (int) in twentieths of a point. 'textMarginBottom' (int) in twentieths of a point. 'textMarginLeft' (int) in twentieths of a point.
font	string	Font family: 'Arial', Calibri'...
indent	int	Left table margin in twentieths of a point (twips).
tableAlign	string	Table alignment. Possible values are: center, left or right.
tableLayout	string	Possible values are: fixed or autofit (default). Set it to 'fixed' only if you do not want Word to handle the best possible width.
tableStyle	string	Word table style id (you may run parseStyles method to check for the available styles in phpdocx or your particular template).
tableWidth	array	Its possible keys and values are: 'type' (pct, dxa) pct if the value refers to percentage and dxa if the value is given in twentieths of a point (twips). 'value' (int).
textProperties	array	It may include any of the paragraph properties of the addText method so you can completely customize the properies of the text content of the table.

rowProperties

This is an array of arrays (one for each row you want to customize) including all available row options.

The possible keys and values of each of these arrays are:

Key	Type	Description
cantSplit	bool	If true the row can not split across pages.
height	int	Exact row height in twentieths of a point (twips).
minHeight	int	Minimum row height in twentieths of a point (twips).
tableHeader	bool	If true, and the table splits across pages, this row repeats at the beginning of each new page.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$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),
    'tableLayout' => 'autofit', // this is the default value
    'tableWidth' => array('type' =>'pct', 'value' => 50),
);
$docx->addTable($valuesTable, $paramsTable);

$docx->createDocx('output');

The resulting Word document looks like:

Example #2

require_once 'classes/CreateDocx.php';
$docx = new CreateDocx();

// create a few Word fragments to insert rich content in a table
$link = new WordFragment($docx);
$options = array(
    'url' => 'http://www.google.es',
);
$link->addLink('Link to Google', $options);

$image = new WordFragment($docx);
$options = array(
    'src' => '/img/image.png',
);
$image->addImage($options);

$valuesTable = array(
    array(
        'Title A',
        'Title B',
        'Title C',
    ),
    array(
        'Line A',
        $link,
        $image,
    )
);
$paramsTable = array(
    'tableStyle' => 'LightListAccent1PHPDOCX',
    'tableAlign' => 'center',
    'columnWidths' => array(1000, 2500, 3000),
);

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

$docx->createDocx('output');

The resulting Word document looks like:

Example #3

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$docx->addText('Quisque ullamcorper, dolor eget eleifend consequat,
justo nunc ultricies quam, sed ullamcorper lectus urna ac justo.
Phasellus sed libero ut dui hendrerit tempus. Mauris tincidunt
laoreet sapien, feugiat viverra justo dictum eu. Cras at eros ac
urna accumsan varius. Vestibulum cursus gravida sollicitudin.
Donec vestibulum lectus id sem malesuada volutpat. Praesent et ipsum orci.
Sed rutrum eros id erat fermentum in auctor velit auctor.
Nam bibendum rutrum augue non pellentesque. Donec in mauris dui,
non sagittis dui. Phasellus quam leo, ultricies sit amet cursus nec,
elementum at est. Proin blandit volutpat odio ac dignissim.
In at lacus dui, sed scelerisque ante. Aliquam tempor,
metus sed malesuada vehicula, neque massa malesuada dolor,
vel semper massa ante eu nibh.');

// create a simple Word fragment to insert into the table
$textFragment = new WordFragment($docx);
$text = array();
$text[] = array('text' => 'Fit text and ');
$text[] = array('text' => 'Word fragment', 'bold' => true);
$textFragment->addText($text);

// establish some row properties for the first row
$trProperties = array();
$trProperties[0] = array(
    'minHeight' => 1000,
    'tableHeader' => true,
);

$col_1_1 = array(
    'rowspan' => 4,
    'value' => '1_1',
    'backgroundColor' => 'cccccc',
    'borderColor' => 'b70000',
    'border' => 'single',
    'borderTopColor' => '0000FF',
    'borderWidth' => 16,
    'cellMargin' => 200,
);
$col_2_2 = array(
    'rowspan' => 2,
    'colspan' => 2,
    'width' => 200,
    'value' => $textFragment,
    'backgroundColor' => 'ffff66',
    'borderColor' => 'b70000',
    'border' => 'single',
    'cellMargin' => 200,
    'fitText' => 'on',
    'vAlign' => 'bottom',
);
$col_2_4 = array(
    'rowspan' => 3,
    'value' => 'Some rotated text',
    'backgroundColor' => 'eeeeee',
    'borderColor' => 'b70000',
    'border' => 'single',
    'borderWidth' => 16,
    'textDirection' => 'tbRl',
);

//set the global table properties
$options = array(
    'columnWidths' => array(400,1400,400,400,400),
    'border' => 'single',
    'borderWidth' => 4,
    'borderColor' => 'cccccc',
    'borderSettings' => 'inside',
    'float' => array(
        'align' => 'right',
        'textMargin_top' => 300,
        'textMargin_right' => 400,
        'textMargin_bottom' => 300,
        'textMargin_left' => 400,
    ),
    'tableWidth' => array('type' => 'pct', 'value' => 70),
);

$values = array(
    array($col_1_1, '1_2', '1_3', '1_4', '1_5'),
    array($col_2_2, $col_2_4, '2_5'),
    array('3_5'),
    array('4_2', '4_3', '4_5'),
);

$docx->addTable($values, $options, $trProperties);

$docx->addText('In pretium neque vitae sem posuere volutpat.
Class aptent taciti sociosqu ad litora torquent per conubia nostra,
per inceptos himenaeos. Quisque eget ultricies ipsum. Cras vitae suscipit
erat. Nullam fermentum risus sed urna fermentum placerat laoreet arcu lobortis.
Integer nisl erat, vehicula eget posuere id, mollis fermentum mi.
Phasellus quis nulla orci. Suspendisse malesuada lectus et turpis facilisis
id imperdiet tellus luctus. In hac habitasse platea dictumst. Proin a mattis turpis.
Aliquam sit amet velit a lacus hendrerit bibendum. Mauris euismod dictum augue eget condimentum.');

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- descr and descrTitle options.

phpdocx 13.5:
- position and keepNext options for captions.
- improved autonumeric values when captions use the same style name.

phpdocx 12.0:
- bookmarkName option for captions.
- handle autonumeric id by the style name when adding captions.
- bookmarks wrap the full content of the caption.

phpdocx 10.0:
- caption option.