? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

下面由Laravel教程欄目給大家介紹使用Laravel snappy生成PDF并集成到Laravel-admin的方法，希望對需要的朋友有所幫助！

Laravel snappy

之前使用過python wkhtmltopdf來導(dǎo)出PDF，wkhtmltopdf確實(shí)是很強(qiáng)大的工具，有很多的頁面定制選項(xiàng)，而且會自動幫你把網(wǎng)上的圖片抓取下來，渲染到PDF上。這次想在Laravel-admin中實(shí)現(xiàn)導(dǎo)出PDF的功能，于是找到了Laravel snappy這個擴(kuò)展包，它是對https://github.com/KnpLabs/snappy這個項(xiàng)目的封裝，好巧的是，它也是通過調(diào)用wkhtmltopdf程序來生成PDF的。

安裝與配置

// 安裝擴(kuò)展包
composer require barryvdh/laravel-snappy

// 將wkhtmltopdf作為composer依賴
// 對于64位系統(tǒng)，使用：
composer require h4cc/wkhtmltopdf-amd64 0.12.x
composer require h4cc/wkhtmltoimage-amd64 0.12.x

對于homestead開發(fā)環(huán)境，還要執(zhí)行：

cp vendor/h4cc/wkhtmltoimage-amd64/bin/wkhtmltoimage-amd64 /usr/local/bin/
cp vendor/h4cc/wkhtmltopdf-amd64/bin/wkhtmltopdf-amd64 /usr/local/bin/

chmod +x /usr/local/bin/wkhtmltoimage-amd64 
chmod +x /usr/local/bin/wkhtmltopdf-amd64

安裝完后，在app.config中alias鍵設(shè)置facade別名（可選）：

'PDF' => Barryvdh\Snappy\Facades\SnappyPdf::class,
'SnappyImage' => Barryvdh\Snappy\Facades\SnappyImage::class,

最后發(fā)布資源文件：

php artisan vendor:publish --provider="Barryvdh\Snappy\ServiceProvider"

在.env文件中添加：

WKHTML_PDF_BINARY=/usr/local/bin/wkhtmltopdf-amd64
WKHTML_IMG_BINARY=/usr/local/bin/wkhtmltoimage-amd64

然后在snappy.php配置文件中做如下配置：

    'pdf' => [
        'enabled' => true,
        'binary'  => env('WKHTML_PDF_BINARY', 'vendor/h4cc/wkhtmltopdf-amd64/bin/wkhtmltopdf-amd64'),
        'timeout' => 3600,
        'options' => [],
        'env'     => [],
    ],

    'image' => [
        'enabled' => true,
        'binary'  => env('WKHTML_IMG_BINARY', 'vendor/h4cc/wkhtmltoimage-amd64/bin/wkhtmltoimage-amd64'),
        'timeout' => 3600,
        'options' => [],
        'env'     => [],
    ],

使用

通過加載渲染blade模板生成PDF：

$pdf = PDF::loadView('pdf.invoice', $data); //pdf.invoice是你的blade模板
return $pdf->download('invoice.pdf');

通過外部鏈接生成：

return PDF::loadFile('http://www.github.com')->inline('github.pdf');

通過html生成，并做各種設(shè)置，并保存之：

PDF::loadHTML($html)->setPaper('a4')->setOrientation('landscape')->setOption('margin-bottom', 0)->save('myfile.pdf')
// 更多選項(xiàng)可查看wkhtmltopdf的手冊：https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

Laravel-admin導(dǎo)出功能改造

Laravel-admin默認(rèn)的導(dǎo)出格式是csv，這里將把它改造成想要的PDF格式。

Laravel-admin導(dǎo)出原理簡單分析

查看導(dǎo)出按鈕，可得到這三個導(dǎo)出入口格式大概如下：

http://hostname/posts?_export_=all  // 導(dǎo)出全部
http://hostname/posts?_export_=page%3A1 // 導(dǎo)出當(dāng)前頁
http://hostname/posts?_export_=selected%3A1 // 導(dǎo)出選定的行

其有對應(yīng)的控制器方法應(yīng)該是index，從這里追查開去，可以找到/vendor/encore/laravel-admin/src/Grid.php中有：

public function render(){
    $this->handleExportRequest(true);  
    try {
        $this->build();
    } catch (\Exception $e) {
        return Handler::renderException($e);
    }
    $this->callRenderingCallback();
    return view($this->view, $this->variables())->render();}

如果url中有帶_export=…參數(shù)，將會執(zhí)行$this->handleExportRequest(true);這里面的代碼：

protected function handleExportRequest($forceExport = false){
    if (!$scope = request(Exporter::$queryName)) {
        return;
    }

    // clear output buffer.
    if (ob_get_length()) {
        ob_end_clean();
    }

    $this->disablePagination();

    if ($forceExport) {
        $this->getExporter($scope)->export();  // 這里將調(diào)用某個類的export方法
    }}

最關(guān)鍵的是export方法，我們將新建一個繼承AbstractExporter類的類，實(shí)現(xiàn)我們自己想要的導(dǎo)出邏輯。另外，看getExporter方法：

protected function getExporter($scope){
    return (new Exporter($this))->resolve($this->exporter)->withScope($scope);}

我們還可以在子類中改寫withScope進(jìn)行一些參數(shù)設(shè)置、攔截。

開始改造導(dǎo)出功能

了解了基本的原理，再參考下Laravel-admin的文檔，我們就可以著手改下導(dǎo)出功能了。

首先，創(chuàng)建一個擴(kuò)展，如app/Admin/Extensions/PdfExporter.php，代碼實(shí)現(xiàn)如下：

<?php

namespace App\Admin\Extensions;

use Encore\Admin\Grid\Exporters\AbstractExporter;
use Encore\Admin\Grid\Exporter;
use PDF;

class PdfExporter extends AbstractExporter
{
    protected $lackOfUserId = false;

    public function withScope($scope){
        // 你自己的一些處理邏輯，比如：
        /*if ($scope == Exporter::SCOPE_ALL) {
            if(request()->has(&#39;user_id&#39;)) {
                $this->grid->model()->where(&#39;user_id&#39;, request()->user_id);
            } else {
                $this->lackOfUserId = true;
            }
            return $this;
        }*/
        return parent::withScope($scope);
    }

    public function export()
    {
        // 具體的導(dǎo)出邏輯，比如：
        if($this->lackOfUserId) {
            $headers = [
                &#39;Content-Encoding&#39;    => &#39;UTF-8&#39;,
                &#39;Content-Type&#39;        => &#39;text/html;charset=UTF-8&#39;,
            ];
            response(&#39;請先篩選出用戶&#39;, 200, $headers)->send();
            exit();
        }
        $author = $this->grid->model()->getOriginalModel()->first()->user->user_name;

        $this->grid->model()->orderBy(&#39;add_time&#39;, &#39;desc&#39;);

        // 按年-月分組數(shù)據(jù)
        $data = collect($this->getData())->groupBy(function ($post) {
            return Carbon::parse(date(&#39;Y-m-d&#39;,$post[&#39;add_time&#39;]))->format(&#39;Y-m&#39;);
        })->toArray();
        // 渲染數(shù)據(jù)到blade模板
        $output = PDF::loadView(&#39;pdf.weibo&#39;, compact(&#39;data&#39;))->setOption(&#39;footer-center&#39;, &#39;[page]&#39;)->output();

        $headers = [
            &#39;Content-Type&#39;        => &#39;application/pdf&#39;,
            &#39;Content-Disposition&#39; => "attachment; filename=$author.pdf",
        ];

        // 導(dǎo)出文件，
        response(rtrim($output, "\n"), 200, $headers)->send();

        exit;
    }
}

接著，在app/Admin/bootstrap.php中注冊擴(kuò)展：

Exporter::extend('pdf-exporter', PdfExporter::class);

最后，對應(yīng)的在Grid方法中使用：

protected function grid(){
    // 其他邏輯...

    // 添加導(dǎo)出PDF的擴(kuò)展
    $grid->exporter('pdf-exporter');
    return $grid;}

這樣，點(diǎn)擊導(dǎo)出按鈕的時候，就可以下載PDF了。

注意事項(xiàng)

• blade模板中的css、js地址必須是完整的url地址，所以mix('css/app.css')應(yīng)該改為asset('css/app.css')
• 圖片地址最好使用http協(xié)議代替https，比較不容易出錯

最后，貼個效果圖吧：

? ? ? ? ? ? ? ? ? ? ? ? ? ?

以上是如何使用Laravel snappy生成PDF并集成到Laravel-admin的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！