streamWrapper::rmdir

(PHP 5, PHP 7)

Removes a directory

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

This method is called in response to rmdir().

Note:

In order for the appropriate error message to be returned this method should not be defined if the wrapper does not support removing directories.

Parameters:

path

The directory URL which should be removed.

options

A bitwise mask of values, such as STREAM_MKDIR_RECURSIVE.

Returns:

Returns TRUE on success or FALSE on failure.

Exception:

Emits E_WARNING if call to this method fails (i.e. not implemented).

Notes:

The streamWrapper::$context property is updated if a valid context is passed to the caller function.