wkhtmltopdfの使い方｜atLastの意味不なblog

wkhtmltopdfの使い方

2016年7月 7日｜23:55

Debian+PHPでwkhtmltopdf を触る機会があったので、軽くまとめを。

まずこれはなんぞや。ってところから。

帳票出力したりするのに、PDFを出力することがよくありますよね。
そんなときに使えるミドルウェアの一つです。
ほかにも、mPDFとか、TCPDF とかがあります。

そんな中でも、頭一つ飛び抜けているのが、今回利用したwkhtmltopdfです。

HTMLからPDFを得ることが出来るのですが、HTMLの解釈部分にWebKitが使われており
CSS3やHTML5等ももそのままの形で出力できます。

で。帳票というと、Header, Footer(見出しとページ数とか)がつきものですよね。。

Debianを利用している環境であれば

# apt-get install wkhtmltopdf

でインストールし

$ wkhtmltopdf http://www.yahoo.co.jp yahoo.pdf

といった感じで、pdf出力ができます。

----------- ここから先は、header, footerを利用する人のみ必要な箇所です。 ---------------------

上記のバージョンではQTのパッチがあたっていないためheader, footerを指定することが出来ません。

なので、もしインストールしている人は

# apt-get purge wkhtmltopdf

するか、インストールしっぱなしでもいいので、公式サイトからパッケージをダウンロードして展開する必要があります。

公式サイトから、最新(2016/07/08時点では、0.12.3.2 が最新でした。

で、このファイル、よく見るとxz という拡張子がついており、tar.gzのように、tar xzvf では解凍できません。
tar Jxvf wkhtmltox-0.12.3_linux-generic-amd64.tar.xz
で、解凍します(tarのバージョンによります。詳しくはググってください)
また、上記はx64です。i386の場合は、素直にx86バージョンをダウンロードして下さい。

解凍したフォルダを、/usr/local/wkhtmltopdf 等にコピー(移動でもかまいませんよ？)して・・・
いよいよ、本番のheader, footerを入れる作業に入ります。

まず、footerに挿入するhtmlを用意します。名前はfooter.htmlとします。
wkhtmltopdfでは、javascriptの認識や実行、また、pdf出力時に動的に変わる値
(ページ数など)を取得できる機能がついているので、最大限利用しましょう。

<!DOCTYPE html>
    <body>
        <div style="display: inline-block; text-align:left; width: 48%;">
            <span id="current_date"></span>
        </div>
        <div style="display: inline-block; text-align:right; width: 48%;">
            Page <span style="display: inline-block;" id="current_page"></span> of <span style="display: inline-block;" id="page_count"></span>
        </div>
        <script type="text/javascript">
             var pdfInfo = {};
             var x = document.location.search.substring(1).split('&');
             for (var i in x) { var z = x[i].split('=',2); pdfInfo[z[0]] = unescape(z[1]); }
             function getPdfInfo() {
                var page = pdfInfo.page || 1;
                var pageCount = pdfInfo.topage || 1;
                var date = pdfInfo.date || 1;
                document.getElementById('current_page').textContent = page;
                document.getElementById('page_count').textContent = pageCount;
                document.getElementById('current_date').textContent = date;
              }
              getPdfInfo();
        </script>
    </body>
</html>

次に、headerに入れるhtmlを準備します。名前は、header.htmlとします。
こちらは、適当でかまいません。タイトルとか。

<!DOCTYPE html>
<html lang="ja">
    <head>
        <meta charset="UTF-8">
        <title></title>
    </head>
    <body>
        Yahoo to PDF
    </body>
</html>

準備が整ったら、wkhtmlでpdfの生成を行います。

$ wkhtml --header-html header.html --footer-html footer.html http://www.yahoo.co.jp yahoo.pdf

上記で、ヘッダーとフッター、ページ数付きのpdfが出力されます。

どなたかのお役にたてれば幸いです。

atLastの意味不なblog

頑張って復興中

wkhtmltopdfの使い方

コメント