pinetree/php-pdftk

基于 pdftk 的 PDF 转换和表单工具。

维护者

详情

github.com/pinetree/php-pdftk

源代码

安装: 156

依赖: 0

建议者: 0

安全性: 0

星星: 0

关注者: 1

分支: 124

0.8.1 2020-02-06 06:19 UTC

Requires

Requires (Dev)

MIT 1cbc791bded41c2f339003e4e923fbcc8cf8ce12

  • Michael Haertl <haertl.mike.woop@gmail.com>
  • Kirill Sosnin <kirill.sosnin.woop@gmail.com>

pdfpdftk

This package is not auto-updated.

Last update: 2024-09-28 02:38:23 UTC

README

README 需要更新。

### 简述： pdftk 不允许将 Unicode 字体渲染到 PDF 表单字段中。

mcpdf https://github.com/m-click/mcpdf 可以做到。

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

基于 pdftk 的 PDF 转换和表单工具。

特性

php-pdftk 将 pdftk 的全部功能带给 PHP - 更多。

  • 填充表单，可以从 XFDF/FDF 文件或数据数组（UTF-8 安全，用于未压扁的表单，需要 pdftk 2.x !）中获取数据
  • 从 PHP 数组创建 XFDF 或 FDF 文件（UTF-8 安全！）
  • 从填充的 PDF 表单创建 FDF 文件
  • 将多个 PDF 文件的页面组合成一个新的 PDF 文件
  • 将 PDF 分割成每页一个文件
  • 添加背景或叠加 PDF
  • 读取 PDF 和表单字段的元数据
  • 设置密码和权限
  • 移除密码

需求

  • pdftk 命令必须在您的系统上安装并运行
  • 此库是为 pdftk 2.x 版本编写的。您应该能够使用它与 pdftk 1.x 版本一起使用，但并非所有方法都将在那里工作。有关详细信息，请参阅系统上 pdftk 的 man 页面。

注意 如果您使用的是 Ubuntu，您可能想要安装来自 ppa:malteworld/ppa 的版本。默认包似乎使用了 snap，并且有关于此版本文件权限问题的报告。下面有解决方法。

安装

您应该使用 composer 来安装此库。

composer require mikehaertl/php-pdftk

示例

操作

请参阅每个操作的 pdftk man 页面，以详细了解每个操作的工作方式以及有哪些选项可用。

注意：某些命令允许您使用句柄来别名您的文件（见以下示例）。在 pdftk 的 2.x 版本中，句柄可以是一个或多个大写字母。

对于所有操作，您可以通过 saveAs($name) 将 PDF 本地保存，或者通过 send() 将其发送到浏览器。如果您传递一个文件名给 send($name)，则客户端浏览器将打开下载对话框；如果没有文件名，它通常将 PDF 作为内联显示。

重要：您始终只能对单个 PDF 实例执行以下操作之一。如果您需要多个操作，下面有解决方法。

填充表单

使用来自 PHP 数组或 XFDF/FDF 文件的数据填充 PDF 表单。

use mikehaertl\pdftk\Pdf;

// Fill form with data array
$pdf = new Pdf('/full/path/to/form.pdf');
$pdf->fillForm([
        'name'=>'ÄÜÖ äüö мирано čárka',
        'nested.name' => 'valX',
    ])
    ->needAppearances()
    ->saveAs('filled.pdf');

// Fill form from FDF
$pdf = new Pdf('form.pdf');
$pdf->fillForm('data.xfdf')
    ->saveAs('filled.pdf');

// Check for errors
if (!$pdf->saveAs('my.pdf')) {
    $error = $pdf->getError();
}

注意：当填充 UTF-8 数据时，您应始终添加 needAppearances() 选项。这将确保 PDF 阅读器负责使用正确的字体进行渲染，这是 pdftk 无法为您做的。此外，注意如果您的数据中有特殊字符，flatten() 实际上并不工作得很好。

从 PHP 数组创建 XFDF/FDF 文件

这是一个来自 pdftk 的额外功能。

use mikehaertl\pdftk\XfdfFile;
use mikehaertl\pdftk\FdfFile;

$xfdf = new XfdfFile(['name' => 'Jürgen мирано']);
$xfdf->saveAs('/path/to/data.xfdf');

$fdf = new FdfFile(['name' => 'Jürgen мирано']);
$fdf->saveAs('/path/to/data.fdf');

猫

从一个或多个 PDF 文件的页面组装一个 PDF。

use mikehaertl\pdftk\Pdf;

// Extract pages 1-5 and 7,4,9 into a new file
$pdf = new Pdf('/path/to/my.pdf');
$pdf->cat(1, 5)
    ->cat([7, 4, 9])
    ->saveAs('/path/to/new.pdf');

// Combine pages from several files, demonstrating several ways how to add files
$pdf = new Pdf([
    'A' => '/path/file1.pdf',                 // A is alias for file1.pdf
    'B' => ['/path/file2.pdf','pass**word'],  // B is alias for file2.pdf
]);
$pdf->addFile('/path/file3.pdf','C','**secret**pw');  // C is alias file3.pdf
$pdf->cat(1, 5, 'A')                // pages 1-5 from A
    ->cat(3, null, 'B')             // page 3 from B
    ->cat(7, 'end', 'B', null, 'east') // pages 7-end from B, rotated East
    ->cat('end',3,'A','even')       // even pages 3-end in reverse order from A
    ->cat([2,3,7], 'C')             // pages 2,3 and 7 from C
    ->saveAs('/path/new.pdf');

洗牌

类似于 cat()，但创建 "流" 并一次填充新的 PDF 中的一个页面。

use mikehaertl\pdftk\Pdf;

$pdf = new Pdf([
    'A' => '/path/file1.pdf',     // A is alias for file1.pdf
    'B' => '/path/file2.pdf',     // B is alias for file2.pdf
]);

// new.pdf will have pages A1, B3, A2, B4, A3, B5, ...
$pdf->shuffle(1, 5, 'A')    // pages 1-5 from A
    ->shuffle(3, 8, 'B')    // pages 3-8 from B
    ->saveAs('/path/new.pdf');

爆炸

将 PDF 文件分割成每页一个文件。

use mikehaertl\pdftk\Pdf;

$pdf = new Pdf('/path/my.pdf');
$pdf->burst('/path/page_%d.pdf');     // Supply a printf() pattern

添加背景 PDF

将另一个 PDF 文件作为背景添加。

use mikehaertl\pdftk\Pdf;

// Set background from another PDF (first page repeated)
$pdf = new Pdf('/path/my.pdf');
$pdf->background('/path/back.pdf')
    ->saveAs('/path/watermarked.pdf');

// Set background from another PDF (one page each)
$pdf = new Pdf('/path/my.pdf');
$pdf->multiBackground('/path/back_pages.pdf')
    ->saveAs('/path/watermarked.pdf');

添加叠加 PDF

将另一个 PDF 文件作为叠加添加。

use mikehaertl\pdftk\Pdf;

// Stamp with another PDF (first page repeated)
$pdf = new Pdf('/path/my.pdf');
$pdf->stamp('/path/overlay.pdf')
    ->saveAs('/path/stamped.pdf');

// Stamp with another PDF (one page each)
$pdf = new Pdf('/path/my.pdf');
$pdf->multiStamp('/path/overlay_pages.pdf')
    ->saveAs('/path/stamped.pdf');

生成 FDF

从给定的填写好的PDF表单创建一个FDF文件。

use mikehaertl\pdftk\Pdf;

// Create FDF from PDF
$pdf = new Pdf('/path/form.pdf');
$pdf->generateFdfFile('/path/data.fdf');

获取PDF数据

从PDF文件中读取元数据或表单字段信息。

use mikehaertl\pdftk\Pdf;

// Get data
$pdf = new Pdf('/path/my.pdf');
$data = $pdf->getData();

// Get form data fields
$pdf = new Pdf('/path/my.pdf');
$data = $pdf->getDataFields();

// Get data as string
echo $data;
$txt = (string) $data;
$txt = $data->__toString();

// Get data as array
$arr = (array) $data;
$arr = $data->__toArray();
$field1 = $data[0]['Field1'];

如何在PDF上执行多个操作

如上所述，您只能对单个PDF实例执行上述操作中的一个。如果您需要执行多个操作，可以将一个Pdf实例传递给另一个

use mikehaertl\pdftk\Pdf;

// Extract pages 1-5 and 7,4,9 into a new file
$pdf = new Pdf('/path/my.pdf');
$pdf->cat(1, 5)
    ->cat([7, 4, 9]);

// We now use the above PDF as source file for a new PDF
$pdf2 = new Pdf($pdf);
$pdf2->fillForm(['name' => 'ÄÜÖ äüö мирано čárka'])
    ->needAppearances()
    ->saveAs('/path/filled.pdf');

选项

您可以将上述操作与以下选项之一或多个组合。

use mikehaertl\pdftk\Pdf;

$pdf = new Pdf('/path/my.pdf');

$pdf->allow('AllFeatures')      // Change permissions
    ->flatten()                 // Merge form data into document (doesn't work well with UTF-8!)
    ->compress($value)          // Compress/Uncompress
    ->keepId('first')           // Keep first/last Id of combined files
    ->dropXfa()                 // Drop newer XFA form from PDF
    ->dropXmp()                 // Drop newer XMP data from PDF
    ->needAppearances()         // Make clients create appearance for form fields
    ->setPassword($pw)          // Set owner password
    ->setUserPassword($pw)      // Set user password
    ->passwordEncryption(128)   // Set password encryption strength
    ->saveAs('new.pdf');

// Example: Fill PDF form and merge form data into PDF
// Fill form with data array
$pdf = new Pdf('/path/form.pdf');
$pdf->fillForm(['name' => 'My Name'])
    ->flatten()
    ->saveAs('/path/filled.pdf');

// Example: Remove password from a PDF
$pdf = new Pdf;
$pdf->addFile('/path/my.pdf', null, 'some**password')
    ->saveAs('/path/new.pdf');

Shell命令

该类使用php-shellcommand来执行pdftk。您可以将$options作为第二个参数传递给其Command类的构造函数

use mikehaertl\pdftk\Pdf;

$pdf = new Pdf('/path/my.pdf', [
    'command' => '/some/other/path/to/pdftk',
    // or on most Windows systems:
    // 'command' => 'C:\Program Files (x86)\PDFtk\bin\pdftk.exe',
    'useExec' => true,  // May help on Windows systems if execution fails
]);

临时文件

内部通过php-tmpfile创建一个临时文件。您也可以直接访问该文件，例如，如果您既不想发送也不想保存文件，但只需要二进制的PDF内容

use mikehaertl\pdftk\Pdf;

$pdf = new Pdf('/path/my.pdf');
$pdf->fillForm(['name' => 'My Name'])
    ->execute();
$content = file_get_contents( (string) $pdf->getTmpFile() );

如果您有权限问题，可能需要设置一个目录，您的pdftk命令可以将其写入

use mikehaertl\pdftk\Pdf;

$pdf = new Pdf('/path/my.pdf');
$pdf->tempDir = '/home/john/temp';

API

请参阅源文件以获取每个方法的完整文档。