addHeader

CONTENTS

LAYOUT AND SETTINGS

TEMPLATES

SAVE

FORMAT CONVERSION

transform

XLSXUTILITIES

INDEXER

indexer

PERFORMANCE

zipStream

CRYPTO

DIGITAL SIGNATURE

sign (XLSX)

addHeader

BASIC / ADVANCED / PREMIUM

Adds a header into the Excel spreadsheet.

Description

public addHeader($contents, $target = 'default', $options = array())

This method adds headers into the Excel spreadsheet.

Parameters

contents

Array. Contents to be added.

Allowed positions: left, center, right.

Text content ('text' key):

'bold' (bool)
'color' (string): FFFFFF, FF0000...
'font' (string): Arial, Times New Roman...
'fontSize' (int): 8, 9, 10, 11...
'italic' (bool)
'strikethrough' (bool)
'underline' (string): single, double.

Available special elements: &[Page], &[Pages], &[Date], &[Time], &[Tab], &[File], &[Path].

A multidimensional array can also be added to include texts with multiple styles.

Image content ('image' key):

'src' (string): image path, base64 or stream.
'alt' (string): alt text.
'brightness' (string)
'color' (string): automatic (default), grayscale, blackAndWhite, washout.
'contrast' (string):.
'height' (int): pt size.
'title' (string): 'image' as default.
'width' (int): pt size.

target

Array. Allowed values: first, default, even.

options

Key	Type	Description
replace	bool	If true replaces the existing footer if it exists. Default as true.

Exceptions

Image doesn't exist.

Image format is not supported.

Code samples

Example #1

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

$content = array(
    'text' => 'Lorem ipsum dolor sit amet',
);
$xlsx->addCell($content, 'A1');

$headerContent = array(
    'text' => 'Header content',
);

$xlsx->addHeader(array('center' => $headerContent));

// set view as pageLayout to display headers and footers
$xlsx->setSheetSettings(array('view' => 'pageLayout'));

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Example #2

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

$content = array(
    'text' => 'Lorem ipsum dolor sit amet',
);
$xlsx->addCell($content, 'A1');
$content = array(
    'text' => 'J1 content',
);
$xlsx->addCell($content, 'J1');
$content = array(
    'text' => 'S1 content',
);
$xlsx->addCell($content, 'S1');

// first header
$headerImageContent = array(
    'image' => array(
        'src' => 'image.png',
        'height' => 30,
        'width' => 40,
        'title' => 'Image header',
        'alt' => 'Image header',
    ),
);
$xlsx->addHeader(array('center' => $headerImageContent), 'first');

// default header
$headerContentPage = array(
    'text' => '&[Page] of &[Pages]',
);
$headerContentDefault = array(
    'text' => 'Default header',
);
// image content
$headerImageContent = array(
    'image' => array(
        'src' => 'image.png',
        'color' => 'washout',
    ),
);
$xlsx->addHeader(array('left' => $headerContentDefault, 'center' => $headerContentPage, 'right' => $headerImageContent));

// set view as pageLayout to display headers and footers
$xlsx->setSheetSettings(array('view' => 'pageLayout'));

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Release notes

phpxlsx 2.5:
- overwrite option renamed to replace.

phpxlsx 2.0:
- new method.