SetHeaderByName()
(mPDF ≥ 2.0)
SetHeaderByName – Sets a page header by a given name
Description
void SetHeaderByName ( string $name [, string $side [, boolean $write ]])
Sets a page header that has previously been defined by name.
Note: This function/method was altered in mPDF 2.2 by capitalising the first letter of the name. As function/method names in PHP have hitherto been case-insensitive, this should not cause any problems, but it is recommended where possible to use the preferred spelling.
Parameters
- $name
-
This parameter specifies the name of a previously defined page header. If a BLANK string or
nullis passed, mPDF will use the value_defaultif such a page header exists. - $side
-
Specify whether to set the header for ODD or EVEN pages in a DOUBLE-SIDED document.
Values (case-sensitive)
'O'- set the header for ODD pages in a DOUBLE-SIDED document, or for both ODD and EVEN in a SINGLE-SIDED document.
'E'- set the header for EVEN pages
Default:
'O' - $write
-
If
trueit forces the Header to be written immediately to the current page. Use if the header is being set after the new page has been added.Default:
false
Changelog
| Version | Description |
|---|---|
| 2.0 | The function was added. |
Examples
For examples and further information please see:
