addFooterSection

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

addFooterSection

ADVANCED / PREMIUM

TRIAL

Inserts footers in a specific section into the Word document.

Description

public addFooterSection ( array $footers [, array $section = -1] [, array $options])

It is possible to include a different footer for:

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

The contents of the different footers are defined via the use of WordFragments. These footer WordFragments allow the insertion of:

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

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

Parameters

footers

An array with the different footer 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 footers 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 footers into the first section
$footerTextFirstSection = new WordFragment($docx, 'firstFooter');
$footerTextFirstSection->addText('Footer in the first section');

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

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

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

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

// add footers 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
$footerTextSecondSection = new WordFragment($docx, 'firstFooter');
$footerTextSecondSection->addText('Footer in the second section');

$footerContentSecondSection = new WordFragment($docx, 'defaultFooter');
$imageOptions = array(
	'src' => 'imageP1.png',
	'dpi' => 300,
    'textWrap' => 1,
);
$footerContentSecondSection->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',
);
$footerContentSecondSection->addPageNumber('numerical', $options);
$footerContentSecondSection->addBreak();

// by default, addFooterSection adds the footers into the last section
$docx->addFooterSection(array('first' => $footerTextSecondSection, 'default' => $footerContentSecondSection));

$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:

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

// footers in the first section
$footerTextFirstSection = new WordFragment($docx, 'firstFooter');
$footerTextFirstSection->addText('Footer in the first section');

$imageOptions = array(
	'src' => 'image.png',
	'dpi' => 300,
);
$footerImageFirstSection = new WordFragment($docx, 'defaultFooter');
$footerImageFirstSection->addImage($imageOptions);
$docx->addFooterSection(array('first' => $footerTextFirstSection, 'default' => $footerImageFirstSection), 0);

// footers in the second section
$footerTextSecondSection = new WordFragment($docx, 'defaultFooter');
$footerTextSecondSection->addText('Footer in the second section');

$docx->addFooterSection(array('default' => $footerTextSecondSection), 1);

// footers in the last section
$footerTextLastSection = new WordFragment($docx, 'firstFooter');
$footerTextLastSection->addText('Footer in the first page of the last section');
$footerContentLastSection = new WordFragment($docx, 'defaultFooter');
$imageOptions = array(
	'src' => 'imageP1.png',
	'dpi' => 300,
);
$footerContentLastSection->addImage($imageOptions);

// by default, addFooterSection adds the footers into the last section
$docx->addFooterSection(array('first' => $footerTextLastSection, 'default' => $footerContentLastSection));
// -1 as position can also be used to set the last section
//$docx->addFooterSection(array('first' => $footerTextLastSection, 'default' => $footerContentLastSection), -1);

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 14.0:
- new method.