streamWrapper クラス

(PHP 4 >= 4.3.2, PHP 5, PHP 7)

はじめに

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

注意:

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

注意:

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

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

クラス概要

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

プロパティ

resource context

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

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

注意:

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

変更履歴

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

参考

目次