【PHP8.x】STREAM_META_TOUCH定数の使い方

Copy
1<?php
2
3/**
4 * PHPのストリームメタデータ取得とSTREAM_META_TOUCH定数に関するサンプルコード。
5 *
6 * この関数は、一時ファイルを作成してファイルストリームを開き、
7 * stream_get_meta_data() 関数を使用してそのストリームのメタデータを取得・表示します。
8 * また、STREAM_META_TOUCH 定数の値を出力し、その役割について説明します。
9 * STREAM_META_TOUCH は、ストリームのメタデータ（例: ファイルのアクセス時間や変更時間）
10 * の更新操作を示す定数であり、stream_get_meta_data() が直接返す情報ではありませんが、
11 * ストリームのメタデータ管理における概念として重要です。
12 */
13function demonstrateStreamMetaDataAndConstant(): void
14{
15    // 一時ファイル名を定義します。
16    $tempFileName = 'php_stream_meta_data_example.txt';
17
18    // 一時ファイルを書き込み・読み込みモード ('w+') で開きます。
19    // 'w+' モードは、ファイルが存在しない場合は新規作成し、
20    // 存在する場合は内容をクリアしてからストリームを開きます。
21    // これにより、確実なストリームハンドルを取得できます。
22    $fileHandle = fopen($tempFileName, 'w+');
23
24    // ストリームのオープンに失敗した場合のエラーハンドリング
25    if ($fileHandle === false) {
26        echo "エラー: ファイルストリームを開けませんでした。\n";
27        return;
28    }
29
30    echo "ファイルストリームを開きました: " . realpath($tempFileName) . "\n\n";
31
32    // ストリームにデータを書き込み、その後ファイルポインタを先頭に戻します。
33    // これは、ストリームのメタデータに影響を与える可能性のある操作を示します。
34    fwrite($fileHandle, "Hello, PHP Stream Meta Data Example!\n");
35    fseek($fileHandle, 0); // ファイルポインタを先頭に戻す
36
37    // stream_get_meta_data() を使用して、開かれたストリームのメタデータを取得します。
38    // この関数は、ストリームに関する様々な情報（例: タイムアウト設定、バッファリング状態、
39    // ストリームの種類、ファイルポインタの位置など）を連想配列で返します。
40    $metaData = stream_get_meta_data($fileHandle);
41
42    echo "--- ストリームのメタデータ ---\n";
43    foreach ($metaData as $key => $value) {
44        // 値が配列やオブジェクトの場合はJSON形式で表示し、それ以外は直接文字列として表示します。
45        if (is_array($value) || is_object($value)) {
46            echo sprintf("%-15s: %s\n", $key, json_encode($value, JSON_UNESCAPED_UNICODE));
47        } else {
48            echo sprintf("%-15s: %s\n", $key, (string)$value);
49        }
50    }
51    echo "--------------------------\n\n";
52
53    // STREAM_META_TOUCH 定数の値を出力し、その役割を説明します。
54    // この定数は、stream_set_meta_data() 関数やストリームの通知コールバックにおいて、
55    // ストリームのメタデータ（特にタイムスタンプなど）が更新されたことを示す際に使用されます。
56    // stream_get_meta_data() が返すメタデータに直接この定数が含まれるわけではありませんが、
57    // ストリームのメタデータ管理に関連する定数として提供されています。
58    echo "STREAM_META_TOUCH 定数の値: " . STREAM_META_TOUCH . "\n";
59    echo "補足: STREAM_META_TOUCH は、ファイルのアクセス時間や更新時間といった\n";
60    echo "      ストリームのメタデータ変更に関連する操作を示すコードです。\n";
61    echo "      例えば、FTPラッパーなどでファイルのタイムスタンプを更新する際に\n";
62    echo "      内部的に利用されることがあります。\n";
63
64    // ストリームを閉じます。
65    fclose($fileHandle);
66
67    // 使用した一時ファイルを削除します。
68    unlink($tempFileName);
69    echo "\n一時ファイルを削除しました: " . $tempFileName . "\n";
70}
71
72// サンプル関数を実行して動作を確認します。
73demonstrateStreamMetaDataAndConstant();

このPHPサンプルコードは、ファイルのストリームからメタデータを取得し、STREAM_META_TOUCH定数の役割を解説します。まず、fopen()関数を使用して一時ファイルを読み書きモードで開き、そのストリームハンドルを取得します。ファイルにデータを書き込んだ後、stream_get_meta_data()関数を使って、開かれたストリームの様々なメタデータ（例：ストリームの種類、モード、バッファリング状態など）を連想配列として取得し、その内容を表示しています。stream_get_meta_data()は引数にストリームリソースを取り、ストリームの状態を詳細に伝える配列を返します。

STREAM_META_TOUCHはPHPの定数で、ストリームのメタデータ、特にアクセス時間や変更時間といったタイムスタンプの更新操作を示す際に用いられます。この定数自体は、stream_get_meta_data()が直接返すメタデータの中に含まれるわけではありませんが、stream_set_meta_data()関数やストリームラッパーの内部で、ファイルのタイムスタンプ更新処理を指示するために利用されることがあります。サンプルコードでは、この定数の値を出力し、その概念的な役割を補足説明することで、ストリームにおけるメタデータ管理の一端を示しています。最後に、開いたストリームを閉じ、作成した一時ファイルを削除しています。

Copy
1<?php
2
3/**
4 * ソケットサーバーを起動し、クライアント接続を受け入れ、
5 * 受け入れたストリームに対してメタデータを更新するサンプルです。
6 *
7 * このスクリプトはTCPソケットサーバーとして機能し、
8 * クライアントからの接続を stream_socket_accept() で待ち受けます。
9 * 接続が確立された際、STREAM_META_TOUCH を用いてストリームのメタデータ（タイムスタンプ）を
10 * 形式的に更新する処理を含みます。
11 * その後、クライアントからのメッセージを受け取り、エコーバックします。
12 *
13 * 動作確認のため、ターミナルで `php your_script_name.php` を実行後、
14 * 別のターミナルから `nc localhost 12345` などで接続し、メッセージを送信してみてください。
15 */
16function runSocketServerWithStreamMetaTouch(): void
17{
18    $host = '127.0.0.1'; // サーバーをリッスンするホスト
19    $port = 12345;       // サーバーをリッスンするポート
20
21    // stream_socket_server() でサーバーソケットを作成し、指定されたホストとポートで接続をリッスンします。
22    // STREAM_SERVER_BIND と STREAM_SERVER_LISTEN フラグは、ソケットをバインドしてリッスン状態にするために必要です。
23    $server = stream_socket_server("tcp://$host:$port", $errno, $errstr);
24
25    if (!$server) {
26        echo "エラー: stream_socket_server() に失敗しました: ($errno) $errstr\n";
27        return;
28    }
29
30    echo "TCP/$host:$port でリッスンを開始しました...\n";
31
32    while (true) {
33        // stream_socket_accept() でクライアントからの接続を待機し、接続を受け入れます。
34        // 成功した場合、新しいクライアント接続用のストリームリソースが返されます。
35        // -1 は無期限に待機することを意味します。
36        $client = stream_socket_accept($server, -1);
37
38        if ($client === false) {
39            echo "警告: クライアント接続の受け入れに失敗しました。\n";
40            continue;
41        }
42
43        echo "クライアントが " . stream_socket_get_name($client, true) . " から接続しました。\n";
44
45        // ここで STREAM_META_TOUCH を使用して、新しく受け入れたストリームのメタデータを更新します。
46        // stream_metadata() 関数はストリームのメタデータを設定するために使用されます。
47        // STREAM_META_TOUCH はファイルシステムの 'touch' コマンドのように、
48        // アクセス時刻や変更時刻を更新することを意図しています。
49        // ソケットストリームに対してこの操作は直接的な意味合いが薄いですが、
50        // stream_metadata() の使用例として含めています。
51        $currentTime = time();
52        $metaData = [
53            'atime' => $currentTime, // アクセス時刻
54            'mtime' => $currentTime  // 変更時刻
55        ];
56
57        if (stream_metadata($client, STREAM_META_TOUCH, $metaData)) {
58            echo "クライアント接続ストリームのメタデータ (TOUCH) を更新しました。\n";
59        } else {
60            // ソケットストリームでは、この操作が常にサポートされるとは限りません。
61            echo "クライアント接続ストリームのメタデータ (TOUCH) の更新に失敗しました。\n";
62        }
63
64        // クライアントからのデータを読み込み、エコーバックします。
65        // stream_get_contents() はストリームの残りのデータをすべて読み込みます。
66        $request = stream_get_contents($client);
67        if ($request === false) {
68            echo "警告: クライアントからの読み込みに失敗しました。\n";
69        } else {
70            echo "クライアントから受信: " . trim($request) . "\n";
71            $response = "エコー: " . trim($request) . "\n";
72            fwrite($client, $response); // クライアントに応答を書き込みます
73            echo "クライアントへ送信: " . trim($response) . "\n";
74        }
75
76        // クライアント接続を閉じます。
77        fclose($client);
78        echo "クライアントが切断しました。\n\n";
79    }
80
81    // サーバーソケットを閉じる (この例では無限ループのため、通常到達しません)
82    fclose($server);
83}
84
85// 関数を実行してサーバーを起動します
86runSocketServerWithStreamMetaTouch();

このPHPサンプルコードは、TCPソケットサーバーの基本的な動作と、ストリームのメタデータ操作を示すものです。まず、stream_socket_server()関数を使用してサーバーソケットを作成し、指定されたホストとポートでクライアントからの接続を待ち受けます。その後、無限ループに入り、stream_socket_accept()関数がクライアントからの新しい接続を待機し、接続が確立されると、そのクライアント接続用のストリームリソースを返します。

特にSTREAM_META_TOUCH定数は、stream_metadata()関数と組み合わせて使用されることで、ストリームのメタデータ、具体的にはアクセス時刻や変更時刻を更新することを目的としています。STREAM_META_TOUCH定数自体には引数はなく、特定の戻り値もありません。ソケットストリームの場合、ファイルシステムにおける「touch」コマンドのような直接的な時刻更新の意味合いは薄いことがありますが、これはストリームのメタデータ操作の一例として示されています。接続が確立され、メタデータ更新を試みた後、サーバーはクライアントからメッセージを受信し、それに応答をエコーバックしてから接続を閉じます。このスクリプトは、ターミナルで実行後、別のターミナルからnc localhost 12345などのコマンドで接続して動作を確認できます。