interactively/php-pdftk

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

维护者

详细信息

github.com/CiprianOpreaPrestimedia/php-pdftk

源代码

安装次数: 2,278

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 124

1.0 2023-02-21 10:04 UTC

Requires

MIT 41b563275959c0308e86746e08d58fa907a0418b

  • Michael Haertl <haertl.mike.woop@gmail.com>

pdfpdftk

This package is auto-updated.

Last update: 2024-09-21 13:21:11 UTC

README

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');

Cat

从一个或多个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');

Shuffle

与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');

Burst

将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() );

API

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