swisnl/pdfcrowd-client

此软件包已被放弃,不再维护。作者建议使用 pdfcrowd/pdfcrowd 软件包。

pdfcrowd.com API 的客户端。包含 Laravel 服务提供者。

dev-develop 2021-09-14 12:00 UTC

This package is auto-updated.

Last update: 2021-09-14 12:00:32 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

🚨 此软件包已被放弃 🚨

我们不再在自己的项目中使用此软件包,并且存在一个支持 Composer 的官方软件包,因此我们选择放弃它。我们建议使用官方的 pdfcrowd/pdfcrowd 软件包。请随意fork我们的代码并维护自己的副本。

这是一个针对 pdfcrowd.com 的 API 的客户端。它基于 pdfcrowd/pdfcrowd-php 项目,但已调整以与 Composer 一起使用。它还包括 Laravel 服务提供者和单元测试。

进行中

此客户端仍在积极开发中。需要完成的工作

  • 改进文档:此软件包与原始类有何不同?
  • 改进文档:为所有设置器添加 docblocks。
  • 改进文档:尝试为完整类生成文档?
  • 标记版本并发布!

安装

为了向 API 发送请求,您需要启用 PHP cURL 库。

通过 Composer

$ composer require swisnl/pdfcrowd-client

Laravel

我们提供了一个服务提供者,您可以在 Laravel 项目中使用 Pdfcrowd 类的依赖注入。如果您不使用 软件包自动发现,请将 ServiceProvider 添加到 config/app.php 中的 providers 数组。

Swis\PdfcrowdClient\PdfcrowdServiceProvider::class,

然后,使用以下命令发布配置文件

php artisan vendor:publish --provider="Swis\PdfcrowdClient\PdfcrowdServiceProvider"

使用方法

# instantiate client, Laravel users can use dependency injection
$client = new Pdfcrowd('username', 'api_key');
 
# convert HTML to PDF and output
echo $client->convertHtml($someHtml);
 
# convert URI to PDF and output
echo $client->convertUri('https://google.com');
 
# convert to PDF and write to file
$client->setOutputDestination(fopen('path/to/output.pdf', 'w');
$client->convertHtml($someHtml);
 
# retrieve the amount of available tokens
$tokens = $client->availableTokens();
 
# retrieve the amount of tokens used by the previous conversion
$tokens = $client->getUsedTokens(); 

关于 Pdfcrowd 的完整参考可在此处找到:http://pdfcrowd.com/web-html-to-pdf-php/

基本示例在 /examples 中提供。

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

测试

$ composer test

贡献

有关详细信息,请参阅 CONTRIBUTINGCODE_OF_CONDUCT

安全性

如果您发现任何与安全性相关的问题,请通过电子邮件 security@swis.nl 而不是使用问题跟踪器。

致谢

许可证

麻省理工学院许可证(MIT)。更多信息请参阅许可证文件