DefFooterByName()

(mPDF ≥ 2.0)

DefFooterByName – Define a page footer with a given name

Description

void DefFooterByName ( [ string $name [, array $footer ]])

Define a page footer with a given name. Named footers can be referenced and set later in the document e.g. SetFooterByName()

Note: Do not name any header or footer starting with html_ - This prefix is reserved to identify an HTML header/footer when passing its name in a reference.

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

User-defined name for the footer. If $name= '' (blank) the name _default is used.

$footer

This parameter specifies the content of the page footer as an array.

Default: array()

Values in the array:

L: subarray for left
C: subarray for center
R: subarray for right

Subarray with following entries:
- content: TEXT STRING
- font-size: FLOAT font size in pts
- font-style: 'B' | 'I' | 'BI' | BLANK STRING
- font-family: Any available font-family
- color: CSS #RRGGBB string
line: 0 | 1 - specify whether to draw a line above the footer

<?php

$footer = array (
    'L' => array (
        'content' => '',
        'font-size' => 10,
        'font-style' => 'B',
        'font-family' => 'serif',
        'color'=>'#000000'
    ),
    'C' => array (
        'content' => '',
        'font-size' => 10,
        'font-style' => 'B',
        'font-family' => 'serif',
        'color'=>'#000000'
    ),
    'R' => array (
        'content' => 'My document',
        'font-size' => 10,
        'font-style' => 'B',
        'font-family' => 'serif',
        'color'=>'#000000'
    ),
    'line' => 1,
);

Changelog

Version	Description
2.0	The function was added.

Examples

For examples and further information please see:

DefFooterByName()

Description

Parameters

Changelog

Examples

See Also