README

这是一个用于访问PHP的Rokka图像服务API的库。

如果你使用的是Symfony框架，请查看Rokka Symfony Bundle，它将此库集成到Symfony中。

关于

rokka是正确的数字图像处理。存储、渲染和交付图像。简单且速度极快。此库允许将图像文件上传到rokka并尽可能以轻量级和快速的方式交付。并且你只支付你使用的费用，没有预先和固定的成本。

提供免费账户计划。只需安装插件，注册并使用它。

安装

使用composer安装库

composer require rokka/client

引导

你需要注册一个Rokka.io账户并使用你收到的API密钥。推荐的方法是使用rokka-cli。

Rokka\Client\Factory是创建API客户端的入口点。

然后你需要设置通过cli命令创建的凭据。

用户客户端

用户客户端用于用户和组织管理。

use Rokka\Client\Factory;

$apiKey = 'myKey';

$userClient = Factory::getUserClient($organization = null, $apiKey =null, $options = []);
$userClient->setCredentials($apiKey);

有一个可选参数可以指定Rokka API的基本URL。这通常不需要调整。

图像客户端

图像客户端用于将图像上传到组织并管理渲染堆栈。

use Rokka\Client\Factory;

$organization = 'testorganization';
$apiKey = 'myKey';

$imageClient = Factory::getImageClient($organization, $apiKey);

有一个可选参数可以指定Rokka API的基本URL。这通常不需要调整。

客户端选项

你可以将一个选项数组作为最后一个参数添加到Factory::getUserClientorFactory::getImageClient`。它采用以下格式

[ 
   Factory::API_BASE_URL => 'https://some-other-api.rokka.io',
   Factory::RENDER_BASE_URL => 'https://myimages.example.com', // you you want/have another render base url
   Factory::PROXY => 'http://proxy:8888', // if you need to use a proxy
   Factory::GUZZLE_OPTIONS => ['verify' => false] // any guzzle option you need/want
]

用法

阅读入门指南，了解rokka的基本概念。

图像和用户客户端提供了rokka文档API参考部分中描述的操作。

更多信息请参阅API文档。

运行测试

在项目根目录中运行vendor/bin/phpunit。

运行PHP-CS-Fixer

composer run lint:fix

运行phpstan

composer run phpstan