stream_context_get_options函數返回什麼數據？典型應用場景和返回值詳細說明

gitbox 2025-08-24

1. stream_context_get_options函數簡介

stream_context_get_options函數用於獲取指定流上下文中的選項。流上下文是PHP提供的一種機制，用於配置流的行為。例如，當你執行文件操作或者HTTP請求時，你可以設置一些特定的選項（如代理、超時、認證等），而這些選項通常會通過流上下文傳遞。

函數的原型如下：

 <span><span><span class="hljs-keyword">array</span></span><span> </span><span><span class="hljs-title function_ invoke__">stream_context_get_options</span></span><span>(resource </span><span><span class="hljs-variable">$stream_or_context</span></span><span>);
</span></span>

$stream_or_context ：這是一個已打開的流或者是一個流上下文資源。如果傳入的是流資源，它會自動從該流的上下文中提取選項。

2. stream_context_get_options返回值

stream_context_get_options返回的是一個關聯數組。這個數組包含了所有與流上下文相關的選項。每個選項的鍵通常是協議類型（例如"http"、"ftp" 等），每個協議類型下面會包含相關的設置。

返回格式

<span><span><span class="hljs-keyword">array</span></span><span>(
    </span><span><span class="hljs-string">'協議名'</span></span><span> =&gt; </span><span><span class="hljs-keyword">array</span></span><span>(
        </span><span><span class="hljs-string">'選項1'</span></span><span> =&gt; </span><span><span class="hljs-string">'值1'</span></span><span>,
        </span><span><span class="hljs-string">'選項2'</span></span><span> =&gt; </span><span><span class="hljs-string">'值2'</span></span><span>,
        ...
    ),
    ...
)
</span></span>

舉個例子，如果你為一個HTTP 請求設置了代理和超時，那麼返回的數組會像這樣：

 <span><span><span class="hljs-keyword">array</span></span><span>(
    </span><span><span class="hljs-string">'http'</span></span><span> =&gt; </span><span><span class="hljs-keyword">array</span></span><span>(
        </span><span><span class="hljs-string">'proxy'</span></span><span> =&gt; </span><span><span class="hljs-string">'tcp://proxy.example.com:8080'</span></span><span>,
        </span><span><span class="hljs-string">'timeout'</span></span><span> =&gt; </span><span><span class="hljs-number">30</span></span><span>,
    ),
)
</span></span>

如果沒有設置任何選項，返回的數組將是一個空數組。

3. 典型應用場景

3.1 獲取流上下文的配置

一個典型的場景是在操作文件、HTTP請求或者其它協議的流時，程序可能需要檢查流上下文的配置是否正確。例如，當你使用file_get_contents讀取遠程文件時，可能已經設置了HTTP代理。你可以使用stream_context_get_options來查看當前上下文的代理設置：

 <span><span><span class="hljs-meta">&lt;?php</span></span><span>
</span><span><span class="hljs-variable">$context</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_context_create</span></span><span>([
    </span><span><span class="hljs-string">'http'</span></span><span> =&gt; [
        </span><span><span class="hljs-string">'proxy'</span></span><span> =&gt; </span><span><span class="hljs-string">'tcp://proxy.example.com:8080'</span></span><span>,
        </span><span><span class="hljs-string">'timeout'</span></span><span> =&gt; </span><span><span class="hljs-number">60</span></span><span>
    ]
]);

</span><span><span class="hljs-variable">$options</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_context_get_options</span></span><span>(</span><span><span class="hljs-variable">$context</span></span><span>);
</span><span><span class="hljs-title function_ invoke__">print_r</span></span><span>(</span><span><span class="hljs-variable">$options</span></span><span>);
</span><span><span class="hljs-meta">?&gt;</span></span><span>
</span></span>

輸出：

 <span><span><span class="hljs-title function_ invoke__">Array</span></span><span>
(
    [http] =&gt; </span><span><span class="hljs-title function_ invoke__">Array</span></span><span>
        (
            [proxy] =&gt; </span><span><span class="hljs-attr">tcp</span></span><span>://proxy.example.</span><span><span class="hljs-attr">com</span></span><span>:</span><span><span class="hljs-number">8080</span></span><span>
            [timeout] =&gt; </span><span><span class="hljs-number">60</span></span><span>
        )
)
</span></span>

通過這種方式，我們可以隨時檢查流上下文中的設置，以確保它們符合預期。

3.2 調試和日誌記錄

在調試網絡請求時，查看流上下文的選項有助於排查問題。比如，你可能希望確認代理設置、請求頭或超時配置是否正確。如果程序遇到網絡問題，查看流上下文的配置信息可以幫助你快速定位問題。例如，在發送HTTP請求時，代理可能無法訪問或超時設置過低，這時你可以打印出配置來確認。

3.3 處理默認配置

在某些情況下，你可能希望修改流上下文中的某些選項並且動態地獲取這些修改後的選項。例如，在多次請求中需要修改代理設置，你可以通過stream_context_get_options獲取當前的配置，並在此基礎上做修改。這樣可以避免每次都重新設置所有選項，減少冗餘配置。

 <span><span><span class="hljs-meta">&lt;?php</span></span><span>
</span><span><span class="hljs-variable">$context</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_context_create</span></span><span>([
    </span><span><span class="hljs-string">'http'</span></span><span> =&gt; [
        </span><span><span class="hljs-string">'timeout'</span></span><span> =&gt; </span><span><span class="hljs-number">30</span></span><span>
    ]
]);

</span><span><span class="hljs-comment">// 獲取當前配置</span></span><span>
</span><span><span class="hljs-variable">$options</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_context_get_options</span></span><span>(</span><span><span class="hljs-variable">$context</span></span><span>);
</span><span><span class="hljs-variable">$options</span></span><span>[</span><span><span class="hljs-string">'http'</span></span><span>][</span><span><span class="hljs-string">'timeout'</span></span><span>] = </span><span><span class="hljs-number">60</span></span><span>; </span><span><span class="hljs-comment">// 修改超時設置</span></span><span>

</span><span><span class="hljs-comment">// 使用修改后的選項进行操作</span></span><span>
</span><span><span class="hljs-variable">$context</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_context_create</span></span><span>([</span><span><span class="hljs-string">'http'</span></span><span> =&gt; </span><span><span class="hljs-variable">$options</span></span><span>[</span><span><span class="hljs-string">'http'</span></span><span>]]);
</span><span><span class="hljs-title function_ invoke__">file_get_contents</span></span><span>(</span><span><span class="hljs-string">'http://example.com'</span></span><span>, </span><span><span class="hljs-literal">false</span></span><span>, </span><span><span class="hljs-variable">$context</span></span><span>);
</span><span><span class="hljs-meta">?&gt;</span></span><span>
</span></span>

3.4 配合其他流函數

stream_context_get_options經常與其他流相關函數一起使用，如stream_socket_client 、 fopen 、 file_get_contents等。例如，打開一個FTP連接後，你可以使用stream_context_get_options獲取當前的FTP配置：

 <span><span><span class="hljs-meta">&lt;?php</span></span><span>
</span><span><span class="hljs-variable">$context</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_context_create</span></span><span>([
    </span><span><span class="hljs-string">'ftp'</span></span><span> =&gt; [
        </span><span><span class="hljs-string">'timeout'</span></span><span> =&gt; </span><span><span class="hljs-number">60</span></span><span>,
    ]
]);

</span><span><span class="hljs-variable">$stream</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fopen</span></span><span>(</span><span><span class="hljs-string">'ftp://example.com/file.txt'</span></span><span>, </span><span><span class="hljs-string">'r'</span></span><span>, </span><span><span class="hljs-literal">false</span></span><span>, </span><span><span class="hljs-variable">$context</span></span><span>);

</span><span><span class="hljs-variable">$options</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_context_get_options</span></span><span>(</span><span><span class="hljs-variable">$stream</span></span><span>);
</span><span><span class="hljs-title function_ invoke__">print_r</span></span><span>(</span><span><span class="hljs-variable">$options</span></span><span>);
</span><span><span class="hljs-meta">?&gt;</span></span><span>
</span></span>

4. 注意事項

stream_context_get_options僅適用於通過stream_context_create或其他方式創建的上下文資源。如果沒有設置上下文或沒有上下文的流，它將返回一個空數組。
返回的選項數組是以協議為鍵進行分類的。例如， http協議有一組選項， ftp協議有另一組選項，因此你應該根據協議類型進行相應的操作。