addHeader

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

addHeader

TRIAL / ADVANCED / PREMIUM

Inserts headers into the Word document.

Description

public addHeader ( array $headers )

It is possible to include a different header for:

the first page or title page.
even pages.
odd pages (this one is the default header for the whole document if no other headers are defined for the first or even pages).

The contents of the different headers are defined via the use of WordFragments. These header WordFragments allow for the insertion of:

text paragraphs
current date and/or hour
images
links
lists
page numbers
shapes
tables
HTML content
...

You may also import the headers of an existing DOCX document via the ImportHeadersAndFooters method.

This method adds new headers into all sections, removing existing headers. The addHeaderSection method allows adding headers per section.

Parameters

headers

An array with the different header contents.

Key	Type	Description
default	WordFragment	The WordFragment object containing the contents for the default (odd pages) header.
even	WordFragment	The WordFragment object containing the contents for the even pages header.
first	WordFragment	The WordFragment object containing the contents for the first (title) page header.

Exceptions

Not using WordFragments.

Code samples

Example #1:

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();
$imageOptions = array(
   'src' => 'image.png',
   'dpi' => 300,
);
$headerImage = new WordFragment($docx, 'defaultHeader');
$headerImage->addImage($imageOptions);
$docx->addHeader(array('default' => $headerImage));
$docx->addText('This document has a header with just one image.');

$docx->createDocx('output');

The resulting Word document looks like this:

Example #2:

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$imageOptions = array(
    'src' => 'image.png',
    'dpi' => 600,
);

$headerImage = new WordFragment($docx, 'defaultHeader');
$headerImage->addImage($imageOptions);

$textOptions = array(
    'fontSize' => 13,
    'bold' => true,
    'color' => '567899',
);
$headerText = new WordFragment($docx, 'defaultHeader');
$headerText->addText('PHPDocX Header Title', $textOptions);

$pageNumberOptions = array(
    'textAlign' => 'right',
    'fontSize' => 11,
);
$headerPageNumber = new WordFragment($docx, 'defaultHeader');
$headerPageNumber->addPageNumber('numerical', $pageNumberOptions);

$valuesTable = array(
    array(
        array('value' =>$headerImage, 'vAlign' => 'center'),
        array('value' =>$headerText, 'vAlign' => 'center'),
        array('value' =>$headerPageNumber, 'vAlign' => 'center'),
    ),
);
$widthTableCols = array(
    700,
    7500,
    500
);
$paramsTable = array(
    'border' => 'nil',
    'columnWidths' => $widthTableCols,
);
$headerTable = new WordFragment($docx, 'defaultHeader');
$headerTable->addTable($valuesTable, $paramsTable);

$docx->addHeader(array('default' => $headerTable));

$docx->addText('This document has a header with an image, some text and page numbering.');

$docx->addBreak(array('type' => 'page'));

$docx->addText('Now some text in the second page.');

$docx->createDocx('output');

The resulting Word document looks like this: