addHeaderSection

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:

The resulting Word document looks like this:

Example #2:

The resulting Word document looks like this:

Release notes
  • phpdocx 14.0:
    • new method.