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

Copy
1<?php
2
3/**
4 * ストリームのメタデータを取得し表示する関数。
5 *
6 * この関数は `stream_get_meta_data()` を使用して、ファイルストリームの
7 * アクセスモードやその他の状態に関するメタ情報を取得する方法を示します。
8 *
9 * STREAM_META_ACCESS 定数は、通常 `stream_notification_callback()` 関数内で、
10 * ストリームのメタデータアクセスに関するイベント通知コードとして利用されます。
11 * このサンプルコードでは、その定数自体を直接使用する代わりに、
12 * 関連する `stream_get_meta_data()` 関数を用いて、ストリームが持つ
13 * アクセス関連のメタデータ（例: 'mode' や 'seekable'）を取得・表示することで、
14 * 「ストリームのメタデータアクセス」という概念を初心者にも分かりやすく説明します。
15 */
16function demonstrateStreamMetaDataAccess(): void
17{
18    // 一時ファイルストリームを読み書きモードで開く
19    // 'w+' モードは、ストリームへの書き込みと読み込みの両方のアクセスを許可します。
20    $handle = fopen('php://temp', 'w+');
21
22    if ($handle === false) {
23        echo "エラー: ストリームを開けませんでした。\n";
24        return;
25    }
26
27    // ストリームにデータを書き込む
28    fwrite($handle, "これはPHPストリームのサンプルデータです。\n");
29
30    // ストリームポインタを先頭に戻す
31    // これにより、書き込んだデータを読み出すことができるようになります。
32    rewind($handle);
33
34    // `stream_get_meta_data()` を使用して、ストリームのメタデータを取得
35    $metaData = stream_get_meta_data($handle);
36
37    echo "--- ストリームのメタデータ情報 ---\n";
38    foreach ($metaData as $key => $value) {
39        if (is_array($value)) {
40            // 配列形式のメタデータ（例: 'wrapper_data'）は文字列に変換して表示
41            echo sprintf("%-15s: %s\n", $key, implode(', ', $value));
42        } else {
43            echo sprintf("%-15s: %s\n", $key, $value);
44        }
45    }
46    echo "----------------------------------\n\n";
47
48    echo "解説:\n";
49    echo "取得されたメタデータには 'mode' (アクセスモード) や 'seekable' (シーク可能か) など、\n";
50    echo "ストリームへのアクセス方法や機能に関する情報が含まれています。\n";
51    echo "STREAM_META_ACCESS 定数は、ストリームの操作中にメタデータが変更されたり、\n";
52    echo "アクセスされたりする際の通知イベントの一種を示す値です。\n";
53    echo "この例で取得した情報は、そのアクセスに関する具体的な状態を示しています。\n";
54
55    // ストリームを閉じる
56    fclose($handle);
57}
58
59// 関数を実行し、ストリームのメタデータ情報を表示
60demonstrateStreamMetaDataAccess();

このサンプルコードは、PHPのstream_get_meta_data()関数を用いて、ファイルストリームのメタデータ（付随情報）を取得し、ストリームへのアクセスに関する情報を確認する方法を示しています。stream_get_meta_data()関数は、開いているストリームリソースを引数に受け取り、そのストリームの現在の状態や特性を表す連想配列を戻り値として返します。この戻り値には、ストリームのオープンモードを示す'mode'や、ストリームポインタを移動できるかを示す'seekable'など、アクセスに関する具体的な情報が含まれます。

コードでは、一時的なファイルストリームを読み書きモード（'w+'）で開き、データを書き込んだ後にストリームポインタを先頭に戻します。その後、stream_get_meta_data()でストリームのメタデータを取得し、その内容を表示しています。これにより、ストリームがどのようなアクセスモードで、どのような機能を持つかを確認できます。

STREAM_META_ACCESS定数自体は、ストリームのメタデータがアクセスされたり変更されたりする際の通知イベントの種類を示すもので、このコードで直接使用されているわけではありません。しかし、この定数が表す「ストリームのメタデータへのアクセス」という概念を、実際にstream_get_meta_data()でアクセス関連情報を取得・表示することで、初心者にも分かりやすく解説しています。

Copy
1<?php
2
3/**
4 * Demonstrates a basic TCP server using stream_socket_accept to handle a single client connection,
5 * and illustrates the existence and value of the STREAM_META_ACCESS constant.
6 *
7 * STREAM_META_ACCESS is a PHP stream constant used in custom stream wrapper implementations.
8 * It signifies that the 'access' attribute of a stream is being requested or modified.
9 * While not directly used as an argument for stream_socket_accept, it is part of the broader
10 * PHP streams functionality and metadata handling.
11 *
12 * To test this server:
13 * 1. Run this script from your terminal: php your_script_name.php
14 * 2. Open another terminal and connect to the server using netcat or telnet:
15 *    nc 127.0.0.1 8000
16 * 3. Type a message and press Enter. The server will respond and then close the connection.
17 */
18function runSimpleSocketServer(): void
19{
20    // Display the value of the STREAM_META_ACCESS constant.
21    // This constant is an integer, typically 10 in PHP 8, representing a specific stream metadata type.
22    echo "Value of STREAM_META_ACCESS constant: " . STREAM_META_ACCESS . "\n\n";
23
24    // Define the address for the server to listen on.
25    // "tcp://127.0.0.1:8000" specifies the TCP protocol, local IP address, and port 8000.
26    $serverAddress = "tcp://127.0.0.1:8000";
27
28    // Create a server socket.
29    // stream_socket_server creates a network socket and binds it to the specified address.
30    // $errno and $errstr will contain error information if the socket creation fails.
31    $server = stream_socket_server($serverAddress, $errno, $errstr);
32
33    if (!$server) {
34        // Handle cases where the server socket could not be created (e.g., port already in use).
35        echo "Error creating server socket: ($errno) $errstr\n";
36        return;
37    }
38
39    echo "Server listening on $serverAddress. Waiting for a single connection...\n";
40
41    // Accept a client connection.
42    // stream_socket_accept waits for an incoming connection on the server socket ($server)
43    // and returns a new stream resource ($client) for the established connection.
44    // This call will block until a client connects.
45    $client = stream_socket_accept($server);
46
47    if ($client) {
48        echo "Client connected!\n";
49
50        // Read up to 1024 bytes of data from the client's request stream.
51        $request = fread($client, 1024);
52        echo "Received from client: '" . trim($request) . "'\n";
53
54        // Prepare a simple HTTP-like response message.
55        $responseBody = "Hello from PHP server!";
56        $response = "HTTP/1.1 200 OK\r\n";
57        $response .= "Content-Type: text/plain\r\n";
58        $response .= "Content-Length: " . strlen($responseBody) . "\r\n";
59        $response .= "Connection: close\r\n\r\n"; // Closes connection after response
60        $response .= $responseBody;
61
62        // Write the response back to the client.
63        fwrite($client, $response);
64        echo "Response sent to client.\n";
65
66        // Close the client connection.
67        fclose($client);
68        echo "Client connection closed.\n";
69    } else {
70        // Handle errors if accepting the connection fails.
71        echo "Failed to accept client connection.\n";
72    }
73
74    // Close the server socket, releasing the port.
75    fclose($server);
76    echo "Server shut down.\n";
77}
78
79// Execute the server demonstration function.
80runSimpleSocketServer();

このPHPコードは、STREAM_META_ACCESS定数の表示と、TCPサーバーの基本的な実装を示しています。STREAM_META_ACCESSは、PHPのストリーム機能で用いられる定数で、ストリームの「アクセス」に関するメタデータを表し、主にカスタムストリームラッパーで使用されます。

まず、stream_socket_server関数で指定されたアドレスにサーバーソケットを作成し、クライアントからの接続を待ち受けます。この関数は、サーバーソケットのリソースを返します。次に、stream_socket_accept関数がサーバーソケット（引数）でクライアントからの接続を待ちます。接続が確立すると、この関数は新しいクライアント接続用のストリームリソースを返します。クライアントからのデータを受け取り（fread）、シンプルな応答を送信後（fwrite）、クライアント接続とサーバーソケットをfclose関数で閉じます。これにより、PHPで単一のクライアントとのTCP通信を確立し、データを送受信する一連の流れを学ぶことができます。