addHeaderSection

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

addHeaderSection

ADVANCED / PREMIUM

TRIAL

Inserts headers in a specific section into the Word document.

Description

public addHeaderSection ( array $headers [, array $section = -1] [, array $options])

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.

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) footer.
even	WordFragment	The WordFragment object containing the contents for the even pages footer.
first	WordFragment	The WordFragment object containing the contents for the first (title) page footer.

section

Section position. -1 as default. 0 is the first section and -1 the last section.

options

An array with the available options.

The possible keys and values are:

key	Type	Description
removeOthers	bool	If true remove other headers in the section. Default as false.

Exceptions

Method not available.

Not using WordFragments.

Section number doesn't exist.

Code samples

Example #1:

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

// add headers into the first section
$headerTextFirstSection = new WordFragment($docx, 'firstHeader');
$headerTextFirstSection->addText('Header in the first section');

// create a Word fragment with an image to be inserted in the header of the document
$imageOptions = array(
	'src' => 'image.png',
	'dpi' => 300,
);
$headerImageFirstSection = new WordFragment($docx, 'defaultHeader');
$headerImageFirstSection->addImage($imageOptions);
// by default, addHeaderSection adds headers into the last section
$docx->addHeaderSection(array('first' => $headerTextFirstSection, 'default' => $headerImageFirstSection));
// add some text
$docx->addText('This section has a header with a text in the first header and an image as default header.');

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

$docx->addText('Second page');

// create a new section
$docx->addSection();

// add headers into the new section

// contents with dependencies such as images and links share the same internal header/footer scope for all sections in phpdocx.
// These contents must be created and added in order when adding headers and footers per section
$headerTextSecondSection = new WordFragment($docx, 'firstHeader');
$headerTextSecondSection->addText('Header in the second section');

$headerContentSecondSection = new WordFragment($docx, 'defaultHeader');
$imageOptions = array(
	'src' => 'imageP1.png',
	'dpi' => 300,
    'textWrap' => 1,
);
$headerContentSecondSection->addImage($imageOptions);

// add a page numbering
$style = array(
    'bold' => true,
    'color' => 'B70000',
    'fontSize' => 24,
);
// create a custom style
$docx->createParagraphStyle('pgStyle', $style);
// set some formatting options
$options = array(
    'textAlign' => 'right',
    'pStyle' => 'pgStyle',
);
$headerContentSecondSection->addPageNumber('numerical', $options);
$headerContentSecondSection->addBreak();

// by default, addHeaderSection adds the headers into the last section
$docx->addHeaderSection(array('first' => $headerTextSecondSection, 'default' => $headerContentSecondSection));

$docx->addText('A new section.');

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

$docx->addText('Second page in the second section.');

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

$docx->addText('Last page.');

$docx->createDocx('output');

The resulting Word document looks like this:

Example #2:

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

// contents first section
$docx->addText('Content in the first section.');
$docx->addBreak(array('type' => 'page'));
$docx->addText('Another page in the first section.');

// create new sections adding contents
$docx->addSection();
$docx->addText('Content in the second section.');

$docx->addSection();
$docx->addText('Content in the third section.');
$docx->addBreak(array('type' => 'page'));
$docx->addText('Another page in the third section.');
$docx->addBreak(array('type' => 'page'));
$docx->addText('Last page in the third section.');

// insert headers using the section position option

// contents with dependencies such as images and links share the same internal header/footer scope for all sections in phpdocx.
// These contents must be created and added in order when adding headers and footers per section

// headers in the first section
$headerTextFirstSection = new WordFragment($docx, 'firstHeader');
$headerTextFirstSection->addText('Header in the first section');

$imageOptions = array(
	'src' => 'image.png',
	'dpi' => 300,
);
$headerImageFirstSection = new WordFragment($docx, 'defaultHeader');
$headerImageFirstSection->addImage($imageOptions);
$docx->addHeaderSection(array('first' => $headerTextFirstSection, 'default' => $headerImageFirstSection), 0);

// headers in the second section
$headerTextSecondSection = new WordFragment($docx, 'defaultHeader');
$headerTextSecondSection->addText('Header in the second section');

$docx->addHeaderSection(array('default' => $headerTextSecondSection), 1);

// headers in the last section
$headerTextLastSection = new WordFragment($docx, 'firstHeader');
$headerTextLastSection->addText('Header in the first page of the last section');
$headerContentLastSection = new WordFragment($docx, 'defaultHeader');
$imageOptions = array(
	'src' => 'imageP1.png',
	'dpi' => 300,
);
$headerContentLastSection->addImage($imageOptions);

// by default, addHeaderSection adds the headers into the last section
$docx->addHeaderSection(array('first' => $headerTextLastSection, 'default' => $headerContentLastSection));
// -1 as position can also be used to set the last section
//$docx->addHeaderSection(array('first' => $headerTextLastSection, 'default' => $headerContentLastSection), -1);

$docx->createDocx('output');

The resulting Word document looks like this:

Release notes

phpdocx 14.0:
- new method.