CloudFlow:Install CloudFlow SDK for PHP

Specialized calls

Run the following command to install the CloudFlow SDK package:

composer require alibabacloud/fnf-20190315 1.1.3

To find the latest version and installation instructions, visit the CloudFlow SDK page in OpenAPI Explorer. Select PHP in the All languages field, then copy the installation code from the Installation Method section.

Generic calls

Install the darabonba-openapi core package instead of a service-specific SDK:

composer require alibabacloud/darabonba-openapi

For the latest version, see tea-openapi.

Handle errors

Wrap every API call in error handling. The following pattern applies to all examples in this topic:

use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

$runtime = new RuntimeOptions([]);

try {
    // API call goes here
} catch (Exception $error) {
    if (!($error instanceof TeaError)) {
        $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
    }
    var_dump($error->message);
    var_dump($error->data["Recommend"]);
    Utils::assertAsString($error->message);
}

CreateFlow

Call CreateFlow to create a workflow. Define the workflow by using Flow Definition Language (FDL). CloudFlow supports both the legacy and current FDL syntax.

use AlibabaCloud\SDK\Fnf\V20190315\Models\CreateFlowRequest;

$createFlowRequest = new CreateFlowRequest([
    "name" => "my_flow_name",
    "definition" => '
Type: StateMachine
SpecVersion: v1
Name: my_flow_name
StartAt: my_state
States:
  - Type: Pass
    Name: my_state
    End: true
',
    "description" => "your test flow",
    "type" => "FDL"
]);

$runtime = new RuntimeOptions([]);
$client->createFlowWithOptions($createFlowRequest, $runtime);

type: flow
version: v1
name: my_flow_name
steps:
  - type: pass
    name: mypass

DescribeFlow

Call DescribeFlow to query information about a workflow.

use AlibabaCloud\SDK\Fnf\V20190315\Models\DescribeFlowRequest;

$describeFlowRequest = new DescribeFlowRequest([
    "name" => "my_flow_name"
]);

$runtime = new RuntimeOptions([]);
$client->describeFlowWithOptions($describeFlowRequest, $runtime);

StartExecution

Call StartExecution to start a workflow execution asynchronously.

use AlibabaCloud\SDK\Fnf\V20190315\Models\StartExecutionRequest;

$startExecutionRequest = new StartExecutionRequest([
    "flowName" => "your_flow_name",
    "executionName" => "your_exec_name",
    "input" => '{"key":"value"}',
    // Call back TaskToken-related tasks after the execution ends
    "callbackFnFTaskToken" => "12"
]);

$runtime = new RuntimeOptions([]);
$client->startExecutionWithOptions($startExecutionRequest, $runtime);

Complete example

The following example creates a workflow, queries its details, and starts an execution:

<?php

namespace AlibabaCloud\SDK\Sample;

$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}

use AlibabaCloud\SDK\Fnf\V20190315\Fnf;
use AlibabaCloud\SDK\Fnf\V20190315\Models\CreateFlowRequest;
use AlibabaCloud\SDK\Fnf\V20190315\Models\DescribeFlowRequest;
use AlibabaCloud\SDK\Fnf\V20190315\Models\StartExecutionRequest;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;
use \Exception;

class Sample
{
    public static function createClient()
    {
        $config = new Config([
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
        ]);
        // Replace with your region endpoint. Example: cn-hangzhou.fnf.aliyuncs.com
        $config->endpoint = "cn-hangzhou.fnf.aliyuncs.com";

        return new Fnf($config);
    }

    public static function main($args)
    {
        $client = self::createClient();
        $runtime = new RuntimeOptions([]);

        try {
            // Create a workflow
            $createFlowRequest = new CreateFlowRequest([
                "name" => "my_flow_name",
                "definition" => '
Type: StateMachine
SpecVersion: v1
Name: my_flow_name
StartAt: my_state
States:
  - Type: Pass
    Name: my_state
    End: true
',
                "description" => "your test flow",
                "type" => "FDL"
            ]);
            $client->createFlowWithOptions($createFlowRequest, $runtime);

            // Query workflow details
            $describeFlowRequest = new DescribeFlowRequest([
                "name" => "my_flow_name"
            ]);
            $client->describeFlowWithOptions($describeFlowRequest, $runtime);

            // Start an execution
            $startExecutionRequest = new StartExecutionRequest([
                "flowName" => "your_flow_name",
                "executionName" => "your_exec_name",
                "input" => '{"key":"value"}',
                // Call back TaskToken-related tasks after the execution ends
                "callbackFnFTaskToken" => "12"
            ]);
            $client->startExecutionWithOptions($startExecutionRequest, $runtime);

        } catch (Exception $error) {
            if (!($error instanceof TeaError)) {
                $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
            }
            var_dump($error->message);
            var_dump($error->data["Recommend"]);
            Utils::assertAsString($error->message);
        }
    }
}

Sample::main(array_slice($argv, 1));