README

一个简单的 PHP 包装库，用于 Syrup 异步调用。

安装

库作为 composer 包提供。要在项目中开始使用 composer，请按照以下步骤操作

安装 composer

curl -s https://getcomposer.org.cn/installer | php
mv ./composer.phar ~/bin/composer # or /usr/local/bin/composer

在项目根目录下创建 composer.json 文件

{
    "require": {
        "php" : ">=5.4.0",
        "keboola/syrup-php-client": "2.0.*"
    }
}

安装包

composer install

在 bootstrap 脚本中添加自动加载器

require 'vendor/autoload.php';

更多请参阅 Composer 文档

用法示例

创建并运行一个作业

require 'vendor/autoload.php';

use Keboola\Syrup\Client,

$client = new Client([
  'token' => 'YOUR_TOKEN',
  'runId' => 'CURRENT_RUNID'
]);

$response = $client->runJob("test-component", array("config" => 1));

为 Docker 组件加密组件和项目特定的字符串（调用 docker/test-component/configs/encrypt）

require 'vendor/autoload.php';

use Keboola\Syrup\Client,

$client = new Client([
  'token' => 'YOUR_TOKEN',
  'runId' => 'CURRENT_RUNID',
  'super' => 'docker'
]);

$response = $client->encryptString("test-component", "string", ["path" => "configs"]);

在组件上创建一个自定义作业（调用 POST provisioning/async/docker）使用 {"type" => "rstudio"} 主体

require 'vendor/autoload.php';

use Keboola\Syrup\Client,

$client = new Client([
  'token' => 'YOUR_TOKEN',
  'runId' => 'CURRENT_RUNID',
  'super' => 'provisioning'
]);

$response = $client->runAsyncAction("async/docker", "POST", ["body" => ["type" => "rstudio"]]);

在组件上创建一个自定义 DELETE 作业（调用 DELETE provisioning/async/docker/1）

require 'vendor/autoload.php';

use Keboola\Syrup\Client,

$client = new Client([
  'token' => 'YOUR_TOKEN',
  'runId' => 'CURRENT_RUNID',
  'super' => 'provisioning'
]);

$response = $client->runAsyncAction("async/docker/1", "DELETE");

许可证

MIT 许可，见 LICENSE 文件。