Skip to content

CodeIgniter 包

TCPDF-Next CodeIgniter
CodeIgniter · LGPL-3.0

CodeIgniter 包为 TCPDF-Next 提供 CodeIgniter 4 集成 — 服务注册、控制器用的 Library 类、基于队列的异步生成,以及附带 OWASP 安全头的 HTTP 响应辅助。

安装

bash
composer require yeeefang/tcpdf-next-codeigniter

依赖: CodeIgniter ^4.0、PHP ^8.5

配置

发布配置文件:

bash
php spark tcpdf-next:publish
php
// app/Config/TcpdfNext.php
namespace Config;

use CodeIgniter\Config\BaseConfig;

class TcpdfNext extends BaseConfig
{
    public string $fontsDirectory = WRITEPATH . 'fonts';
    public string $defaultPageSize = 'A4';
    public string $defaultOrientation = 'portrait';
    public bool $autoPageBreak = true;
    public float $marginBottom = 25.0;
}

Service 用法

在控制器中使用服务:

php
namespace App\Controllers;

use Yeeefang\TcpdfNext\CodeIgniter\Services\TcpdfNextService;

class InvoiceController extends BaseController
{
    public function download(int $id)
    {
        $invoice = model('InvoiceModel')->find($id);

        $pdf = service('tcpdfnext')->create()
            ->setTitle("Invoice #{$invoice->number}")
            ->addPage()
            ->setFont('Helvetica', '', 12)
            ->cell(0, 10, "Invoice #{$invoice->number}");

        return service('tcpdfnext')->response($pdf, "invoice-{$invoice->number}.pdf");
    }
}

Library 用法

也可以使用 Library 类:

php
namespace App\Controllers;

use Yeeefang\TcpdfNext\CodeIgniter\Libraries\PdfLibrary;

class ReportController extends BaseController
{
    public function generate()
    {
        $pdfLib = new PdfLibrary();

        $pdf = $pdfLib->create()
            ->setTitle('Monthly Report')
            ->addPage()
            ->setFont('Helvetica', 'B', 16)
            ->cell(0, 10, 'Monthly Report', newLine: true);

        return $pdfLib->inline($pdf, 'report.pdf');
    }
}

HTTP 响应

响应辅助方法附带 OWASP 推荐的安全头:

php
// 内联显示(浏览器预览)
return service('tcpdfnext')->inline($pdf, 'report.pdf');

// 强制下载
return service('tcpdfnext')->download($pdf, 'report.pdf');

队列集成

将 PDF 生成分发到 CodeIgniter 的任务调度器:

php
use Yeeefang\TcpdfNext\CodeIgniter\Queue\GeneratePdfJob;

$job = new GeneratePdfJob([
    'template' => 'invoice',
    'data' => ['invoice_id' => $invoice->id],
    'output_path' => WRITEPATH . "pdfs/invoice-{$invoice->id}.pdf",
]);

service('queue')->push($job);

包内容

说明
TcpdfNextService服务注册与工厂
PdfLibrary控制器用库类
PdfResponse附带安全头的 HTTP 响应
GeneratePdfJob队列后台 PDF 生成任务

以 LGPL-3.0-or-later 许可证发布。