このトピックでは、OSS SDK for PHP 2.0 を使用してオブジェクトが存在するかどうかを判断する方法について説明します。
使用上の注意
このトピックのサンプルコードでは、中国 (杭州) リージョンのリージョン ID
cn-hangzhouを使用します。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。バケットが配置されているのと同じリージョンにある他の Alibaba Cloud サービスからバケット内のリソースにアクセスする場合は、内部エンドポイントを使用します。OSS がサポートするリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。オブジェクトをダウンロードするには、
oss:GetObject権限が必要です。詳細については、「RAM ユーザーへのカスタムアクセスポシーの付与」をご参照ください。
サンプルコード
次のコードを使用して、ファイルが存在するかどうかを判断できます。
<?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], // エンドポイント。(オプション)
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。(必須)
"key" => ['help' => 'The name of the object', 'required' => True], // オブジェクトの名前。(必須)
];
// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後のコロン (:) は、引数に値が必要であることを示します。
$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" . PHP_EOL;
exit(1); // 必須パラメーターがない場合は、プログラムを終了します。
}
}
// 解析されたパラメーターから値を取得します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケットの名前。
$key = $options["key"]; // オブジェクトの名前。
// 環境変数から認証情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から Access Key ID と Access Key Secret を読み取ります。
$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);
// オブジェクトが存在するかどうかを確認します。
$exist = $client->isObjectExist(bucket: $bucket, key: $key);
// チェック結果を出力します。
printf(
'object is exist:' . var_export($exist, true) . PHP_EOL // オブジェクトが存在するかどうかを示すブール値を出力します。
);
参照
ファイルが存在するかどうかを判断するために使用される完全なサンプルコードについては、「GitHub」をご参照ください。
ファイルが存在するかどうかを判断するために使用される API 操作の詳細については、「IsObjectExist」をご参照ください。