| Methods |
abstract
public
|
dir_closedir(): bool
Close directory handle
Close directory handle
This method is called in response to {@see closedir()}.
Any resources which were locked, or allocated, during opening and use of
the directory stream should be released.
Returns
true on success or false on failure.
|
#
|
abstract
public
|
dir_opendir(string $path, int $options): bool
Open directory handle
Open directory handle
This method is called in response to {@see opendir()}.
Parameters
| $path |
Specifies the URL that was passed to
{@see opendir()}.
|
Returns
true on success or false on failure.
|
#
|
abstract
public
|
dir_readdir(): string|false
Read entry from directory handle
Read entry from directory handle
This method is called in response to {@see readdir()}.
Returns
The next filename, or false if there is no next
file.
|
#
|
abstract
public
|
dir_rewinddir(): bool
Rewind directory handle
Rewind directory handle
This method is called in response to {@see rewinddir()}.
Should reset the output generated by
{@see HasDirectoryHandles::dir_readdir()}, i.e. the next call to
{@see HasDirectoryHandles::dir_readdir()} should return the first entry
in the location returned by {@see HasDirectoryHandles::dir_opendir()}.
Returns
true on success or false on failure.
|
#
|
abstract
public
|
mkdir(string $path, int $mode, int $options): bool
Create a directory
Create a directory
This method is called in response to {@see mkdir()}.
Parameters
| $path |
Directory which should be created.
|
| $mode |
The value passed to {@see mkdir()}.
|
| $options |
A bitwise mask of values, such as
{@see \STREAM_MKDIR_RECURSIVE}.
|
Returns
true on success or false on failure.
|
#
|
abstract
public
|
rename(string $path_from, string $path_to): bool
Renames a file or directory
Renames a file or directory
This method is called in response to {@see rename()}.
Parameters
| $path_from |
The URL to the current file.
|
| $path_to |
The URL which the path_from should be
renamed to.
|
Returns
true on success or false on failure.
|
#
|
abstract
public
|
rmdir(string $path, int $options): bool
Removes a directory
Removes a directory
This method is called in response to {@see rmdir()}.
Parameters
| $path |
The directory URL which should be removed.
|
| $options |
A bitwise mask of values, such as
{@see \STREAM_MKDIR_RECURSIVE}.
|
Returns
true on success or false on failure.
|
#
|
abstract
public
|
stream_lock(int $operation): bool
Advisory file locking
Advisory file locking
This method is called in response to {@see flock()},
{@see file_put_contents()} (when flags contains {@see \LOCK_EX}),
{@see stream_set_blocking()} and when closing the stream
({@see \LOCK_UN}).
Parameters
| $operation |
One of the following:
|
Returns
true on success or false on failure.
|
#
|
abstract
public
|
unlink(string $path): bool
Delete a file
Delete a file
This method is called in response to {@see unlink()}.
Parameters
| $path |
The file URL which should be deleted.
|
Returns
true on success or false on failure.
|
#
|