streamWrapper::rmdir

(PHP 5, PHP 7)

streamWrapper::rmdir — ディレクトリを削除する

説明

public streamWrapper::rmdir ( string $path , int $options ) : bool

このメソッドは、rmdir() に対応してコールされます。

注意:

適切なエラーメッセージを返すためには、 ラッパーがディレクトリの削除に対応していない場合にはこのメソッドを定義しては いけません。

パラメータ

path

削除したいディレクトリの URL。

options

STREAM_MKDIR_RECURSIVE などの値のビットマスク。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

エラー / 例外

このメソッドのコールに (未実装などの理由で) 失敗した場合、 E_WARNING を発行します。

注意

注意:

有効なコンテキストがコール元関数に渡された場合に streamWrapper::$context プロパティが更新されます。

参考