首页
/ MPDF项目教程:使用运行时非HTML方法设置页眉页脚

MPDF项目教程:使用运行时非HTML方法设置页眉页脚

2025-06-03 17:34:34作者:邓越浪Henry

前言

在PDF文档生成过程中,页眉和页脚的设置是非常常见的需求。MPDF作为一款强大的PHP PDF生成库,提供了多种设置页眉页脚的方法。本文将详细介绍第一种方法——运行时非HTML方法(Method 1),这是最简单快捷的设置方式,适合对样式控制要求不高的场景。

方法概述

运行时非HTML方法(RUNTIME NON-HTML)是MPDF中设置页眉页脚的基础方式,具有以下特点:

  1. 适用于整个文档的统一页眉页脚设置
  2. 配置简单,代码量少
  3. 对样式控制能力有限
  4. 在MPDF 6.0及以上版本已被标记为废弃

基本使用方式

最简单的字符串形式(Variant 1)

$mpdf = new \Mpdf\Mpdf();
$mpdf->SetHeader('文档标题');
$mpdf->WriteHTML('文档正文内容');
$mpdf->Output();

这种方式会在奇数页右侧和偶数页左侧(如果是双面文档)显示页眉,或者在所有页面的右侧显示页眉。

分割字符串形式(Variant 2)

$mpdf = new \Mpdf\Mpdf();
$mpdf->SetHeader('左侧文本|居中文本|{PAGENO}');
$mpdf->SetFooter('页脚文本');
$mpdf->WriteHTML('文档正文内容');
$mpdf->Output();

使用|符号将字符串分为三部分,分别对应左、中、右三个位置的页眉内容。{PAGENO}是页码占位符,会自动替换为当前页码。

使用变量控制样式(Variant 3)

$mpdf = new \Mpdf\Mpdf();
$mpdf->SetHeader('文档标题|居中文本|{PAGENO}');
$mpdf->SetFooter('页脚文本');

// 设置样式变量
$mpdf->defaultheaderfontsize = 10;
$mpdf->defaultheaderfontstyle = 'B';
$mpdf->defaultheaderline = 0;
$mpdf->defaultfooterfontsize = 10;
$mpdf->defaultfooterfontstyle = 'BI';
$mpdf->defaultfooterline = 0;

$mpdf->WriteHTML('文档正文内容');
$mpdf->Output();

通过设置MPDF的默认样式变量,可以控制页眉页脚的基本样式。

高级数组配置方式

基础数组形式(Variant 4 - 已废弃)

虽然已废弃,但了解其结构有助于理解更复杂的配置:

$arr = [
    'odd' => [
        'L' => [
            'content' => '',
            'font-size' => 10,
            'font-style' => 'B',
            'font-family' => 'serif',
            'color' => '#000000'
        ],
        // C和R配置类似...
        'line' => 1
    ],
    'even' => []
];
$mpdf->SetHeader($arr);

推荐数组形式(Variant 5)

$arr = [
    'L' => [
        'content' => '第1章',
        'font-size' => 10,
        'font-style' => 'B',
        'font-family' => 'serif',
        'color' => '#000000'
    ],
    // C和R配置类似...
    'line' => 1
];

// 'O'表示奇数页配置
$mpdf->SetHeader($arr, 'O');

这种方式可以精确控制每个位置的样式,并且可以单独设置奇偶页的不同样式。

文档中间修改页眉页脚

在文档生成过程中修改页眉页脚需要特别注意执行顺序:

  1. 在分页前设置新的页眉
  2. 在分页后设置新的页脚
$mpdf = new \Mpdf\Mpdf();

// 第一部分
$mpdf->SetHeader('第一部分页眉');
$mpdf->SetFooter('第一部分页脚');
$mpdf->WriteHTML('第一部分内容...');

// 在分页前设置新页眉
$mpdf->SetHeader('第二部分页眉');
$mpdf->AddPage();

// 在分页后设置新页脚
$mpdf->SetFooter('第二部分页脚');
$mpdf->WriteHTML('第二部分内容...');

$mpdf->Output();

对于双面文档,确保从偶数页开始新章节:

// 确保在偶数页结束当前部分
$mpdf->AddPage('', 'E');

// 现在知道下一页是奇数页
$mpdf->SetHeader('新章节页眉');
$mpdf->AddPage();
$mpdf->SetFooter('新章节页脚');

与目录配合使用

当文档包含目录时,使用运行时方法会变得复杂。建议考虑使用命名方法(NAMED methods)替代。以下是基本实现方式:

// 设置不同部分的页眉页脚数组
$intro_header_odd = [...];
$main_header_odd = [...];
// 其他配置类似...

// 设置引言部分
$mpdf->setHeader($intro_header_odd, 'O');
// 其他设置...

$mpdf->AddPage('', '', 1, '', 'on'); // 引言部分不显示页码
$mpdf->WriteHTML('引言内容...');

$mpdf->AddPage('', 'E'); // 确保从偶数页开始

// 设置正文部分页眉
$mpdf->setHeader($main_header_odd, 'O');
// 其他设置...

// 添加目录
$mpdf->TOCpagebreak(...);

// 设置正文部分页脚
$mpdf->setFooter($main_footer_odd, 'O');
// 其他设置...

$mpdf->WriteHTML('正文内容...');
$mpdf->Output();

注意事项

  1. 在MPDF 6.0及以上版本,此方法已被标记为废弃
  2. 使用数组形式时,未定义的样式属性会使用文档默认值而非页眉页脚默认值
  3. 对于复杂文档,建议考虑其他更灵活的方法
  4. 修改页眉页脚时要注意执行顺序,特别是在分页前后

总结

运行时非HTML方法虽然简单易用,但在复杂文档中会显得不够灵活。对于简单的文档生成需求,它仍然是一个快速有效的解决方案。随着MPDF版本的更新,建议开发者逐步转向更现代的页眉页脚设置方法。

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
895
531
KonadoKonado
Konado是一个对话创建工具,提供多种对话模板以及对话管理器,可以快速创建对话游戏,也可以嵌入各类游戏的对话场景
GDScript
21
13
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
85
4
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
372
387
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.09 K
0
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
94
15
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
625
60
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
401
377