(PHP 4 >= 4.3.2, PHP 5, PHP 7)
はじめに
独自のプロトコルハンドラやストリームを実装し、 (fopen() や fread() などの) 他のファイルシステム関数で使用できるようにします。
注意:
これは、実際のクラスではありません。 クラスがどのようにプロトコルを定義すべきかを示す、単なるプロトタイプです。
注意:
ここに示す方法以外でメソッドを実装した場合の挙動は未定義となります。
このクラスのインスタンスは、 関連付けられているプロトコルへのストリーム関数からのアクセスがあった時点で初期化されます。
クラス概要
streamWrapper {
public
resource
$context
/* メソッド */
__construct ( )
__destruct ( )
public dir_closedir ( ) : bool
public dir_opendir
( string $path
, int $options
) : bool
public dir_readdir ( ) : string
public dir_rewinddir ( ) : 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
public stream_eof ( ) : bool
public stream_flush ( ) : 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 ( ) : array
public stream_tell ( ) : 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 が実際のコンテキストリソースを設定できるようにしなければなりません。
目次
- 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 — ファイルについての情報を取得する
/* プロパティ */