Snappy 技术文档

本文档将详细介绍如何安装、使用以及API调用Snappy库，该库是一个PHP库，用于从URL或HTML页面生成缩略图、快照或PDF文件。以下是关于Snappy的安装指南、使用说明和API使用文档。

1. 安装指南

Snappy依赖于webkit-based的wkhtmltopdf和wkhtmltoimage工具，你需要在你的系统上下载wkhtmltopdf 0.12.x 版本。

使用Composer进行安装：

composer require knplabs/knp-snappy

如果你希望通过Composer下载wkhtmltopdf和wkhtmltoimage作为依赖项，可以添加以下内容到composer.json：

• 对于32位系统：

composer require h4cc/wkhtmltopdf-i386 0.12.x
composer require h4cc/wkhtmltoimage-i386 0.12.x

• 对于64位系统：

composer require h4cc/wkhtmltopdf-amd64 0.12.x
composer require h4cc/wkhtmltoimage-amd64 0.12.x

2. 项目的使用说明

以下是如何使用Snappy的示例：

初始化

<?php

require __DIR__ . '/vendor/autoload.php';

use Knp\Snappy\Pdf;

$snappy = new Pdf('/usr/local/bin/wkhtmltopdf');

// 或者你可以分两步进行
$snappy = new Pdf();
$snappy->setBinary('/usr/local/bin/wkhtmltopdf');

在浏览器中显示PDF

$snappy = new Pdf('/usr/local/bin/wkhtmltopdf');
header('Content-Type: application/pdf');
echo $snappy->getOutput('http://www.github.com');

从浏览器下载PDF

$snappy = new Pdf('/usr/local/bin/wkhtmltopdf');
header('Content-Type: application/pdf');
header('Content-Disposition: attachment; filename="file.pdf"');
echo $snappy->getOutput('http://www.github.com');

将多个URL合并成一个PDF

$snappy = new Pdf('/usr/local/bin/wkhtmltopdf');
header('Content-Type: application/pdf');
header('Content-Disposition: attachment; filename="file.pdf"');
echo $snappy->getOutput(array('http://www.github.com','http://www.knplabs.com','http://www.php.net'));

生成本地PDF文件

$snappy = new Pdf('/usr/local/bin/wkhtmltopdf');
$snappy->generateFromHtml('<h1>Bill</h1><p>You owe me money, dude.</p>', '/tmp/bill-123.pdf');

向Snappy传递选项

// 使用wkhtmltopdf -H查看选项列表
$snappy = new Pdf('/usr/local/bin/wkhtmltopdf');
$snappy->setOption('disable-javascript', true);
$snappy->setOption('no-background', true);
$snappy->setOption('allow', array('/path1', '/path2'));
$snappy->setOption('cookie', array('key' => 'value', 'key2' => 'value2'));
$snappy->setOption('post', array('key' => 'value'));
$snappy->setOption('cover', 'pathToCover.html');
// ...或者传递一个HTML封面
$snappy->setOption('cover', '<h1>Bill cover</h1>');
$snappy->setOption('toc', true);
$snappy->setOption('cache-dir', '/path/to/cache/dir');

重置选项

选项可以通过resetOptions()方法重置为初始值。

$snappy = new Pdf('/usr/local/bin/wkhtmltopdf');
// 设置一些选项
$snappy->setOption('copies' => 4);
// ...
// 重置选项
$snappy->resetOptions();

3. 项目API使用文档

以下是一些API使用示例：

生成目录和自定义XSL样式表

<?php
$snappy = new Pdf('/path/to/binary');

$snappy->setOption('toc', true);
$snappy->setOption('xsl-style-sheet', 'http://path/to/stylesheet.xsl'); // 或者本地文件

$snappy->generateFromHtml('<p>Some content</p>', 'test.pdf');

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细介绍。请参考上述步骤进行安装。

以上就是关于Snappy库的安装、使用和API调用技术文档。希望对您有所帮助。