README

此包提供 Carbone.io 云 API 的 PHP SDK。

关于 Carbone

Carbone 是一个强大且易于使用的 API，可以从模板生成 PDF 文档。它基于 LibreOffice，可以转换 LibreOffice 支持的任何文档。还可以将 HTML 转换为 PDF。了解更多关于支持的文件和功能的信息。

安装

您可以通过 Composer 安装绑定。运行以下命令

composer require carboneio/carbone-sdk-php

用法

Carbone 实例

使用 SDK 非常简单。您只需创建 Carbone 类的新实例并提供您的 API 密钥。在 Carbone 账户上获取您的 API 密钥：https://account.carbone.io/。

use Carboneio\SDK\Carbone;

$carbone = new Carbone('YOUR_API_KEY', 'https://api.carbone.io/');

上传模板

您可以使用 upload 方法将模板上传到 Carbone。此方法以 base64 格式接收模板内容。该方法返回用于生成文档的 模板 ID。

$response = $carbone->templates()->upload($contentBase64);

$templateId = $response->getTemplateId();

上传模板示例上传模板

渲染模板

您可以使用 render 方法生成文档。此方法接受 模板 ID 和数据作为参数。返回 渲染 ID，必须用于下载生成的文档。

$response = $carbone->renders()->render($templateId, $data);

$renderId = $response->getRenderId();

渲染模板示例渲染模板

下载渲染的模板

您可以使用 download 方法下载渲染的模板。此方法接受 渲染 ID 作为参数。

$response = $carbone->renders()->download($renderId);

// Save the contents of the file yourself on your filesystem
$content = $response->getContent();

下载渲染文档示例下载渲染文档

删除模板

您可以使用 delete 方法删除模板。此方法接受 模板 ID 作为参数。

$response = $carbone->templates()->delete($templateId);

删除模板示例删除模板

下载模板

您可以使用 download 方法下载模板。此方法接受 模板 ID 作为参数。

$response = $carbone->templates()->download($templateId);

下载模板示例下载模板

添加自定义头部

设置自定义头部，例如 "carbone-version"，以选择特定的 Carbone 版本。默认情况下，SDK 请求 Carbone 的版本 4。

$carbone->setHeaders([
  "carbone-version" => 4,
  /** Uncomment to delete automatically templates after a specific time */
  // "carbone-template-delete-after" => 86400, // 86400s = 1 day | https://carbone.io/api-reference.html#template-storage
  // "carbone-webhook-url" => "https://my-server", // https://carbone.io/api-reference.html#api-webhook
]);

获取 API 状态

$response = $carbone->getStatus();
$json = $response->json();

echo "Status : " . $response->status() . "\n";
echo "Success: " . $json['success'] . "\n";
echo "Version: " . $json['version'] . "\n";
echo "Message: " . $json['message'] . "\n";

🧪 运行测试

首先安装所需的 composer 包

composer install

然后执行测试

composer test

👤 历史

此包最初由 MadeByBob 创建并开源代码。Carbone.io 团队现在维护此 SDK 并将带来所有未来的进化。
原始仓库：https://github.com/madebybob/carbone-sdk
由Bob制作网站：https://madebybob.nl/

🤝 贡献

欢迎贡献、问题和功能请求！

请随意查看问题页面。

展示您的支持

如果这个项目对您有帮助，请点一个 ⭐️！

carboneio / carbone-sdk-php

维护者

详细信息