【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 が利用できない環境や、よりシンプルな実装が必要な場合に役立ちます。戻り値は、作成されたストリームコンテキストを表すリソースです。

Copy
1<?php
2
3/**
4 * HTTPリクエストにカスタムヘッダを含めて外部URLの内容を取得する関数。
5 *
6 * stream_context_create を使用して、HTTPコンテキストにリクエストヘッダ情報を追加する方法を示します。
7 * この関数は、file_get_contents などのストリーム関数がリモートリソースにアクセスする際の挙動を制御します。
8 *
9 * @param string $url 取得するURL
10 * @return string|false 取得したコンテンツ。失敗した場合は false。
11 */
12function fetchUrlWithCustomHeader(string $url): string|false
13{
14    // stream_context_create に渡すオプションを定義します。
15    // 'http' ストリームラッパーには 'header' オプションで追加のHTTPヘッダを設定できます。
16    $options = [
17        'http' => [
18            'method' => 'GET', // HTTPメソッドをGETに設定
19            'header' => "User-Agent: MyPHPApp/1.0 (stream_context_create sample)\r\n" .
20                        "X-Custom-Request-ID: abc-123\r\n" .
21                        "Accept-Language: en-US,ja;q=0.8\r\n",
22            // 'ignore_errors' を true に設定すると、HTTPエラーコード（例: 404, 500）が
23            // 返された場合でもコンテンツの取得を試みます。
24            'ignore_errors' => true
25        ]
26    ];
27
28    // stream_context_create を使用してストリームコンテキストを作成します。
29    // このコンテキストは、その後のストリーム操作（file_get_contentsなど）で使用されます。
30    $context = stream_context_create($options);
31
32    // file_get_contents を使用して、作成したコンテキストで指定されたURLの内容を取得します。
33    // 第3引数に $context を渡すことで、定義したヘッダがリクエストに含まれます。
34    $content = file_get_contents($url, false, $context);
35
36    // コンテンツ取得の成否を確認します。
37    if ($content === false) {
38        error_log("エラー: URL '{$url}' の取得に失敗しました。");
39        return false;
40    }
41
42    return $content;
43}
44
45// --- 関数使用例 ---
46
47// 実際にリクエストを送るURLを指定します。
48// 例として example.com を使用しますが、他のURLに置き換えても動作します。
49$targetUrl = 'https://www.example.com/'; 
50
51echo "URL: {$targetUrl} からカスタムヘッダ付きでコンテンツを取得します。\n\n";
52
53// 関数を呼び出し、結果を取得します。
54$result = fetchUrlWithCustomHeader($targetUrl);
55
56if ($result !== false) {
57    echo "--- 取得したコンテンツのプレビュー (最初の500文字) ---\n";
58    // 取得したコンテンツが非常に長い場合があるので、最初の部分のみ表示します。
59    echo mb_substr($result, 0, 500) . (mb_strlen($result) > 500 ? '...' : '') . "\n";
60    echo "--------------------------------------------------------\n";
61} else {
62    echo "エラー: コンテンツの取得に失敗しました。詳細はログを確認してください。\n";
63}

PHPのstream_context_create関数は、外部のファイルやURLなどへアクセスする際の挙動を細かく制御するための「ストリームコンテキスト」と呼ばれる設定のまとまりを作成します。これは、インターネット上のウェブサイトから情報を取得する際、通常とは異なるHTTPヘッダを送信したい場合などに特に役立ちます。

この関数は主に二つの引数を取りますが、重要なのは最初の引数$optionsです。ここには、HTTP通信やFTP通信といったストリームの種類に応じた詳細な設定を配列形式で指定します。サンプルコードでは、HTTP通信の設定として、リクエストメソッドをGETに設定したり、User-AgentやX-Custom-Request-IDといったカスタムHTTPヘッダを含めたりする設定を定義しています。また、ignore_errorsオプションにより、HTTPエラーコード（例: 404, 500）が返された場合でもコンテンツの取得を試みるよう指定しています。

stream_context_createは、これらの設定情報が格納された「リソース」と呼ばれる特別な値を返します。このリソースは、file_get_contentsやfopenといったPHPのストリーム操作関数に渡すことで、作成したカスタム設定が適用された状態で外部リソースへのアクセスが行われるようになります。

サンプルコードでは、stream_context_createでカスタムヘッダを含むHTTPコンテキストを作成し、それをfile_get_contents関数に適用してhttps://www.example.com/からコンテンツを取得しています。これにより、普段のブラウザアクセスでは見られないような、独自のヘッダ情報を持ったリクエストをサーバーへ送ることができます。この関数を理解することで、外部サービスとの連携や、特定の条件でのデータ取得など、PHPでの通信制御の幅が大きく広がります。

Copy
1<?php
2
3/**
4 * 指定されたURLから内容をタイムアウト付きで取得します。
5 *
6 * @param string $url 取得するURL。
7 * @param int $timeoutSeconds タイムアウト時間（秒）。
8 * @return string|null 取得したコンテンツ、またはエラー発生時はnull。
9 */
10function fetchUrlWithTimeout(string $url, int $timeoutSeconds): ?string
11{
12    // ストリームコンテキストのオプションを定義します。
13    // 'http' ラッパーの場合、'timeout' オプションで接続およびデータ転送の合計時間を設定します。
14    $options = [
15        'http' => [
16            'timeout' => $timeoutSeconds, // タイムアウト時間を秒単位で設定
17            'method'  => 'GET',          // HTTPメソッドを指定
18        ],
19    ];
20
21    // 定義されたオプションでストリームコンテキストを作成します。
22    // stream_context_create は成功するとリソース型を、失敗すると false を返します。
23    $context = stream_context_create($options);
24
25    // コンテキストの作成に失敗した場合はエラーを出力し、nullを返します。
26    if ($context === false) {
27        echo "エラー: ストリームコンテキストの作成に失敗しました。\n";
28        return null;
29    }
30
31    echo "URL: '{$url}' を {$timeoutSeconds}秒のタイムアウトで取得を試みています...\n";
32
33    // 作成したコンテキストを使用して、file_get_contentsでURLの内容を取得します。
34    // @ 演算子を使用して、PHPが生成する警告やエラーを抑制し、カスタムで処理します。
35    $content = @file_get_contents($url, false, $context);
36
37    // 取得に失敗した場合（タイムアウトを含む）
38    if ($content === false) {
39        // 直前のPHPエラー情報を取得し、より具体的な原因を特定します。
40        $lastError = error_get_last();
41        if (isset($lastError['message'])) {
42            // タイムアウト関連のエラーメッセージを検出します。
43            if (str_contains($lastError['message'], 'timed out') || str_contains($lastError['message'], 'connection refused')) {
44                echo "失敗: '{$url}' は {$timeoutSeconds}秒以内にタイムアウトしました。\n";
45            } else {
46                echo "失敗: '{$url}' の取得中に予期せぬエラーが発生しました。詳細: " . $lastError['message'] . "\n";
47            }
48        } else {
49            echo "失敗: '{$url}' の取得中に不明なエラーが発生しました。\n";
50        }
51        return null;
52    }
53
54    echo "成功: '{$url}' から内容を取得しました。コンテンツ長: " . strlen($content) . " バイト。\n";
55    return $content;
56}
57
58// --- サンプルコードの実行例 ---
59
60// 例1: 意図的にタイムアウトを発生させるケース
61// 'https://httpbin.org/delay/3' は3秒後にHTTP応答を返します。
62// タイムアウトを1秒に設定することで、このリクエストはタイムアウトします。
63$slowUrl = 'https://httpbin.org/delay/3';
64$shortTimeout = 1; // 1秒のタイムアウト
65
66fetchUrlWithTimeout($slowUrl, $shortTimeout);
67
68echo "\n----------------------------------------\n\n";
69
70// 例2: 正常にコンテンツを取得するケース
71// 'https://www.example.com' は通常高速に応答します。
72// タイムアウトを5秒に設定することで、このリクエストは成功します。
73$fastUrl = 'https://www.example.com';
74$sufficientTimeout = 5; // 5秒のタイムアウト
75
76fetchUrlWithTimeout($fastUrl, $sufficientTimeout);
77
78?>

stream_context_create関数は、PHPでファイルやネットワークなどの「ストリーム」を扱う際に、その動作を細かく設定するための「コンテキスト」を作成する機能です。この関数を利用することで、特にHTTPリクエストにおいて、通信のタイムアウト時間や使用するHTTPメソッドなど、より詳細な挙動を制御できるようになります。

関数の第一引数である$optionsには、設定したいオプションを連想配列形式で指定します。例えば、HTTP通信であれば'http'というキーの下に'timeout'オプションを設定することで、接続からデータ受信までの合計タイムアウト時間を秒単位で指定できます。また、'method'オプションでHTTPリクエストメソッド（GET, POSTなど）も設定可能です。この関数は、設定が成功するとストリームコンテキストを表す「リソース型」の値を返し、失敗した場合にはfalseを返しますので、返り値を確認して適切にエラーを処理することが重要です。

サンプルコードのfetchUrlWithTimeout関数は、このstream_context_create関数を使って、指定されたURLを特定のタイムアウト時間で取得する具体的な例を示しています。まず、$options配列でタイムアウト時間とHTTPメソッドを設定し、それを用いてコンテキストを作成します。そして、作成したコンテキストをfile_get_contents関数の引数として渡すことで、設定されたタイムアウトが適用され、長時間の応答待ちを防ぐことができます。これにより、外部へのネットワークアクセスを安定かつ効率的に管理し、アプリケーションの信頼性を高めることが可能です。