PHPのコンテキストパラメータとは？stream_context_set_params()の使い方を徹底解説

はじめに

PHPにおけるコンテキストパラメータは、ファイルシステムや各種ストリームラッパーへのアクセス動作をカスタマイズするための仕組みです。ストリームの挙動を細かく制御したい場合、PHPが標準で提供している stream_context_set_params() 関数を使用します。

基本構文

stream_context_set_params ( resource $stream_or_context , array $params ) : bool

パラメータの説明

• $stream_or_context: PHPがサポートする任意のストリーム、ラッパー、またはコンテキストリソースを指定できます。
• $params: 設定したいパラメータを格納した連想配列です。形式は $params['paramname'] = "paramvalue"; のようになります。

主なコンテキストパラメータ

notification（通知コールバック）

notification は、ストリームが通知イベントを発生させるたびに呼び出される、ユーザー定義のコールバック関数を指定します。なお、このパラメータは https:// および ftp:// のストリームラッパーでのみ有効です。

通知コールバック関数は、以下のシグネチャに従って定義する必要があります。

stream_notification_callback (
  int $notification_code ,
  int $severity ,
  string $message ,
  int $message_code ,
  int $bytes_transferred ,
  int $bytes_max
) : void

コールバックには、接続状況や転送バイト数などの情報が引数として渡されるため、ダウンロードの進捗表示などに活用できます。

options（オプション配列）

options は、使用中のコンテキストやラッパーに対応した、サポートされているオプションを格納する配列です。タイムアウト値やヘッダー情報など、ラッパーごとの詳細な設定を行う際に使用します。

実装例

以下は、ストリームコンテキストを作成し、通知コールバックを設定してHTTP経由でファイルを取得する例です。

<?php
// 通知を受け取るコールバック関数を定義
function stream_notification_callback(
  $notification_code,
  $severity,
  $message,
  $message_code,
  $bytes_transferred,
  $bytes_max
) {
  // 進捗状況などをここで処理できる
}

// コンテキストを作成し、通知コールバックを設定
$ctx = stream_context_create();
stream_context_set_params($ctx, array("notification" => "stream_notification_callback"));

// コンテキストを指定してファイルを取得
file_get_contents("https://php.net/contact", false, $ctx);
?>

まとめ

stream_context_set_params() を使うことで、ストリーム操作時に通知コールバックやオプションを柔軟に設定できます。特にHTTPやFTP通信の進捗監視・エラーハンドリングにおいて有用な機能なので、ぜひ活用してみてください。