function PhpStreamWrapperInterface::rmdir
Same name in other branches
- 9 core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::rmdir()
- 8.9.x core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::rmdir()
- 11.x core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::rmdir()
Removes a directory.
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.
Note, the streamWrapper::$context property is updated if a valid context is passed to the caller function.
Parameters
string $path: The directory URL which should be removed.
int $options: A bitwise mask of values, such as STREAM_MKDIR_RECURSIVE.
Return value
bool Returns TRUE on success or FALSE on failure.
See also
rmdir()
PhpStreamWrapperInterface::mkdir()
PhpStreamWrapperInterface::unlink()
http://php.net/manual/en/streamwrapper.rmdir.php
2 methods override PhpStreamWrapperInterface::rmdir()
- LocalStream::rmdir in core/
lib/ Drupal/ Core/ StreamWrapper/ LocalStream.php - Removes a directory.
- ReadOnlyStream::rmdir in core/
lib/ Drupal/ Core/ StreamWrapper/ ReadOnlyStream.php - Support for rmdir().
File
-
core/
lib/ Drupal/ Core/ StreamWrapper/ PhpStreamWrapperInterface.php, line 152
Class
- PhpStreamWrapperInterface
- Defines a generic PHP stream wrapper interface.
Namespace
Drupal\Core\StreamWrapperCode
public function rmdir($path, $options);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.