parthenon/docraptor

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

DocRaptor HTML 转 PDF/XLS 服务的包装器。

2.0.3 2021-07-10 08:04 UTC

This package is auto-updated.

Last update: 2022-09-16 08:02:52 UTC


README

Build Status

DocRaptor PHP 本地客户端库

这是一个 PHP 包,用于使用 DocRaptor API 将 HTML 转换为 PDF 和 XLSX。

安装

composer require docraptor/docraptor

基本用法

$docraptor = new DocRaptor\DocApi();
$docraptor->getConfig()->setUsername("YOUR_API_KEY_HERE");             // this key works for test documents
// $docraptor->getConfig()->setDebug(true);

$doc = new DocRaptor\Doc();
$doc->setTest(true);                                                   // test documents are free but watermarked
$doc->setDocumentContent("<html><body>Hello World</body></html>");     // supply content directly
// $doc->setDocumentUrl("http://docraptor.com/examples/invoice.html"); // or use a url
$doc->setName("docraptor-php.pdf");                                    // help you find a document later
$doc->setDocumentType("pdf");                                          // pdf or xls or xlsx
// $doc->setJavascript(true);                                          // enable JavaScript processing
// $prince_options = new DocRaptor\PrinceOptions();                    // pdf-specific options
// $doc->setPrinceOptions($prince_options);
// $prince_options->setMedia("screen");                                // use screen styles instead of print styles
// $prince_options->setBaseurl("http://hello.com");                    // pretend URL when using document_content

$create_response = $docraptor->createDoc($doc);

下一步

  • 可选地使用 文档托管 存储并获取转换文档的 URL
  • 查看更多带有错误处理、异步创建、文件保存和文档托管的 代码示例
  • 使用我们的 样式和格式参考API 参考 精炼您的文档样式。轻松添加标题和页脚、分页、页码、目录等!

更多帮助

卡住了?我们擅长将 HTML 转换为 PDF,如果您遇到任何问题,请联系我们

开发

此存储库中的大部分代码使用 swagger-codegen 在 docraptor.yaml 上生成。您可以修改此文件,并使用 script/generate_language php 重新生成客户端。

发布流程

  1. 拉取最新 master
  2. 将功能分支合并到 master
  3. script/test
  4. 在代码中增加版本号
  • swagger-config.json
  • lib/Configuration.php(2处)
  1. 更新 CHANGELOG.md
  2. 提交“发布版本 vX.Y.Z”
  3. 推送到 GitHub
  4. 标记版本:git tag 'vX.Y.Z' && git push --tags(GitHub Packagist 集成将告诉 Packagist 发布新版本)
  5. https://packagist.org.cn/packages/docraptor/docraptor 上验证更新
  6. 刷新 docraptor.com 上的文档

版本策略

此库遵循 语义版本控制 2.0.0

贡献者

  • Joel Meador
  • Elijah Miller
  • James Paden
  • Jason Gladish
  • Nikola Nikolov