MPDF项目中使用命名式页眉页脚的方法详解

前言

在PDF文档生成过程中，页眉页脚的设计是提升文档专业性的重要元素。MPDF作为一款强大的PHP PDF生成库，提供了多种页眉页脚设置方法。本文将重点介绍其中一种灵活且实用的方法——命名式(Named)非HTML页眉页脚设置。

方法概述

命名式页眉页脚方法(Method 3)允许开发者预先定义多个页眉页脚模板，然后在文档不同位置根据需要调用特定的模板。这种方法特别适合需要在文档不同部分使用不同页眉页脚的场景。

注意：从MPDF 6.0版本开始，此方法已被标记为"Deprecated"，因为非HTML内容现在也按照HTML方式处理。但了解此方法仍有助于理解MPDF的工作机制。

核心优势

1. 模板化设计：可预先定义多个页眉页脚模板
2. 灵活调用：在文档任意位置切换不同模板
3. 非HTML格式：适合简单文本型页眉页脚需求
4. 全文档控制：支持奇偶页不同设置

定义命名页眉页脚

PHP数组方式定义

$headerConfig = array (
    'L' => array (  // 左侧内容
        'content' => '第1章',
        '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' => '我的文档',
        'font-size' => 10,
        'font-style' => 'B',
        'font-family' => 'serif',
        'color'=>'#000000'
    ),
    'line' => 1,  // 是否显示分隔线
);

$mpdf->DefHeaderByName('MyHeader1', $headerConfig);

自定义HTML标签方式定义

$html = '
<pagefooter name="MyFooter1"
  content-left="{DATE j-m-Y}" 
  content-center="{PAGENO}/{nbpg}"
  content-right="我的文档" 
  footer-style="font-family: serif; font-size: 8pt;
  font-weight: bold; font-style: italic; color: #000000;" />';

$mpdf->WriteHTML($html);

调用命名页眉页脚

文档开头设置

$mpdf = new \Mpdf\Mpdf();
$mpdf->SetHeaderByName('MyHeader1');
$mpdf->WriteHTML('文档正文内容...');

文档中间切换

// 切换到MyHeader2
$mpdf->AddPage(
    '','','','','','','','','','','',
    'MyHeader2', '', 'MyFooter2', '', 1, 0, 1, 0
);

// 关闭页眉页脚
$mpdf->AddPage('','','','','','','','','','','', '', '', '', '', -1, 0, -1, 0);

使用CSS @page规则

@page {
    odd-header-name: MyHeader1;
    odd-footer-name: MyFooter1;
}
@page chapter2 {
    odd-header-name: MyHeader2;
    odd-footer-name: MyFooter2;
}

实际应用场景

1. 书籍排版：不同章节使用不同页眉
2. 商务报告：封面无页眉，目录特殊页眉，正文常规页眉
3. 学术论文：奇偶页不同页眉设置
4. 多语言文档：不同语言部分使用对应语言的页眉

注意事项

1. 命名时避免使用"html_"前缀，该前缀保留给HTML页眉页脚使用
2. 在文档开头设置页眉时，注意MPDF会在首次WriteHTML()时自动添加页面
3. 使用show-this-page="1"确保首页显示正确页眉
4. 对于单面文档，"ODD"设置将应用于所有页面

总结

虽然命名式非HTML页眉页脚方法在新版MPDF中已被标记为弃用，但理解其工作原理对于深入掌握MPDF的页眉页脚机制仍有价值。这种方法展示了如何通过模板化和命名引用的方式实现复杂文档的页眉页脚管理，这种设计思路值得借鉴。

对于新项目，建议考虑使用HTML方式的页眉页脚设置，以获得更好的兼容性和更丰富的样式控制能力。