addCellRange

CONTENTS

LAYOUT AND SETTINGS

TEMPLATES

SAVE

FORMAT CONVERSION

transform

XLSXUTILITIES

INDEXER

indexer

PERFORMANCE

zipStream

CRYPTO

DIGITAL SIGNATURE

sign (XLSX)

addCellRange

BASIC / ADVANCED / PREMIUM

Adds ranges of cell contents into the Excel spreadsheet.

Description

public addCellRange($contents, $position, $cellStyles = array(), $options = array())

This method allows adding a range of cell contents from a position.

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...

cellStyles

Check addCell to see all available options.

options

Check addCell to see all available options.

Return values

Array with the cell positions added by the method.

Code samples

Example #1

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

// contents added horizontally
$contents = array(
    array(
        array('text' => 'Lorem'),
        array('text' => 'ipsum dolor', 'bold' => true),
        array('text' => 'sit', 'italic' => true),
        array('text' => 'amet'),
    ),
);
$rangeInfo = $xlsx->addCellRange($contents, 'A1');
// addCellRange returns the cell range of the contents
// var_dump($rangeInfo);

// contents added vertically
$contents = array(
    array(
        array('text' => 'Sed ut  '),
    ),
    array(
        array('text' => 'perspiciatis', 'italic' => true, 'underline' => 'single'),
    ),
    array(
        array('text' => 'unde omnis'),
    ),
);
$xlsx->addCellRange($contents, 'C3');

// contents added horizontally and vertically
$contents = array(
    array(
        array('text' => 'At'),
        array('text' => 'vero eos'),
    ),
    array(
        array('text' => 'et accusamus', 'italic' => true),
        array('text' => 'et iusto'),
    ),
);
$xlsx->addCellRange($contents, 'F5');

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Example #2

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

// contents without styles
$contents = array(
    array('Lorem', 20, '10%', TRUE),
);
$xlsx->addCellRange($contents, 'A1');

// contents with styles
$contents = array(
    array(
        array('text' => 'Lorem'),
        array('text' => 20, 'bold' => true),
        array('text' => '21%', 'italic' => true),
        array('text' => FALSE),
    ),
);
$xlsx->addCellRange($contents, 'A2');

// add new contents and functions
$contents = array(
    array(
        array(
            'text' => 'Content', 'cellStyles' => array('backgroundColor' => '8A9977'),
        ),
    ),
    array(
        10,
        50,
    ),
    array(
        20,
        25.5,
    ),
    array(
        55,
        12,
    ),
    array(
        32,
        36,
    ),
    array(
        '=SUM(F6:F9)',
        array(
            'text' => '=SUM(G6:G9)',
            'cellStyles' => array(
                'borderTop' => 'dashed',
                'borderColorTop' => '3D643D',
                'backgroundColor' => '98FB98',
            ),
        )
    )
);
// global styles for the cell range
$cellStyles = array(
    'backgroundColor' => 'FFFFBF',
);
$xlsx->addCellRange($contents, 'F5', $cellStyles);

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Example #3

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

// dates added horizontally
$contents = array(
    array(
        array('text' => '2010-02-26'),
        array('text' => '1980-08-08'),
        array('text' => '2022-01-01'),
    ),
);
$cellStyles = array(
    'type' => 'date',
    'typeOptions' => array(
        'formatCode' => 'yyyy\-mm;@',
    ),
);
$xlsx->addCellRange($contents, 'C1', $cellStyles);

// text content, numbers and a function added vertically
$contents = array(
    array(
        array('text' => 'Content', 'cellStyles' => array('backgroundColor' => '8A9977')),
    ),
    array(
        array('text' => 10),
    ),
    array(
        array('text' => 20),
    ),
    array(
        array('text' => 55),
    ),
    array(
        array('text' => 32.5),
    ),
    array(
        array(
            'text' => '=SUM(F6:F9)',
            'cellStyles' => array(
                'type' => 'number',
                'borderTop' => 'dashed',
                'borderColorTop' => '3D643D',
                'backgroundColor' => '98FB98',
            ),
        ),
    )
);
// global styles for the cell range
$cellStyles = array(
    'backgroundColor' => 'FFFFBF',
);
$xlsx->addCellRange($contents, 'F5', $cellStyles);

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Release notes

phpxlsx 1.0:
- new method.