Cookbook

INTRODUCTION

PRACTICAL PHPDOCX

CONVERSION PLUGIN

COOKBOOK

SNIPPETS

API DOCUMENTATION

HTMLAPI DOCUMENTATION

XMLAPI DOCUMENTATION

CASE STUDIES

Generate different headers and footers for multiple sections

If you need to create headers and footers dynamically for multiple sections, you must use an Advanced or Premium license.

There are two approaches to accomplish this task:

Use the addHeaderSection and addFooterSection methods.
Use the MultiMerge class with the mergeDocx method.

To illustrate both possibilities, let's prepare a cover page with no headers or footers in the first page, and then a second page with only a footer and the rest of the pages filled with both headers and footers using sections.

Using addHeaderSection and addFooterSetion methods

This is the easiest approach to generate different headers and footers for sections:

<?php

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

// generate the cover page of the DOCX without neither header nor footer
$docx->addText('Cover page.');

// generate the second section, with footer but no header
$docx->addSection();
$docx->addText('Second page.');
$footerSecondSection = new WordFragment($docx, 'defaultFooter');
$footerSecondSection->addText('Footer text');
$docx->addFooterSection(array('default' => $footerSecondSection));

// generate a new section adding the rest of the pages with both header and footer
$docx->addSection();
$header = new WordFragment($docx, 'defaultHeader');
$header->addImage(array('src' => 'image.png'));
$docx->addHeaderSection(array('default' => $header));
$footer = new WordFragment($docx, 'defaultFooter');
$footer->addText('Footer text');
$docx->addFooterSection(array('default' => $footer));
$docx->addText('Other pages.');

// save the DOCX
$docx->createDocx('output.docx');

Using MultiMerge features

This approach creates a document for each combination of headers and footers and then merges them all in a single DOCX instead of generating a single document with different types of headers and footers:

<?php

require_once 'classes/CreateDocx.php';

// generate the cover page of the DOCX without neither header nor footer
$cover = new CreateDocx();
$cover->addText('Cover page.');
$cover->createDocx('cover');

// generate the second page, with footer but no header
$secondPage = new CreateDocx();
$footerSecondPage = new WordFragment($secondPage, 'defaultFooter');
$footerSecondPage->addText('Footer text');
$secondPage->addFooter(array('default' => $footerSecondPage));
$secondPage->addText('Second page.');
$secondPage->createDocx('second_page');

// generate the rest of the pages with both header and footer
$otherPages = new CreateDocx();
$header = new WordFragment($otherPages, 'defaultHeader');
$header->addImage(array('src' => 'image.png'));
$otherPages->addHeader(array('default' => $header));
$footer = new WordFragment($otherPages, 'defaultFooter');
$footer->addText('Footer text');
$otherPages->addFooter(array('default' => $footer));
$otherPages->addText('Other pages.');
$otherPages->createDocx('other_pages');

// merge all documents to get a single DOCX with all the content while keeping theirs sections with theirs headers and/or footers
$merge = new MultiMerge();
$merge->mergeDocx('cover.docx', array('second_page.docx', 'other_pages.docx'), 'output.docx', array('mergeType' => 0));

Premium licenses allow doing all these steps using in-memory DOCX to get the best performace.

Cookbook

Generate different headers and footers for multiple sections

Using addHeaderSection and addFooterSetion methods

Using MultiMerge features

Related information