README

Optimole PHP SDK让PHP开发者轻松将基于云的图像优化服务Optimole集成到他们的PHP项目中。

需求

• PHP >= 7.4

安装

使用composer在项目中安装Optimole PHP SDK

$ composer require codeinwp/optimole-sdk

用法

首先，您需要在Optimole上创建一个账户并获取您的API密钥。

初始化SDK

您可以使用Optimole外观通过API密钥初始化SDK

use Optimole\Sdk\Optimole;

Optimole::init('your-api-key', $options);

init方法的第二个参数是可选的。它允许您向SDK传递可用于配置它的选项。这些选项包括

• base_domain：连接到Optimole API的基础域名。默认为i.optimole.com。
• cache_buster：一个字符串值，将附加到优化资源的URL上以清除Optimole的缓存。
• dashboard_api_url：仪表板API的URL。默认为https://dashboard.optimole.com/api。
• dashboard_api_key：用于仪表板API的API密钥。
• upload_api_credentials：一个数组，包含用于上传API的凭据。数组应包含userKey和secret键。默认为空，SDK将使用init方法中提供的API密钥从仪表板API中获取它们。
• upload_api_url：上传API的URL。默认为https://generateurls-prod.i.optimole.com/upload。

优化图像和资源

Optimole外观是创建优化图像或其他资源的起点。您可以使用SDK提供的流畅接口控制优化属性。以下是一个通过更改质量并裁剪图像来优化图像的示例

use Optimole\Sdk\Optimole;

$image = Optimole::image('https://example.com/image.jpg')->quality(80)->resize('crop');

您可以使用getUrl方法或将对象转换为字符串来获取优化图像的URL

echo $image->getUrl();
echo (string) $image;

将图像卸载到Optimole

SDK还提供了一种将图像卸载到Optimole的方法。当您想从Optimole的内容分发网络提供图像时，这非常有用。以下是一个卸载图像的示例

use Optimole\Sdk\Optimole;

$imageId = Optimole::offload()->uploadImage('path/to/image.jpg', 'https://url/to/image.jpg');

这会将图像上传到Optimole并返回图像ID。然后您可以使用此图像ID与图像进行交互。例如，您可以获取卸载图像的URL

use Optimole\Sdk\Optimole;

$imageUrl = Optimole::offload()->getImageUrl($imageId);

贡献

使用composer安装依赖项并运行测试套件

$ composer install
$ vendor/bin/phpunit