addTable

CONTENTS

LAYOUT AND SETTINGS

TEMPLATES

SAVE

FORMAT CONVERSION

transform

XLSXUTILITIES

INDEXER

indexer

PERFORMANCE

zipStream

CRYPTO

DIGITAL SIGNATURE

sign (XLSX)

addTable

BASIC / ADVANCED / PREMIUM

Adds tables into the Excel spreadsheet.

Description

public addTable($contents, $position, $tableStyles = array(), $options = array())

This method allows adding a table in the active sheet.

Parameters

contents

A multidimensional array with the contents and styles to be added. Check addCell to see all available options.

position

Cell position in the active sheet: A1, C3, AB7...

tableStyles

The possible keys and values of this array are:

Key	Type	Description
bandedColumn	bool	Banded column option. Default as false.
bandedRow	bool	Banded row option. Default as true.
firstColumn	bool	First column option. Default as false.
headerRow	bool	Header row option. Default as false.
lastColumn	bool	Last column option. Default as false.
tableStyle	string	Table style name. MS Excel includes built-in table style names: TableStyleMedium2, TableStyleLight3...
totalRow	bool	Total row option. Default as false.

options

The possible keys and values of this array are:

Key	Type	Description
columnNames	array	Custom column names. If not set, 'Column ' is used to generate names.
columnTotals	array	'cellStyles' => check addCell to see all available options. 'contentStyles' => check addCell to see all available options. 'type' => (string) 'formula', 'function', 'label'. 'value' => (string) formula (string), function (average, count, countNums, max, min, stdDev, sum, var), label (string). To be used with the previous 'type' option.
description	string	Alternative text description.
filters	array	custom (array): 'andMode' => (bool). if true, enable 'and' option. Default as false. 'operator' => (string) equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual. 'value' => (string) ? (any single character), * (any series of characters). values (array)
tableName	string	Custom table name. If not set a new table name is generated automatically.
title	string	Alternative text title.

Return values

Array with the position range added by the method.

Exceptions

Table name exists in the spreadsheet.

Code samples

Example #1

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

$contents = array(
    array(
        10,
    ),
    array(
        20,
    ),
    array(
        55,
    ),
    array(
        32,
    ),
);
$options = array(
    'columnNames' => array(
        array(
            'text' => 'Values',
            'bold' => true,
        ),
    ),
);
$xlsx->addTable($contents, 'B3', array(), $options);

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Example #2

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

// add new contents with custom styles
$cellStyles = array(
    'type' => 'general',
    'backgroundColor' => 'D9E1F2',
);
$contents = array(
    array(
        array(
            'text' => '10',
            'cellStyles' => $cellStyles,
        ),
        array(
            'text' => '50',
            'cellStyles' => $cellStyles,
        ),
        array(
            'text' => '20',
            'cellStyles' => $cellStyles,
        ),
    ),
    array(
        array(
            'text' => '20',
            'cellStyles' => $cellStyles,
        ),
        array(
            'text' => '25.5',
            'cellStyles' => $cellStyles,
        ),
        array(
            'text' => '31',
            'cellStyles' => $cellStyles,
        ),
    ),
    array(
        array(
            'text' => '55',
            'cellStyles' => $cellStyles,
        ),
        array(
            'text' => '12',
            'cellStyles' => $cellStyles,
        ),
        array(
            'text' => '22',
            'cellStyles' => $cellStyles,
        ),
    ),
    array(
        array(
            'text' => '32',
            'cellStyles' => $cellStyles,
        ),
        array(
            'text' => '36',
            'cellStyles' => $cellStyles,
        ),
        array(
            'text' => '10',
            'cellStyles' => $cellStyles,
        ),
    ),
);
$options = array(
    'columnNames' => array(
        array(
            'text' => 'Values 1',
            'bold' => true,
            'color' => 'FFFFFF',
            'cellStyles' => array(
                'backgroundColor' => '4472C4',
            ),
        ),
        array(
            'text' => 'Values 2',
            'bold' => true,
            'color' => 'FFFFFF',
            'cellStyles' => array(
                'backgroundColor' => '4472C4',
            ),
        ),
        array(
            'text' => 'Values 3',
            'bold' => true,
            'color' => 'FFFFFF',
            'cellStyles' => array(
                'backgroundColor' => '4472C4',
            ),
        ),
    ),
);
$xlsx->addTable($contents, 'B3', array(), $options);

// add new contents with table styles
$contents = array(
    array(
        10,
        50,
    ),
    array(
        20,
        25.5,
    ),
    array(
        55,
        12,
    ),
    array(
        32,
        36,
    ),
);
$tableStyles = array(
    'tableStyle' => 'TableStyleMedium2',
);
$options = array(
    'columnNames' => array(
        array(
            'text' => 'Values',
        ),
        array(
            'text' => 'Values',
        ),
    ),
);
$xlsx->addTable($contents, 'G3', $tableStyles, $options);

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Example #3

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

$contents = array(
    array(
        10,
    ),
    array(
        20,
    ),
    array(
        55,
    ),
    array(
        32,
    ),
);
$tableStyles = array(
    'totalRow' => true,
);

// table with sum as row total
$options = array(
    'columnNames' => array(
        array(
            'text' => 'Values',
            'bold' => false,
        ),
    ),
    'columnTotals' => array(
        array(
            'type' => 'function',
            'value' => 'sum',
            'contentStyles' => array(
                'bold' => true,
            ),
            'cellStyles' => array(
                'backgroundColor' => 'FFFF00',
            ),
        ),
    ),
);
$xlsx->addTable($contents, 'B3', $tableStyles, $options);

// table with count as row total
$options = array(
    'columnNames' => array(
        array(
            'text' => 'Values',
            'bold' => false,
        ),
    ),
    'columnTotals' => array(
        array(
            'type' => 'function',
            'value' => 'count',
            'contentStyles' => array(
                'bold' => true,
            ),
            'cellStyles' => array(
                'backgroundColor' => 'FFFF00',
            ),
        ),
    ),
);
$xlsx->addTable($contents, 'E3', $tableStyles, $options);

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Example #4

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

$contents = array(
    array(
        10,
        50,
    ),
    array(
        20,
        25.5,
    ),
    array(
        55,
        12,
    ),
    array(
        32,
        36,
    ),
);
$tableStyles = array(
    'totalRow' => true,
);

// table with max and count as row totals
$options = array(
    'columnNames' => array(
        array(
            'text' => 'Values 1',
        ),
        array(
            'text' => 'Values 2',
        ),
    ),
    'columnTotals' => array(
        array(
            'type' => 'function',
            'value' => 'max',
            'contentStyles' => array(
                'bold' => true,
            ),
        ),
        array(
            'type' => 'function',
            'value' => 'count',
            'contentStyles' => array(
                'bold' => true,
            ),
        ),
    ),
);
$xlsx->addTable($contents, 'B3', $tableStyles, $options);

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Release notes

phpxlsx 2.5:
- title and description options.
- apply content types to contents and totals.
- return the position range.

phpxlsx 2.0:
- filters.

phpxlsx 1.0:
- new method.