How to use Laravel snappy to generate PDF and integrate into Laravel-admin

                                                                                                                                                                                            

The following tutorial column will introduce to you how to use Laravel snappy to generate PDF and integrate it into Laravel-admin. I hope it will be helpful to friends in need!

Laravel snappy

I have used python wkhtmltopdf to export PDF before, wkhtmltopdf is indeed very powerful The tool has many page customization options, and will automatically help you grab images from the Internet and render them into PDF. This time I wanted to implement the function of exporting PDF in Laravel-admin, so I found the extension package Laravel snappy, which is an encapsulation of the project https://github.com/KnpLabs/snappy. Coincidentally, it is also passed Call the wkhtmltopdf program to generate PDF.

Installation and configuration

// 安装扩展包
composer require barryvdh/laravel-snappy

// 将wkhtmltopdf作为composer依赖
// 对于64位系统，使用：
composer require h4cc/wkhtmltopdf-amd64 0.12.x
composer require h4cc/wkhtmltoimage-amd64 0.12.x

For the homestead development environment, you also need to execute:

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

After installation, in

app.config

In the

alias

key set the facade alias (optional): <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class='brush:php;toolbar:false;'>&amp;#39;PDF&amp;#39; =&gt; Barryvdh\Snappy\Facades\SnappyPdf::class, &amp;#39;SnappyImage&amp;#39; =&gt; Barryvdh\Snappy\Facades\SnappyImage::class,</pre><div class="contentsignin">Copy after login</div></div>Finally publish the resource file: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class='brush:php;toolbar:false;'>php artisan vendor:publish --provider=&quot;Barryvdh\Snappy\ServiceProvider&quot;</pre><div class="contentsignin">Copy after login</div></div> in

.env

Add in the file:

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

Then make the following configuration in the snappy.php configuration file:

    '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'     => [],
    ],

Use

Generate PDF by loading the rendering blade template:

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

Generate through external link:

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

Generate through html, make various settings, and save it:

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

Laravel-admin export function transformation

The default export format of Laravel-admin is csv, here we will transform it into the desired PDF format.

Simple analysis of Laravel-admin export principle

Look at the export button, you can get the format of the three export entries as follows:

http://hostname/posts?_export_=all  // 导出全部
http://hostname/posts?_export_=page%3A1 // 导出当前页
http://hostname/posts?_export_=selected%3A1 // 导出选定的行

The corresponding controller method should be

index

. From here, you can find it in

/vendor/encore/laravel-admin/src/Grid.php

：<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class='brush:php;toolbar:false;'>public function render(){ $this-&gt;handleExportRequest(true); try { $this-&gt;build(); } catch (\Exception $e) { return Handler::renderException($e); } $this-&gt;callRenderingCallback(); return view($this-&gt;view, $this-&gt;variables())-&gt;render();}</pre><div class="contentsignin">Copy after login</div></div>If there is _export=... parameter in the url, $this->handleExportRequest(true);The code inside will be executed:

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();  // 这里将调用某个类的export方法
    }}

The most important thing is the export method. We will create a new class that inherits the

AbstractExporter

class to implement the export logic we want. In addition, look at the getExporter method: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class='brush:php;toolbar:false;'>protected function getExporter($scope){ return (new Exporter($this))-&gt;resolve($this-&gt;exporter)-&gt;withScope($scope);}</pre><div class="contentsignin">Copy after login</div></div>We can also rewrite withScope in the subclass to perform some parameter settings and interception.

Start modifying the export function

After understanding the basic principles and referring to the Laravel-admin documentation, we can start changing the export Functional. First, create an extension, such as

app/Admin/Extensions/PdfExporter.php

, the code is implemented as follows:

<?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()
    {
        // 具体的导出逻辑，比如：
        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;);

        // 按年-月分组数据
        $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();
        // 渲染数据到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",
        ];

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

        exit;
    }
}

Then, in app/Admin/ Register the extension in bootstrap.php:

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

Finally, use it in the Grid method:

protected function grid(){
    // 其他逻辑...

    // 添加导出PDF的扩展
    $grid->exporter('pdf-exporter');
    return $grid;}

In this way, when you click the export button, you can Download PDF now.

Notes

The css and js addresses in the blade template must be the complete url address, so mix( 'css/app.css')

should be changed to

asset('css/app.css')
• It is best to use the http protocol instead of https for the image address, which is less error-prone
Finally, post a rendering:

                         

The above is the detailed content of How to use Laravel snappy to generate PDF and integrate into Laravel-admin. For more information, please follow other related articles on the PHP Chinese website!