PHP SDK V2 を使用して同期処理を行う方法 - Object Storage Service

同期処理 (x-oss-process) は、プログラムが他のタスクを実行する前にタスクの完了を待つ必要があるメソッドです。このトピックでは、イメージ処理やドキュメント処理などのシナリオで PHP SDK V2 を使用して同期処理を行う方法について説明します。

注意事項

このトピックのサンプルコードでは、中国 (杭州) リージョン (cn-hangzhou) を例として使用します。デフォルトでは、パブリックエンドポイントが使用されます。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用します。OSS リージョンとエンドポイント間のマッピングの詳細については、「OSS リージョンとエンドポイント」をご参照ください。

サンプルコード

次のコードは、PHP SDK V2 を使用してイメージのスケーリングを実行し、処理されたイメージを指定されたバケットに保存して永続化する方法の例を示しています。

<?php

// 依存ライブラリをロードするためにオートローダーファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// コマンドライン引数の説明を定義します。
$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // バケットが配置されているリージョン。このパラメーターは必須です。
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 他のサービスが OSS にアクセスするために使用できるエンドポイント。このパラメーターはオプションです。
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。このパラメーターは必須です。
    "key" => ['help' => 'The name of the object', 'required' => True], // オブジェクトの名前。このパラメーターは必須です。
];

// コマンドライン引数を解析するための長いオプションのリストを生成します。
$longopts = \array_map(function ($key) {
    return "$key:"; // 各パラメーターの後にコロンを追加して、値が必要であることを示します。
}, array_keys($optsdesc));

// コマンドライン引数を解析します。
$options = getopt("", $longopts);

// 必須パラメーターが欠落していないか確認します。
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help'];
        echo "Error: the following arguments are required: --$key, $help"; // 必須パラメーターが欠落していることをユーザーにプロンプトします。
        exit(1);
    }
}

// コマンドライン引数の値を取得します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケットの名前。
$key = $options["key"];       // オブジェクトの名前。

// AccessKeyId や AccessKeySecret などの認証情報を環境変数からロードします。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// SDK のデフォルト構成を使用します。
$cfg = Oss\Config::loadDefault();

// 認証情報プロバイダーを設定します。
$cfg->setCredentialsProvider($credentialsProvider);

// リージョンを設定します。
$cfg->setRegion($region);

// エンドポイントが指定されている場合は、エンドポイントを設定します。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]);
}

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// イメージの幅を 100 にリサイズし、イメージを新しいオブジェクトとして保存するイメージ処理コマンドを構築します。
$process = sprintf("image/resize,w_100|sys/saveas,o_%s",
    base64_encode($key) // オブジェクト名を Base64 エンコードします。
);

// オブジェクトを処理するためのリクエストオブジェクトを作成します。
$request = new Oss\Models\ProcessObjectRequest(
    bucket: $bucket, // バケットの名前。
    key: $key         // オブジェクトの名前。
);

// 処理コマンドを設定します。
$request->process = $process;

// processObject メソッドを呼び出してオブジェクトを処理します。
$result = $client->processObject($request);

// 結果を出力します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 応答の HTTP ステータスコード。
    'request id:' . $result->requestId . PHP_EOL .   // リクエストの一意の ID。
    'process result:' . var_export($result, true) . PHP_EOL // 処理結果。
);

シナリオ

イメージにブラインドウォーターマークを追加する

ブラインドウォーターマーク機能を使用して、テキストのブラインドウォーターマークをイメージに追加できます。

<?php

// 依存ライブラリをロードするためにオートローダーファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// コマンドライン引数の説明を定義します。
$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // バケットが配置されているリージョン。このパラメーターは必須です。
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 他のサービスが OSS にアクセスするために使用できるエンドポイント。このパラメーターはオプションです。
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。このパラメーターは必須です。
    "key" => ['help' => 'The name of the object', 'required' => True], // オブジェクトの名前。このパラメーターは必須です。
];

// コマンドライン引数を解析するための長いオプションのリストを生成します。
$longopts = \array_map(function ($key) {
    return "$key:"; // 各パラメーターの後にコロンを追加して、値が必要であることを示します。
}, array_keys($optsdesc));

// コマンドライン引数を解析します。
$options = getopt("", $longopts);

// 必須パラメーターが欠落していないか確認します。
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help'];
        echo "Error: the following arguments are required: --$key, $help"; // 必須パラメーターが欠落していることをユーザーにプロンプトします。
        exit(1);
    }
}

// コマンドライン引数の値を取得します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケットの名前。
$key = $options["key"];       // オブジェクトの名前。

// AccessKeyId や AccessKeySecret などの認証情報を環境変数からロードします。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// SDK のデフォルト構成を使用します。
$cfg = Oss\Config::loadDefault();

// 認証情報プロバイダーを設定します。
$cfg->setCredentialsProvider($credentialsProvider);

// リージョンを設定します。
$cfg->setRegion($region);

// エンドポイントが指定されている場合は、エンドポイントを設定します。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]);
}

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// ウォーターマークの内容を指定します。
$content = "Copyright © Alibaba Cloud";

// イメージのブラインドウォーターマークを生成します。
$encodedContent = base64_encode($content); // ウォーターマークの内容を Base64 エンコードします。
$style = sprintf("image/blindwatermark,content_%s", $encodedContent); // 処理スタイルを構築します。
$targetImageName = "targetDir/target.jpg"; // 宛先イメージのパス。
$process = sprintf(
    "%s|sys/saveas,o_%s,b_%s",
    $style,
    base64_encode($targetImageName), // 宛先イメージ名を Base64 エンコードします。
    base64_encode($bucketName)       // バケット名を Base64 エンコードします。
);

// オブジェクトを処理するためのリクエストオブジェクトを作成します。
$request = new Oss\Models\ProcessObjectRequest(
    bucket: $bucketName, // バケットの名前。
    key: $objectName,    // オブジェクトの名前。
    process: $process    // 処理命令。
);

// processObject メソッドを呼び出してオブジェクトを処理します。
$result = $client->processObject($request);

// 結果を出力します。
printf(
    'status code:' . $result->statusCode . PHP_EOL . // 応答の HTTP ステータスコード。
    'request id:' . $result->requestId . PHP_EOL .   // リクエストの一意の ID。
    'process result:' . var_export($result, true) . PHP_EOL // 処理結果。
);

参考資料

イメージ処理パラメーターの詳細については、「イメージ処理パラメーター」をご参照ください。
同期処理機能の詳細については、「同期処理」をご参照ください。