ストリーム

はじめに

ストリームは、ファイル、ネットワーク、データ圧縮などに関する、共通した一連の関数群と利用法を持つ操作の一般化の手法です。もっとも単純な定義では、ストリーム というのは、ストリーミング可能な動作を体現する resource オブジェクトといえます。つまり、ストリームには線的に読み出したり、あるいは書き込んだりすることが可能で、かつ、ストリーム上の任意の場所に fseek() できる場合もあります。

ラッパー というのは、ストリームにおいてどのように特定のプロトコル/エンコーディングを扱うかを扱うかを指示する付加的なコードです。たとえば、http ラッパーは、どのようにして URL を、リモートサーバーのファイルに対する HTTP/1.0 リクエストに転換するかを知っています。PHP には、デフォルトで組み込まれているラッパーが多数存在しますが (サポートするプロトコル/ラッパーを参照ください)、それに加え、カスタムラッパーをstream_wrapper_register() を利用して PHP スクリプトの内部から、あるいはストリーム API を用いて、直接拡張モジュールの内部から追加できます。あらゆる種類のラッパーが PHP に追加できるので、特にラッパーでできることの限界はありません。現在登録されているラッパーの種類を知るには、 stream_get_wrappers() を使います。

リソースは次のような形でストリームとして参照されます: scheme://target

scheme(string) - 使用されるラッパーの名称です。例として、 file, http, https, ftp, ftps, compress.zlib, compress.bz2, php などが含まれます。 PHP 組み込みのラッパーについては、サポートするプロトコル/ラッパーを参照ください。もしラッパーが指定されていない場合は、使用している関数のデフォルトが利用されます(通常は file://)。
target - 使用するラッパーによって解釈が異なります。ファイルシステムに関連したストリームの場合、一般的にこのパラメータは対象となるファイルのファイル名とパスを表します。ネットワークに関連したストリームの場合、一般的にこのパラメータはホスト名と、(多くの場合付加されるはずの) パス名です。 PHP 組み込みのラッパーに、どのようにターゲットが解釈されるかは、サポートするプロトコル/ラッパーを参照ください。

インストール/設定
- ストリームのクラス
定義済み定数
ストリームフィルタ
ストリームコンテキスト
ストリームのエラー
例
- ストリームラッパーとして登録するクラスの例
php_user_filter — php_user_filter クラス
- php_user_filter::filter — フィルタを適用するときにコールされる
- php_user_filter::onClose — フィルタを閉じるときにコールされる
- php_user_filter::onCreate — フィルタを作成するときにコールされる
streamWrapper — streamWrapper クラス
- streamWrapper::__construct — 新しいストリームラッパーを作成する
- streamWrapper::__destruct — 既存のストリームラッパーを破棄する
- streamWrapper::dir_closedir — ディレクトリハンドルを閉じる
- streamWrapper::dir_opendir — ディレクトリハンドルをオープンする
- streamWrapper::dir_readdir — ディレクトリハンドルからエントリを読み込む
- streamWrapper::dir_rewinddir — ディレクトリハンドルを巻き戻す
- streamWrapper::mkdir — ディレクトリを作成する
- streamWrapper::rename — ファイルあるいはディレクトリの名前を変える
- streamWrapper::rmdir — ディレクトリを削除する
- streamWrapper::stream_cast — 元となるリソースを取得する
- streamWrapper::stream_close — リソースを閉じる
- streamWrapper::stream_eof — ファイルポインタが終端にあるかどうかを調べる
- streamWrapper::stream_flush — 出力をフラッシュする
- streamWrapper::stream_lock — ファイルのアドバイザリ・ロック
- streamWrapper::stream_metadata — ストリームメタデータを変更する
- streamWrapper::stream_open — ファイルあるいは URL をオープンする
- streamWrapper::stream_read — ストリームから読み込む
- streamWrapper::stream_seek — ストリーム内の特定の場所に移動する
- streamWrapper::stream_set_option — ストリームのオプションを変更する
- streamWrapper::stream_stat — ファイルリソースについての情報を取得する
- streamWrapper::stream_tell — ストリームの現在位置を取得する
- streamWrapper::stream_truncate — ストリームを丸める
- streamWrapper::stream_write — ストリームに書き込む
- streamWrapper::unlink — ファイルを削除する
- streamWrapper::url_stat — ファイルについての情報を取得する
ストリーム関数
- stream_bucket_append — bucket を brigade に追加する
- stream_bucket_make_writeable — 操作する brigade から bucket オブジェクトを返す
- stream_bucket_new — 現在のストリームで使用する新しい bucket を作成する
- stream_bucket_prepend — bucket を brigade の先頭に追加する
- stream_context_create — ストリームコンテキストを作成する
- stream_context_get_default — デフォルトのストリームコンテキストを取得する
- stream_context_get_options — ストリーム / ラッパー / コンテキストに設定されているオプションを取得する
- stream_context_get_params — コンテキストのパラメータを取得する
- stream_context_set_default — デフォルトのストリームコンテキストを設定する
- stream_context_set_option — ストリーム / ラッパー / コンテキストのオプションを設定する
- stream_context_set_options — 指定されたコンテキストのオプションを設定する
- stream_context_set_params — ストリーム / ラッパー / コンテキストのパラメータを設定する
- stream_copy_to_stream — データをあるストリームから別のストリームにコピーする
- stream_filter_append — ストリームにフィルタを付加する
- stream_filter_prepend — フィルタをストリームに付加する
- stream_filter_register — ユーザー定義のストリームフィルタを登録する
- stream_filter_remove — ストリームからフィルタを取り除く
- stream_get_contents — 残りのストリームを文字列に読み込む
- stream_get_filters — 登録されているフィルタのリストを取得する
- stream_get_line — 指定されたデリミタの位置までのデータを一行分としてストリームから読み込む
- stream_get_meta_data — ヘッダーあるいはメタデータをストリームまたはファイルポインタから取得する
- stream_get_transports — 登録されたソケットのトランスポートの一覧を取得する
- stream_get_wrappers — 登録されているストリームのラッパーのリストを取得する
- stream_is_local — ローカルストリームかどうかを調べる
- stream_isatty — ストリームがターミナル型のデバイスかを調べる
- stream_notification_callback — notification コンテキストパラメータ用のコールバック関数
- stream_register_wrapper — stream_wrapper_register のエイリアス
- stream_resolve_include_path — インクルードパスに対してファイル名を解決する
- stream_select — select() システムコールと同等の操作を、ストリームの配列に対して seconds と microseconds で指定されたタイムアウト時間をもって行う
- stream_set_blocking — ストリームのブロックモードを有効にする / 解除する
- stream_set_chunk_size — ストリームのチャンクサイズを設定する
- stream_set_read_buffer — 指定したストリームのファイル読み込みバッファリングを有効にする
- stream_set_timeout — ストリームにタイムアウトを設定する
- stream_set_write_buffer — 指定されたストリームのファイル書き込みバッファリングを有効にする
- stream_socket_accept — stream_socket_server で作られたソケットの接続を受け入れる
- stream_socket_client — インターネットドメインまたは Unix ドメインのソケット接続を開く
- stream_socket_enable_crypto — 接続済みのソケットについて暗号化の on/off を切り替える
- stream_socket_get_name — ローカルまたはリモートのソケットの名前を取得する
- stream_socket_pair — 接続された、区別できないソケットストリームの組を作成する
- stream_socket_recvfrom — 接続されているかどうかにかかわらず、ソケットからのデータを受信する
- stream_socket_sendto — 接続されているかどうかにかかわらず、ソケットにデータを送信する
- stream_socket_server — インターネットドメインまたは Unix ドメインのサーバーソケットを作成する
- stream_socket_shutdown — 全二重接続を終了する
- stream_supports_lock — ストリームがロックをサポートしているかどうかを調べる
- stream_wrapper_register — PHP のクラスとして実装された URL ラッパーを登録する
- stream_wrapper_restore — 事前に登録を解除された組み込みラッパーを復元する
- stream_wrapper_unregister — URL ラッパーの登録を解除する