Hapicode

# HTML から PDF に変換 PHP ライブラリ mPDF の設定

mPDF について
mpdf ５から長年 mpdf 愛用しておりますが 現在バージョンは８です。公式サイトはまだ v7 のままですが 試したところ使い方は変っていない模様。mpdf は html から pdf に変換するための php ライブラリです。FPDFとHTML2FPDFをベースにして 機能強化及び性能アップして作られたそうです。

mpdf を選ぶ理由

同類のライブラリは複数ありますが 自分が使ってて良かったと思うところ

  • 軽い (他のライブラリよりビルドが速い)
  • 機能性 (改ページ ヘッダー設定 ダウンロード機能など)
  • ライブラリがわかりやすい (config ファイルやマニュアルが詳しい わかりやすい 設定が楽)
  • 多言語対応 (日本語 韓国語 中国語 アラビア語など 文字化けなしで多言語対応)

composer install

composer require mpdf/mpdf

package mpdf/mpdf (opens new window)

php に取り込む

<?php

require_once __DIR__ . '/vendor/autoload.php';

$mpdf = new \Mpdf\Mpdf();
$mpdf->WriteHTML('<h1>Hello world!</h1>');
$mpdf->Output();

# 日本語対応

当初日本語対応するのに フォントをダウンロードしていろいろ設定もいじらなくてはならなかったが バージョン 6 からコンフィグを２行設定するだけで 日本語韓国語中国語が対応できるようになり 非常に便利

config

  • autoScriptToLang
  • autoLangToFont

結論から言うと デフォルトではfalseになっていますが trueにするだけで完了

sample






 
 




<?php

require_once __DIR__ . '/vendor/autoload.php';

$mpdf = new \Mpdf\Mpdf([
    'autoScriptToLang' => true,
    'autoLangToFont' => true,
]);
$mpdf->WriteHTML('<h1>Hello こんにちは 漢字日本語!</h1>');
$mpdf->Output();

$mpdf->autoScriptToLang = true;
$mpdf->autoLangToFont = true;
でも一緒

# mpdf 設定オプション

オプションパラメタ デフォルト 説明
mode utf-8 文字コードや言語
format A4 PDF の書類サイズ
orientation L 書類の向き
default_font_size 14 CSS 設定 フォントサイズ
default_font meiryo CSS 設定 フォントの種類
margin_left 15 左余白
margin_right 15 右余白
margin_top 16 上余白
margin_bottom 16 下余白
margin_header 9 ヘッダー余白
margin_footer 9 フッター余白
$mpdf = new \Mpdf\Mpdf([
	'mode' => 'utf-8', // 文字コードや言語
	'format' => 'A4', // PDF
	'orientation' => 'L', // 書類の向き
	'default_font_size' => 14, // フォントサイズ
	'default_font' => 'meiryo', // フォントの種類
	'margin_left' => 8, // 左余白
	'margin_right' => 8, // 右余白
	'margin_top' => 10, // 上余白
	'margin_bottom' => 10, // 下余白
	'margin_header' => 15, // ヘッダー余白
	'margin_footer' => 15 // フッター余白
]);

# 用紙サイズ指定オプション

用紙サイズ一覧

  • A0 A1 A2 A3 A4 A5 A6 A7 A8 A9 A10
  • B0 B1 B2 B3 B4 B5 B6 B7 B8 B9 B10
  • C0 C1 C2 C3 C4 C5 C6 C7 C8 C9 C10
  • Letter
  • Legal
  • Executive
  • Folio

mPDF のデフォルト用紙は A4

$mpdf = new \Mpdf\Mpdf([
	'format' => 'A4',
]);

任意のサイズを指定する際は配列で縦横を指定

$mpdf = new \Mpdf\Mpdf([
	'format' => [190, 236] // 横190mm、縦236mm
]);

# 用紙向き指定オプション

  • P Portrait 横向き
  • L Landscape 縦向き
$mpdf = new \Mpdf\Mpdf([
	'orientation' => 'L' // 用紙の向きを指定
]);

# フォント変更

デフォルトのフォントは明朝体ぽいが 丸めの IPA ゴシックに変更します。

  1. IPA フォント (opens new window)ダウンロード
  2. フォント TTF ファイルを適切のディレクトリに保存
  3. config 設定変更
    autoScriptToLang autoLangToFont の自動判別機能をオフにして
// デフォルト設定読込
$defaultConfig = (new \Mpdf\Config\ConfigVariables())->getDefaults();
$fontDirs = $defaultConfig['fontDir'];
$defaultFontConfig = (new \Mpdf\Config\FontVariables())->getDefaults();
$fontData = $defaultFontConfig['fontdata'];

// mpdf初期化
$mpdf = new \Mpdf\Mpdf([
    // 'autoScriptToLang' => true,
    // 'autoLangToFont' => true,
    'orientation' => 'L',     // 横向き
    'defaultheaderline' => 0, // ヘッダーアンダーライン消す
    'fontDir' => array_merge($fontDirs, [
        app_path('font'),     // Laravel app/fontディレクトリに保存
    ]),
    'fontdata' => $fontData + [
        'mplus' => [                      // Google フォント
            'R' => 'MPLUS1p-Regular.ttf',
            'B' => 'MPLUS1p-Bold.ttf',
        ],
        'ipag' => [                       // ipag IPAゴシックフォント
            'R' => 'ipag.ttf',
            'B' => 'ipag.ttf',
            'I' => 'ipag.ttf',
            'BI' => 'ipag.ttf',
        ],
        'ipagp' => [                      // ipagp IPAゴシックPフォント
            'R' => 'ipagp.ttf',
            'B' => 'ipagp.ttf',
            'I' => 'ipagp.ttf',
            'BI' => 'ipagp.ttf',
        ],
        'ipaexg' => [                     // ipaexg IPAexgゴシックフォント
            'R' => 'ipaexg.ttf',
            'B' => 'ipaexg.ttf',
            'I' => 'ipaexg.ttf',
            'BI' => 'ipaexg.ttf',
        ],
    ],
    'default_font' => 'ipaexg',           // デフォルトで使うフォント指定
]);

# 縦書き

mPDF はwriting-mode: vertical-rl;CSS の対応していないため スタイルシートで縦書きはできないが プログラムで文字列を配列にして一文字ずつ出力することで縦書き風にします。

foreach (preg_split('//u', $str_item, -1, PREG_SPLIT_NO_EMPTY) as $value){
    echo $value . '<br />';
}

# トータルページ番号表示

ヘッダーかフッターにページ番号と合計ページ数表示する時

// ヘッダーに設定
$mPDF->setHeader('{PAGENO} / {nb}ページ');

// フッターに設定
$mPDF->setFooter('{PAGENO} / {nb}ページ');

ヘッダー フッターに使えるエリアス

  • {PAGENO} ページ番号
  • {nb} トータルページ数
  • {DATE j-m-Y H:m} 日付時間 PHP date 関数

# config 設定

# Paging ページ関連

項目 デフォルト 備考
mirrorMargins (opens new window) 0 1に設定すると ドキュメントは奇数ページと偶数ページの左右のマージン値をミラーリングします。つまり 内側と外側のマージンになります。
forcePortraitMargins (opens new window) false デフォルトのページ方向が P（縦）の場合 新しいページ L（横）を追加すると 左/右マージンが上/下として使用され 逆も同様
displayDefaultOrientation (opens new window) false デフォルトのページの向きが P（縦）の場合 ドキュメント内の L（ランドスケープ）ページは Adobe Reader で表示され 縦に表示
autoPageBreak (opens new window) true 自動改ページを許可するかどうかを指定
setAutoTopMargin (opens new window) false ドキュメントの上部余白を定義する動作を指定
setAutoBottomMargin (opens new window) false 下·部余白を定義
autoMarginPadding (opens new window) 2 「ストレッチ」モードで 上部マージンとヘッダーの間のパディングを指定
margBuffer (opens new window) 2 （空の）ブロックの終わりがこの量（mm）だけ下マージンを超えて広がることを許可
printers_info (opens new window) false @page および marks：crop を使用するときに プリンターの日付とページ情報を追加
bleedMargin (opens new window) 5 @page メディアで使用されるデフォルトの裁ち落としマージンをミリメートル単位で設定
crossMarkMargin (opens new window) 5 マージンからの十字マークの距離（mm）
cropMarkMargin (opens new window) 8 マージンからクロップマークまでの距離（mm）
cropMarkLength (opens new window) 18 クロップラインの mm 単位のデフォルトの長さ
nonPrintMargin (opens new window) 8 用紙の端の印刷不可能な境界（mm）
defaultPagebreakType (opens new window) cloneall <改ページ/>を使用して 強制改ページの改ページを入力します。

# Page numbering

項目 デフォルト 備考
aliasNbPg (opens new window) {nb} ドキュメント内の合計ページ番号で置換されるテキストを定義する変数
aliasNbPgGp (opens new window) {nbpg} ページグループ内の合計ページ番号で置換されるテキストを定義する変数
pagenumPrefix (opens new window) {PAGENO}を使用してヘッダーまたはフッターにページ番号を挿入する場合 ページ番号の前にテキストを指定
pagenumSuffix (opens new window) {PAGENO}を使用してヘッダーまたはフッターにページ番号を挿入するときに ページ番号に続くテキストを指定
nbpgPrefix (opens new window) {nbpg}によって生成されたページ合計の前にテキストを指定
nbpgSuffix (opens new window) {nbpg}によって生成されたページの合計に従うテキストを指定
defaultPageNumStyle (opens new window) 1 ドキュメントの最初から使用するデフォルトのページ番号スタイルを指定

# Fonts, Languages and Character sets

項目 デフォルト 備考
autoScriptToLang (opens new window) false
autoLangToFont (opens new window) false

# Page Headers & Footers

項目 デフォルト 備考
defaultfooterfontsize 8
defaultfooterfontstyle BI
defaultfooterline 1
defaultheaderfontsize 8
defaultheaderfontstyle BI
defaultheaderline 1
footer_line_spacing 0.25
header_line_spacing 25
forcePortraitHeaders false

# 参考

mPDF 公式マニュアル(英語) (opens new window)

# The HTML code size is larger than pcre.backtrack_limit 1000000 エラー

一気に複数ページの PDF 作成する作業で backtrack_limit エラー発生があったが デフォルト値を変更したら治りました。

ini_set("pcre.backtrack_limit", "5000000");
2019-12-12
  • php

関連記事

Laravel メンテナンスモード

Laravelのメンテナンスモードの使い方 Artisan down コマンド使ってメンテナンスモー...

Laravel でカテゴリー作成 テーブル構築と再帰クエリ

カテゴリ関係を管理するためのテーブルを設計...

Laravel を API サーバーとしての初期設定

Laravel インストールからローカル環境のSail docker開発、初期設定までプロジェクト構...

Laravel リクエストログ出力

Laravelでリクエストログを出力する手順をまとめました。...

Carbon で php date 日付の日数・月数差を計算

Laravel Carbonは、DateTimeクラスよりもシンプルで読みやすいコードを書くことがで...

Laravel 429 Too Many Requests

Laravel 19使ってAPIサーバー構築とフロントはReact nextjsで構築しています。複...

Laravel Email バリデーションについて

Laravel Validation Email チェックする際の注意点、バリデーションルールオプシ...

Laravel Sanctum 使って API トークン JWT 認証と SPA 認証

Laravel JWT APIトークンの仕組みと Laravel Sanctum SPA認証使って認...

Laravel logger でエラーログを chatwork に自動送信

Laravel 使ってエラー発生した場合、chatworkにエラー内容をリアルタイムで連絡するcha...

php CSV データ取得は fgetcsv 使う

PHP csvアップロードしてデータインポート作業がありましたが、fgetcsv使ってcsv処理につ...

Laravel tinker 使って DB データベース接続とコマンド

Laravel tinker REPLツール使ってDBアクセス、環境確認など対話式で楽しく遊べる...

Laravel Test についてのメモ

Laravel自動テスト行う際のコマンドと設定 faker 使ってデータ生成...

Laravel Log の基本設定＆使い方

Laravel Logの基本設定 エラー発生時にslackに連絡通知する設定方法 tailコマンド使...

Exception: Class 'ZipArchive' not found

エクセル操作でZipArchive classが見つからないエラーがあったので、対応しました。...

Laravel Sail で Docker 環境構築

Laravel Sail で Docker 開発環境PHP Mysql phpMyAdmin構築 s...

PHP 文字列長さ・文字列の幅を取得方法

PHP 文字列操作関数 マルチバイト文字列日本語韓国語中国語の長さ取得など...

Codeigniter 画像アップロードとリサイズ

Codeigniter アップロード画像リサイズと回転するなど画像操作するライブラリの使い方...

Laravel Lumen Faker 日本語設定

Laravel Faker 日本語化設定 fakerphpの使い方とよく使うオプション 名前や住所の...

laravel method の基本 get post put options

Laravel Routeでget post メソッド同時に設定したい！Laravel ルート制約の...

Laravel schedule 設定

Laravel スケジュール管理の基本とtimezone設定などlaravel 8最新メソッド説明...

Class 'Imagick' not found Error

phpで画像操作したらimagickエラーで動かなくなったため、imagickモジュールをインストを...

Laravel eloquent model の規約

最新Laravel開発eloquent model設定資料まとめ...

PHP mbconvertkana 全角半角英数カナ変換

php カナコンバートなら mb_convert_kana を使う！全角半角、英数字や記号など簡単に...

Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得

codeigniter host url取得方法と APPPATH BASEPATHの意味を紹介...

Laravel timestamp() auto update 有効化無効化

Laravel updated_at timestamp自動にしたい！MysqlはすぐにできるけどS...

Lumen8 で JWT ユーザー認証

Lumen8でJWT認証のAPIサーバー構築してみた、便利になった時代だなあ...

Laravel toSql パラメータ付きで出力

Laravel Query Builder toSqlで出力したsql文にパラメータを自動でセット...

Lumen8 で API 開発

codeigniter 愛用者がLumenでAPIサーバーを立ててみた...

php Exception エラーキャッチでメール送信

エラーメッセージ、エラーコード、エラー詳細取得、php例外処理exceptionのいろいろ...

Smarty HTTP URL 取得できるサーバー関数

スマーティで取得するサーバー関数URLとenvなど...

Laravel blade foreach loop と current url

laravel blade foreach loop変数とurlのプロパティ対照表...

laravel session を制する

laravel sesssion 使い方を紹介、読込保存削除を使えるようになったらsession制覇...

PHP empty isset is_null の違い

PHP empty, isset, is_nullの違い よく使うPHP isset と if の違...

PHP 8 リリース新機能と変更

php8がリリースされたので、新機能と特徴などの資料まとめました。25周年迎えたPHPは更に速いプロ...

FlattenException deprecated

laravelバージョンアップ作業する際にFlattenException deprecatedにつ...

php.ini 初期設定のいろいろ

php ini ローカル環境や新規リモート環境の初期設定...

Laravel 5.1 から 8.1 にバージョンアップ

laravel5 から8にアップグレードする際に遭遇したエラーとカスタマイズauth認証の設定を修正...

PHP 7.4 にアップグレードして使えなくなる機能

php 5 から php7.4 にアップする作業があったので、アップグレード時のエラーと7.4では動...

開発時によく使うゼロ埋めパディング作業まとめ

mysql twig phpとjavascriptでよく使うゼロ埋めのいろいろ...

解決！phpMyAdmin テーブル構造の内容が表示されない問題

phpmyadmin5.0.1のxampp入れたら テーブル構造メニューが真っ白になって表示されない...

Composer コマンドとオプション

composer install updateの違い post-install-cmdとpost-u...

爆速軽量フレームワーク codeigniter PHP 開発

ルーター設定もなく、初期設定も少ない！軽量と爆速で動いてくれるフレームワーク codeigniter...

nuxtjs と codeigniter で jwt システム構築

nuxtjsとcodeigniterでシステム構築する際のメモ...

Lumen と Laravel 違い比較

軽量で速いマイクロフレームワークlumenとlaravelの違い、使い方比較と本当にlumen必要か...

twig 3 人気 PHP テンプレートエンジンがバージョンアップ

以前からtwigテンプレートエンジン使っていて、非常にパワーフルで使いやすさに魅了しました。15日に...

開発におけるコーディングルール・規約

コーディングルールと規約を大事にする、複数人で開発しても、一人で開発してもメンテナンスやコードのわか...

Laravel Error についてのメモ

laravelを使う時に出てくるエラー対応...

laravel に vuejs 使うための初期設定

PHPフレームワークlaravelにvuejs入れる時の初期設定まとめ、備忘録的...

php curl 使って クリックなしで POST 送信

PHP curl_setopt使ってシンプルにデータ転送してpost投げます。PHPは本当に短いソー...

allowurlinclude の設定で ftp_connect()エラー

FTPサーバーとやりとりする時にftp_connect()エラーが発生、PHP７にアップしたばかりで...

codeigniter email ライブラリでメール送信 日本語対応

codeigniterメール送信で日本語文字化け対策、改行コードとSMTP項目設定...

正規表現一覧 よく使う検索・置換のパターン

よく使う正規表現、文字検索・置換をまとめてみました。...

Apache 初期設定メモ

LAMP環境のApache初期設定メモ...