【PHP8.x】stream_context_get_default()関数の使い方

Copy
1<?php
2
3/**
4 * PHPのデフォルトストリームコンテキストを設定し、取得して確認するサンプル。
5 *
6 * stream_context_set_default() を使ってデフォルトオプションを設定し、
7 * stream_context_get_default() でその設定を取得して検証します。
8 * システムエンジニアを目指す初心者向けに、外部リソースへのアクセス挙動を制御する
9 * ストリームコンテキストの基本的な利用法を示します。
10 */
11function demonstrateDefaultStreamContextHandling(): void
12{
13    echo "--- デフォルトストリームコンテキストの設定を開始します ---\n";
14
15    // 1. stream_context_set_default() を使用して、デフォルトのストリームコンテキストオプションを設定します。
16    //    これは、ファイル操作（file_get_contentsなど）やネットワーク通信（HTTPリクエストなど）の
17    //    デフォルトの振る舞いをグローバルに定義します。
18    $optionsToSet = [
19        'http' => [
20            'timeout'    => 10,                 // HTTPリクエストのタイムアウトを10秒に設定
21            'user_agent' => 'MyPHPStreamApp/1.0', // デフォルトのUser-Agentを設定
22        ],
23        'ssl' => [
24            // セキュリティ上の理由から、本番環境では 'verify_peer' と 'verify_peer_name' を
25            // true に設定し、適切な証明書検証を行うことを強く推奨します。
26            // ここではデモンストレーションのためにfalseに設定しています。
27            'verify_peer'      => false,
28            'verify_peer_name' => false,
29        ],
30    ];
31
32    stream_context_set_default($optionsToSet);
33    echo "デフォルトストリームコンテキストが設定されました。\n\n";
34
35    echo "--- 設定されたデフォルトストリームコンテキストを取得して確認します ---\n";
36
37    // 2. stream_context_get_default() を使用して、現在設定されているデフォルトのストリームコンテキストを取得します。
38    //    この関数は、stream_context_set_default() によって設定されたグローバルなコンテキストを返します。
39    $defaultContextObject = stream_context_get_default();
40
41    if ($defaultContextObject === false) {
42        echo "エラー: デフォルトストリームコンテキストの取得に失敗しました。\n";
43        return;
44    }
45
46    // 3. stream_context_get_options() を使用して、取得したコンテキストオブジェクトから設定されたオプション情報を抽出します。
47    $retrievedOptions = stream_context_get_options($defaultContextObject);
48
49    echo "取得したデフォルトストリームコンテキストのオプション内容:\n";
50    if (!empty($retrievedOptions)) {
51        print_r($retrievedOptions);
52        echo "\n";
53
54        // 設定した値が期待通りに取得できているかを確認します。
55        if (isset($retrievedOptions['http']['timeout']) && $retrievedOptions['http']['timeout'] === 10) {
56            echo "確認: HTTPタイムアウトが期待通りに '10' 秒に設定されています。\n";
57        } else {
58            echo "確認: HTTPタイムアウトの設定が期待と異なります。\n";
59        }
60        if (isset($retrievedOptions['http']['user_agent']) && $retrievedOptions['http']['user_agent'] === 'MyPHPStreamApp/1.0') {
61            echo "確認: User-Agent が期待通りに 'MyPHPStreamApp/1.0' に設定されています。\n";
62        } else {
63            echo "確認: User-Agent の設定が期待と異なります。\n";
64        }
65    } else {
66        echo "デフォルトストリームコンテキストにはオプションが設定されていないか、取得できませんでした。\n";
67    }
68
69    echo "\n--- サンプルコードの実行が完了しました ---\n";
70
71    // 補足: stream_context_set_default() はグローバルな設定を変更するため、
72    // アプリケーション全体に影響を与えます。慎重に利用し、必要に応じて
73    // 特定の処理では stream_context_create() で独自のコンテキストを使用することを検討してください。
74}
75
76// 関数を実行してデモンストレーションを開始
77demonstrateDefaultStreamContextHandling();
78
79?>

stream_context_get_default 関数は、PHPアプリケーション全体に適用されるデフォルトのストリームコンテキストを取得するために使用します。ストリームコンテキストとは、ファイル操作やネットワーク通信など、外部リソースへのアクセス挙動を制御するための設定の集まりです。

このサンプルコードでは、まず stream_context_set_default() 関数を使い、HTTPリクエストのタイムアウトを10秒、User-Agentを特定の文字列に設定するなど、デフォルトのストリームコンテキストオプションをグローバルに設定しています。引数には、プロトコルごとのオプションを連想配列として渡します。

次に stream_context_get_default() を呼び出し、現在設定されているデフォルトのストリームコンテキストをオブジェクトとして取得しています。この関数は引数に ?array $options = null を取りますが、通常は現在のデフォルトを取得するために引数なしで呼び出され、成功するとストリームコンテキストを表す object を、失敗すると false を返します。

取得したオブジェクトは、さらに stream_context_get_options() 関数と組み合わせて使用することで、内部にどのようなオプションが設定されているかを詳細に確認できます。サンプルコードでは、設定したHTTPタイムアウトやUser-Agentが正しく取得できているかを検証しています。これにより、PHPが外部リソースへアクセスする際のデフォルトの振る舞いを把握し、意図した通りの設定が適用されているかを確認することが可能になります。

Copy
1<?php
2
3/**
4 * PHP stream_context_get_default と stream_context_create の利用例
5 *
6 * このスクリプトは、システムエンジニアを目指す初心者向けに、
7 * ストリームコンテキストの基本的な概念と、
8 * デフォルトコンテキストの取得・設定、およびカスタムコンテキストの作成方法を
9 * 簡潔なコードで示します。
10 *
11 * ストリームコンテキストは、ファイルやネットワークリソースへのアクセス（例: file_get_contents, fopen）
12 * をより詳細に制御するための設定の集合体です。
13 */
14
15// 1. 現在のデフォルトストリームコンテキストを取得し、その中身を確認します。
16//    stream_context_get_default() を引数なしで呼び出すと、
17//    PHPが現在使用しているグローバルなデフォルトコンテキストオブジェクトが返されます。
18echo "--- 1. 現在のデフォルトストリームコンテキストの確認 ---" . PHP_EOL;
19$currentDefaultContext = stream_context_get_default();
20if ($currentDefaultContext === false) {
21    echo "デフォルトストリームコンテキストの取得に失敗しました。" . PHP_EOL;
22} else {
23    echo "デフォルトコンテキストの初期状態:" . PHP_EOL;
24    var_dump($currentDefaultContext);
25}
26echo PHP_EOL;
27
28// 2. stream_context_create() を使って、特定の操作にのみ適用されるカスタムストリームコンテキストを作成します。
29//    このコンテキストは、明示的に指定された場合のみ使用されます。
30echo "--- 2. stream_context_create によるカスタムコンテキストの作成と利用例 ---" . PHP_EOL;
31// HTTPリクエスト用のカスタムオプションを定義します。
32// 例えば、特定のUser-Agentを設定したり、タイムアウト値を設定したりできます。
33$customOptions = [
34    'http' => [
35        'method' => 'GET',
36        'header' => 'User-Agent: MyCustomPHPApp/1.0',
37        'timeout' => 5, // タイムアウトを5秒に設定
38    ],
39    'ssl' => [
40        'verify_peer' => true,
41        'verify_peer_name' => true,
42        'allow_self_signed' => false,
43    ],
44];
45
46// 定義したオプションを使って新しいストリームコンテキストオブジェクトを作成します。
47$customContext = stream_context_create($customOptions);
48
49if ($customContext === false) {
50    echo "カスタムストリームコンテキストの作成に失敗しました。" . PHP_EOL;
51} else {
52    echo "カスタムコンテキストが作成されました:" . PHP_EOL;
53    var_dump($customContext);
54
55    // 作成したカスタムコンテキストをfile_get_contentsなどの関数に渡して使用する例。
56    // この設定は、この関数呼び出しにのみ適用され、他の操作には影響しません。
57    // 注意: 以下の行は外部ネットワークアクセスを伴うため、実行環境によっては時間がかかったり、
58    // ネットワークエラーが発生する可能性があります。
59    // $url = 'https://example.com';
60    // echo "カスタムコンテキストを使用して {$url} にアクセスを試みます..." . PHP_EOL;
61    // $response = @file_get_contents($url, false, $customContext);
62    // if ($response !== false) {
63    //     echo "成功: レスポンスの先頭100文字: " . substr($response, 0, 100) . "..." . PHP_EOL;
64    // } else {
65    //     echo "失敗: {$url} へのアクセスでエラーが発生しました。" . PHP_EOL;
66    // }
67}
68echo PHP_EOL;
69
70// 3. stream_context_get_default() の引数にオプションを渡して、
71//    グローバルなデフォルトストリームコンテキストを設定または変更します。
72//    これにより、以降のストリーム操作でこの設定が自動的に適用されるようになります
73//    (明示的に異なるコンテキストが指定されない限り)。
74echo "--- 3. stream_context_get_default によるデフォルトコンテキストの設定と確認 ---" . PHP_EOL;
75// 新しいデフォルトとして設定するオプションを定義します。
76$newDefaultOptions = [
77    'http' => [
78        'method' => 'GET',
79        'header' => 'User-Agent: MyGlobalPHPApp/2.0',
80        'timeout' => 10, // タイムアウトを10秒に設定
81    ],
82];
83
84// stream_context_get_default() にオプションを渡すと、
85// そのオプションで新しいデフォルトコンテキストが設定され、それが返されます。
86$updatedDefaultContext = stream_context_get_default($newDefaultOptions);
87
88if ($updatedDefaultContext === false) {
89    echo "新しいデフォルトストリームコンテキストの設定に失敗しました。" . PHP_EOL;
90} else {
91    echo "新しいデフォルトコンテキストが設定されました:" . PHP_EOL;
92    var_dump($updatedDefaultContext);
93
94    // この新しいデフォルトコンテキストが適用される操作の例。
95    // file_get_contents() にコンテキストを明示的に渡していませんが、
96    // 上記で設定したデフォルトのUser-Agentとtimeoutが使用されます。
97    // 注意: 以下の行は外部ネットワークアクセスを伴うため、実行環境によっては時間がかかったり、
98    // ネットワークエラーが発生する可能性があります。
99    // $url = 'https://example.com';
100    // echo "デフォルトコンテキストを使用して {$url} にアクセスを試みます..." . PHP_EOL;
101    // $response = @file_get_contents($url); // コンテキストを明示的に渡さない
102    // if ($response !== false) {
103    //     echo "成功: レスポンスの先頭100文字 (デフォルト設定): " . substr($response, 0, 100) . "..." . PHP_EOL;
104    // } else {
105    //     echo "失敗: {$url} へのアクセスでエラーが発生しました (デフォルト設定)。" . PHP_EOL;
106    // }
107}
108echo PHP_EOL;
109
110// 4. デフォルトストリームコンテキストのリセット（オプション）
111//    設定したデフォルトを元の状態（または空の状態）に戻したい場合に利用します。
112echo "--- 4. デフォルトストリームコンテキストのリセット ---" . PHP_EOL;
113// 空のオプション配列を渡すことで、実質的にデフォルト設定をクリアします。
114$resetContext = stream_context_get_default([]);
115if ($resetContext !== false) {
116    echo "デフォルトストリームコンテキストがリセットされました:" . PHP_EOL;
117    var_dump($resetContext);
118} else {
119    echo "デフォルトストリームコンテキストのリセットに失敗しました。" . PHP_EOL;
120}
121
122?>

PHPのストリームコンテキストは、ファイルやネットワークリソースへのアクセス（例：file_get_contentsやfopen）をより詳細に制御するための設定の集合体です。この設定には、HTTPリクエストのUser-Agentやタイムアウト時間、SSL/TLS接続の検証設定などが含まれます。

stream_context_get_default()関数は、引数に?array $options = nullを取ります。引数なしで呼び出すと、現在PHPが使用しているグローバルなデフォルトストリームコンテキストオブジェクトを取得できます。一方、$options配列を引数に渡すと、そのオプションで新しいデフォルトストリームコンテキストを設定し、そのオブジェクトを返します。これにより、以降のストリーム操作で明示的にコンテキストを指定しない限り、この設定が自動的に適用されるようになります。戻り値は成功時にobject、失敗時にfalseとなります。

stream_context_create()関数は、stream_context_get_default()と同様に$options配列を引数として受け取りますが、これはグローバルなデフォルトではなく、特定の操作にのみ適用されるカスタムストリームコンテキストオブジェクトを作成するために使用されます。この関数で作成されたコンテキストは、file_get_contents()などの関数に明示的に渡すことで利用され、他のストリーム操作には影響しません。戻り値は成功時にobject、失敗時にfalseです。

これらの関数を使い分けることで、アプリケーション全体に影響するデフォルト設定を管理したり、特定の用途に合わせた一時的な接続設定を柔軟に行うことができます。