php_user_filter::onCreate
streamWrapper::__construct
ストリーム
PHP Manual

# streamWrapper クラス

(PHP 4 >= 4.3.2, PHP 5)

## 導入

独自のプロトコルハンドラやストリームを実装し、 ( fopen() や fread() などの) 他のファイルシステム関数で使用できるようにします。

> 注意:

> これは、実際のクラスではありません。 クラスがどのようにプロトコルを定義すべきかを示す、単なるプロトタイプです。

> 注意:

> ここに示す方法以外でメソッドを実装した場合の挙動は未定義となります。

このクラスのインスタンスは、 関連付けられているプロトコルへのストリーム関数からのアクセスがあった時点で初期化されます。

## クラス概要

streamWrapper {
/* プロパティ */
public resource $context ;
/* メソッド */
__construct ( void )
__destruct ( void )
public bool dir_closedir ( void )
public bool dir_opendir ( string `$path` , int `$options` )
public string dir_readdir ( void )
public bool dir_rewinddir ( void )
public bool mkdir ( string `$path` , int `$mode` , int `$options` )
public bool rename ( string `$path_from` , string `$path_to` )
public bool rmdir ( string `$path` , int `$options` )
public resource stream_cast ( int `$cast_as` )
public void stream_close ( void )
public bool stream_eof ( void )
public bool stream_flush ( void )
public bool stream_lock ( int `$operation` )
public bool stream_metadata ( string `$path` , int `$option` , mixed `$value` )
public bool stream_open ( string `$path` , string `$mode` , int `$options` , string `&$opened_path` )
public string stream_read ( int `$count` )
public bool stream_seek ( int `$offset` , int `$whence` = SEEK_SET )
public bool stream_set_option ( int `$option` , int `$arg1` , int `$arg2` )
public array stream_stat ( void )
public int stream_tell ( void )
public bool stream_truncate ( int `$new_size` )
public int stream_write ( string `$data` )
public bool unlink ( string `$path` )
public array url_stat ( string `$path` , int `$flags` )
}

## プロパティ

resource context

  現在のコンテキスト、 あるいは呼び出し元からコンテキストが渡されていない場合は `NULL`。

  stream_context_get_options() を用いてコンテキストをパースします。

  > 注意:

  > このプロパティは必ず public とし、 PHP が実際のコンテキストリソースを設定できるようにしなければなりません。

## 変更履歴

バージョン | 説明
--- | ---
5.0.0 | context プロパティが追加されました。

## 参考

- ストリームラッパーとして登録するクラスの例
- stream_wrapper_register()
- stream_wrapper_unregister()
- stream_wrapper_restore()

## 目次

- 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 — ファイルについての情報を取得する

php_user_filter::onCreate
streamWrapper::__construct
ストリーム
PHP Manual