包简介

This bundle provides a wrapper for using the typeset.sh pdf engine.

README 文档

README

This bundle is simple wrapper for the typeset.sh pdf engine.

Typeset.sh is a css/html layout engine that allows to render as PDF.

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require typesetsh/pdf-bundle

Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in config/bundles.php file of your project:

return [
    // [...]
    Typesetsh\PdfBundle\TypesetshPdfBundle::class => ['all' => true],
];

Usage

Render a view as pdf. You can use the abstract controller to render a twig view as pdf.

<?php

namespace App\Controller;

use Symfony\Component\HttpFoundation\HeaderUtils;
use Typesetsh\PdfBundle;

class TestController extends PdfBundle\Controller\AbstractController
{
    public function printOrder()
    {
        $order = new \stdClass();

        return $this->pdf(
            'pdf/invoice.html.twig',
            ['order' => $order],
            'test.pdf',
            HeaderUtils::DISPOSITION_INLINE
        );
    }
}

Alternative you can also use dependency injection to retrieve the pdf generation and do with it as you wish.

<?php

use Typesetsh\PdfBundle\PdfGenerator;

class PrintService
{
    /** @var PdfGenerator */
    private $pdfGenerator;

    public function __construct(PdfGenerator $pdfGenerator)
    {
        $this->pdfGenerator = $pdfGenerator;
    }

    public function execute()
    {
        $html = '...';

        $result = $this->pdfGenerator->render($html);
        $result->toFile('./somefile.pdf');
        $result->asString();

    }
}

Configuration

# /config/packages/typesetsh_pdf.yaml

typesetsh_pdf:
  # List of allowed directories to load external resources (css, images, fonts,...)
  allowed_directories:
    - '%kernel.project_dir%/public'

  # Default base dir - Used when view URIs use relative path /
  base_dir: '%kernel.project_dir%/public'

  http:
    # Allow to download external resources via http(s)
    allow: false
    # Cache dir fir files downloaded via http(s)
    cache_dir: '%kernel.cache_dir%/typesetsh'
    # Maximum file size in bytes to download via http(s)
    download_limit: 1048576
    # Timeout in seconds when downloading files
    timeout: 5

Security

Make sure to only whitelist the directories that do not contain any sensitive information to prevent leaking any data. If your templates are escaped correctly this should never be an issue, yet it's always good to ignore any resource that is not whitelisted in allowed_directories.

By default only the /public directory is allowed. If you like to add any other directory you must whitelist it first.

HTML template example

Many CSS features are supported. See typeset.sh for more details and demos.

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <title>test</title>
        <style>
            @page {
                size: A4;
                margin: 10mm 20mm;
            }
            @font-face {
                font-family: "my font";
                src: url("/fonts/my-font.otf");
                font-weight: 400;
            }
            @font-face {
                font-family: "my font";
                src: url("/fonts/my-font.otf");
                font-weight: 800;
            }
            html {
                font-family: "my font", serif;
                font-size: 12pt;
            }
        </style>
    </head>
    <body>
        <h1>Your lucky number is {{ number }}</h1>
        <p>Some text....</p>
    </body>
</html>

License

This bundle is under the MIT license.

However, it requires a version of typeset.sh to work.

typesetsh/pdf-bundle 适用场景与选型建议

typesetsh/pdf-bundle 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 27.19k 次下载、GitHub Stars 达 11，最近一次更新时间为 2020 年 01 月 06 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 typesetsh/pdf-bundle 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 typesetsh/pdf-bundle 我们能提供哪些服务？

定制开发 / 二次开发

基于 typesetsh/pdf-bundle 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

typesetsh/pdf-bundle

包简介