【PHP8.x】stream_context_create関数の使い方

Copy
1<?php
2
3// HTTP リクエストヘッダーを複数設定する例
4$options = [
5    'http' => [
6        'method'  => 'GET',
7        'header'  => "Content-type: application/x-www-form-urlencoded\r\n" .
8                     "X-Custom-Header: value1\r\n" .
9                     "X-Another-Header: value2\r\n",
10        'content' => http_build_query(['var1' => 'somecontent', 'var2' => 'othercontent'])
11    ]
12];
13
14// ストリームコンテキストを作成
15$context  = stream_context_create($options);
16
17// ファイルの内容を取得 (HTTPリクエストを実行)
18$result = file_get_contents('http://example.com/api/endpoint', false, $context);
19
20// 結果を出力
21if ($result === FALSE) {
22    echo "Error fetching URL.\n";
23} else {
24    echo $result;
25}
26
27?>

stream_context_create関数は、ストリームコンテキストを作成するために使用します。ストリームコンテキストは、fopen()、file_get_contents()、stream_socket_client()などのファイルシステム関数やネットワーク関数にオプションを設定するために利用されます。

引数 $options は、コンテキストのオプションを連想配列で指定します。この例では、http オプションを使用してHTTPリクエストの詳細を設定しています。http オプション内では、method でHTTPメソッド（ここではGET）を指定し、header で複数のHTTPリクエストヘッダーを設定しています。複数のヘッダーは、改行コード \r\n で区切って連結します。content オプションは、POSTリクエストなどで送信するデータを指定するために使用します。ここでは、http_build_query() 関数を使って、連想配列をURLエンコードされた文字列に変換しています。

引数 $params は、ストリームコンテキストのパラメータを連想配列で指定します。通常は $options で十分な設定が可能なため、省略されることが多いです。

戻り値は、作成されたストリームコンテキストのリソースです。このリソースは、file_get_contents() などの関数で利用できます。

サンプルコードでは、stream_context_create() 関数でHTTPリクエストヘッダーを複数設定したストリームコンテキストを作成し、file_get_contents() 関数に渡すことで、指定したURLからデータを取得しています。取得に失敗した場合はエラーメッセージを表示し、成功した場合は取得した内容を出力します。これにより、HTTPリクエスト時にカスタムヘッダーを付与してAPIエンドポイントと通信することが可能になります。

Copy
1<?php
2
3/**
4 * stream_context_create を使用して HTTP リクエストを送信する例。
5 * cURL を使用した場合との比較。
6 */
7
8// stream_context_create を使用した例
9function streamContextExample(string $url): string
10{
11    $options = [
12        'http' => [
13            'method'  => 'GET',
14            'header'  => "Content-type: text/plain\r\n",
15            'timeout' => 10 // タイムアウトを10秒に設定
16        ]
17    ];
18
19    $context  = stream_context_create($options);
20    $result = @file_get_contents($url, false, $context); // @ でエラーを抑制
21
22    if ($result === false) {
23        $error = error_get_last();
24        return "Error: " . $error['message'];
25    }
26
27    return $result;
28}
29
30
31// cURL を使用した例
32function curlExample(string $url): string
33{
34    $ch = curl_init($url);
35
36    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
37    curl_setopt($ch, CURLOPT_TIMEOUT, 10); // タイムアウトを10秒に設定
38    curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-type: text/plain"]);
39
40    $result = curl_exec($ch);
41
42    if (curl_errno($ch)) {
43        $error_msg = curl_error($ch);
44        curl_close($ch);
45        return "cURL Error: " . $error_msg;
46    }
47
48    curl_close($ch);
49
50    return $result;
51}
52
53// 使用例
54$url = 'https://www.example.com';
55
56echo "stream_context_create Result:\n";
57echo streamContextExample($url) . "\n\n";
58
59echo "cURL Result:\n";
60echo curlExample($url) . "\n";

stream_context_create関数は、ストリームコンテキストを作成するために使用されます。ストリームコンテキストとは、file_get_contentsなどのファイル操作関数やソケット関数に対して、オプションやパラメータを設定するためのものです。引数 $options には、HTTPメソッド、ヘッダー、タイムアウトなどのオプションを配列で指定します。引数 $params は、ストリームに関するパラメータを設定するために使用されますが、通常は $options のみを使用します。

このサンプルコードでは、stream_context_create を使用して HTTP GET リクエストを送信する方法を、cURL を使用した場合と比較して示しています。streamContextExample 関数は、stream_context_create で HTTP ヘッダーとタイムアウトを設定し、file_get_contents 関数で指定されたURLからコンテンツを取得します。エラーが発生した場合は、エラーメッセージを返します。 @ 演算子は、file_get_contents 関数で発生する可能性のあるエラーメッセージを抑制するために使用されています。

一方、curlExample 関数は、cURL ライブラリを使用して同様の HTTP リクエストを送信します。curl_setopt 関数で、HTTP ヘッダー、タイムアウト、およびレスポンスを文字列として返すオプションを設定しています。curl_exec 関数でリクエストを実行し、エラーが発生した場合はエラーメッセージを返します。

どちらの方法でも HTTP リクエストを送信できますが、cURL の方がより多くのオプションと柔軟性を提供します。しかし、stream_context_create は、cURL が利用できない環境や、よりシンプルな実装が必要な場合に役立ちます。戻り値は、作成されたストリームコンテキストを表すリソースです。