roykesserwani/convertapi-php

Convert API PHP 客户端

dev-master 2023-01-02 00:50 UTC

This package is not auto-updated.

Last update: 2024-09-24 07:01:51 UTC


README

PHP version Build Status

使用我们的在线文件转换API转换您的文件

ConvertAPI可以帮助转换各种文件格式。从Word、Excel、Powerpoint、图片、网页或原始HTML代码等不同来源创建PDF和图片。合并、加密、分割、修复和解密PDF文件以及许多其他文件操作。您只需几分钟即可将其集成到您的应用程序中并轻松使用。

要求

PHP 5.4.0及更高版本。

安装

首选方法是使用composer。如果您还没有安装composer,请按照安装说明进行操作。

安装composer后,在项目根目录中执行以下命令以安装此库

composer require convertapi/convertapi-php

手动安装

如果您不想使用Composer,则必须需要ConvertApi自动加载器

require_once('/path/to/convertapi-php/src/ConvertApi/autoload.php');

依赖项

为了正常工作,库需要以下扩展

如果您使用Composer,这些依赖项应自动处理。如果您手动安装,请确保这些扩展可用。

用法

配置

您可以在https://www.convertapi.com/a获取您的密钥

use \ConvertApi\ConvertApi;

ConvertApi::setApiSecret('your-api-secret');

文件转换

将文件转换为PDF的示例。所有支持格式和选项都可以在这里找到:这里

$result = ConvertApi::convert('pdf', ['File' => '/path/to/my_file.docx']);

# save to file
$result->getFile()->save('/path/to/save/file.pdf');

# get file contents (without saving the file locally)
$contents = $result->getFile()->getContents();

其他结果操作

# save all result files to folder
$result->saveFiles('/path/to/save/files');

# get conversion cost
$cost = $result->getConversionCost();

转换文件URL

$result = ConvertApi::convert('pdf', ['File' => 'https://website/my_file.docx']);

指定格式

$result = ConvertApi::convert(
    'pdf',
    ['File' => '/path/to/my_file'],
    'docx'
);

附加转换参数

根据选择的格式,ConvertAPI接受附加的转换参数。所有转换参数和说明都可以在这里找到:这里

$result = ConvertApi::convert(
    'pdf',
    [
        'File' => '/path/to/my_file.docx',
        'PageRange' => '1-10',
        'PdfResolution' => '150',
    ]
);

用户信息

您可以通过获取用户信息来以编程方式检查剩余秒数。

$info = ConvertApi::getUser();

echo $info['SecondsLeft'];

更多示例

examples/文件夹中可以找到更多高级示例。

开发

使用PHPUnit进行测试

CONVERT_API_SECRET=your-api-secret ./bin/phpunit

贡献

欢迎在GitHub上提交错误报告和pull请求:https://github.com/ConvertAPI/convertapi-php。此项目旨在成为安全、欢迎的合作空间,并期望贡献者遵守贡献者公约的行为准则。

许可证

ConvertAPI PHP客户端作为开源软件提供,遵循MIT许可证的条款。