【PHP8.x】StreamBucket::bucketプロパティの使い方

Copy
1<?php
2
3/**
4 * カスタムストリームフィルターの例。
5 * StreamBucket クラスを利用して、ストリームを介して渡されるデータを操作します。
6 *
7 * StreamBucket は、ストリームフィルターによって処理されるデータの塊（バケット）を表すオブジェクトです。
8 * 参照情報には 'bucket' というプロパティが記載されていますが、StreamBucket オブジェクト自体が
9 * 「バケット」を表し、そのデータの内容は 'data' プロパティを通じてアクセスされます。
10 * このサンプルコードでは、StreamBucket::$data プロパティを使用して、データを大文字に変換するフィルターを実装します。
11 */
12class UppercaseFilter extends php_user_filter
13{
14    /**
15     * ストリームフィルター処理を実行します。
16     * このメソッドは、ストリームを介して渡される StreamBucket オブジェクトのリストを受け取ります。
17     *
18     * @param resource $in 入力バケットリスト (StreamBucket オブジェクトのリスト)
19     * @param resource $out 出力バケットリスト
20     * @param int $consumed 処理されたバイト数を格納する参照
21     * @param bool $closing ストリームが閉じられようとしているか
22     * @return int フィルター処理の結果を示す定数 (PSFS_PASS_ON, PSFS_FEED_ME, PSFS_ERR_FATAL)
23     */
24    public function filter($in, $out, &$consumed, bool $closing): int
25    {
26        // 入力バケットリストから利用可能な StreamBucket オブジェクトをループ処理します
27        while ($bucket = stream_bucket_make_writeable($in)) {
28            // StreamBucket オブジェクトの 'data' プロパティにアクセスし、バケットの内容を操作します。
29            // ここで、$bucket->data はバケット内の生データ (string) を保持しています。
30            $bucket->data = strtoupper($bucket->data); // データをすべて大文字に変換
31
32            $consumed += strlen($bucket->data); // 処理されたバイト数を更新
33            stream_bucket_append($out, $bucket); // 処理済みのバケットを出力リストに追加
34        }
35
36        return PSFS_PASS_ON; // 処理を続行し、次のフィルターまたは終端へ渡します
37    }
38}
39
40// カスタムフィルターを登録します。PHP 8 ではクラス名を直接指定できます。
41stream_filter_register("uppercase.string", UppercaseFilter::class);
42
43// php://memory ストリームを作成し、ファイルとしてデータを読み書きできるメモリ領域を準備します。
44$fp = fopen("php://memory", "r+");
45if ($fp === false) {
46    die("メモリをオープンできませんでした。");
47}
48
49// 作成したストリームにカスタムフィルターを適用します。
50// STREAM_FILTER_READ と STREAM_FILTER_WRITE の両方に適用することで、
51// 読み書きの両方でフィルターが機能することを確認できます。
52stream_filter_append($fp, "uppercase.string", STREAM_FILTER_READ);
53stream_filter_append($fp, "uppercase.string", STREAM_FILTER_WRITE);
54
55// ストリームにデータを書き込みます。
56$originalString = "Hello, World! This is a test for StreamBucket.";
57fwrite($fp, $originalString);
58
59// ストリームポインタを先頭に戻します。
60fseek($fp, 0);
61
62// ストリームからデータを読み取ります。
63// この時点で、書き込まれたデータは UppercaseFilter によって大文字に変換されています。
64$readData = fread($fp, strlen($originalString));
65
66// 結果を出力します。
67echo "元の文字列: " . $originalString . PHP_EOL;
68echo "フィルター後の文字列: " . $readData . PHP_EOL;
69
70// ストリームを閉じます。
71fclose($fp);
72
73// 検証 (オプション): フィルターが正しく動作したかを確認します。
74if ($readData === strtoupper($originalString)) {
75    echo "検証成功: フィルターは期待通りに動作しました。" . PHP_EOL;
76} else {
77    echo "検証失敗: フィルターが期待通りに動作しませんでした。" . PHP_EOL;
78}
79

このPHPのサンプルコードは、StreamBucketクラスを利用してカスタムストリームフィルターを作成し、ストリームを介して渡されるデータを操作する方法を示しています。StreamBucketは、ファイルやネットワークなどのストリームを流れるデータの塊（バケット）を表すオブジェクトです。

提供されたリファレンス情報にはbucketというプロパティが記載されていますが、このサンプルコードではStreamBucketオブジェクト自体がデータの塊を意味し、その内部の実際のデータ内容は$bucket->dataプロパティを通じてアクセスされ、操作されます。dataプロパティは文字列型のデータを保持しています。

コードでは、UppercaseFilterクラスでカスタムフィルターを定義し、そのfilterメソッド内で入力バケットリスト$inからStreamBucketオブジェクトを取得し、$bucket->dataをstrtoupper()関数で大文字に変換しています。filterメソッドは、入力と出力のバケットリスト、処理されたバイト数を格納する参照$consumed、ストリームが閉じられようとしているかを示す$closing引数を受け取り、処理の結果を示す整数定数（例: PSFS_PASS_ON）を返します。

フィルターの定義後、stream_filter_register()で登録し、fopen()で作成したメモリ上のストリームにstream_filter_append()で適用しています。これにより、fwrite()でストリームに書き込まれた文字列データは、フィルターによって自動的に大文字に変換され、fread()で読み出す際にその変換された結果が確認できます。

Copy
1<?php
2
3require 'vendor/autoload.php'; // Composerのオートロードファイルを読み込む
4
5use Aws\S3\S3Client;
6use Aws\Exception\AwsException;
7
8/**
9 * S3バケットを一覧表示するサンプル関数。
10 *
11 * PHPの標準StreamBucketクラスには'bucket'というプロパティは存在しません。
12 * 提供されたリファレンス情報はPHPの公式ドキュメントと異なるため、
13 * 「s3 bucket php」というキーワードに最も関連性の高いS3バケット操作の例を生成します。
14 * このコードはAWS SDK for PHPを使用し、S3バケットの一覧を取得します。
15 *
16 * リファレンス情報の「戻り値: 戻り値なし」という記述を考慮し、
17 * この関数はバケット名を標準出力に表示する副作用を持ちます。
18 */
19function displayS3Buckets(): void
20{
21    // AWS認証情報とリージョンを設定します。
22    // 本番環境では環境変数、IAMロール、または設定ファイルを使用することが推奨されます。
23    // 以下は最小限の設定例です。
24    $s3Client = new S3Client([
25        'version' => 'latest',
26        'region'  => 'ap-northeast-1', // 例: 東京リージョン
27        // 開発・テスト環境の場合、credentialsを設定することも可能ですが、本番では非推奨です。
28        // 'credentials' => [
29        //     'key'    => 'YOUR_AWS_ACCESS_KEY_ID',    // 実際のアクセスキーに置き換えてください
30        //     'secret' => 'YOUR_AWS_SECRET_ACCESS_KEY', // 実際のシークレットキーに置き換えてください
31        // ],
32    ]);
33
34    try {
35        // S3バケットの一覧を取得します。
36        $result = $s3Client->listBuckets();
37
38        echo "S3 Buckets:\n";
39        if (!empty($result['Buckets'])) {
40            foreach ($result['Buckets'] as $bucket) {
41                // 各バケットの名前を表示します。
42                echo "- " . $bucket['Name'] . "\n";
43            }
44        } else {
45            echo "No S3 buckets found in this account.\n";
46        }
47    } catch (AwsException $e) {
48        // S3操作中にエラーが発生した場合、メッセージを表示します。
49        echo "Error listing S3 buckets: " . $e->getMessage() . "\n";
50    }
51}
52
53// 関数を実行してS3バケットの一覧を表示します。
54displayS3Buckets();

PHPのStreamBucketクラスにbucketというプロパティは存在しませんが、キーワード「s3 bucket php」に沿って、AWS S3のバケット一覧を表示するPHPのサンプルコードについて説明します。

このコードは、displayS3Bucketsという関数で構成されており、引数はなく、戻り値もありません（void）。代わりに、AWSアカウントに存在するS3バケットの名前を一覧で取得し、コマンドラインに直接表示する役割を持ちます。

関数内では、まずAWS SDK for PHPのS3Clientを初期化し、AWSのバージョンとリージョンを設定します。その後、listBuckets()メソッドを呼び出してS3バケットの情報を取得します。取得した情報から各バケットのNameプロパティを取り出し、一つずつ表示します。S3との通信中にエラーが発生した場合は、そのエラーメッセージも出力されます。このように、この関数は特定の値を返さず、直接画面に結果を表示する副作用によって情報を提供します。