FilesystemOperator
extends
FilesystemReader, FilesystemWriter
in
This interface contains everything to read from and inspect a filesystem. All methods containing are non-destructive.
Table of Contents
- LIST_DEEP = true
- LIST_SHALLOW = false
- copy() : void
- createDirectory() : void
- delete() : void
- deleteDirectory() : void
- directoryExists() : bool
- fileExists() : bool
- fileSize() : int
- has() : bool
- lastModified() : int
- listContents() : DirectoryListing<string|int, StorageAttributes>
- mimeType() : string
- move() : void
- read() : string
- readStream() : resource
- setVisibility() : void
- visibility() : string
- write() : void
- writeStream() : void
Constants
LIST_DEEP
public
mixed
LIST_DEEP
= true
LIST_SHALLOW
public
mixed
LIST_SHALLOW
= false
Methods
copy()
public
copy(string $source, string $destination[, array<string|int, mixed> $config = [] ]) : void
Parameters
- $source : string
- $destination : string
- $config : array<string|int, mixed> = []
Tags
Return values
void —createDirectory()
public
createDirectory(string $location[, array<string|int, mixed> $config = [] ]) : void
Parameters
- $location : string
- $config : array<string|int, mixed> = []
Tags
Return values
void —delete()
public
delete(string $location) : void
Parameters
- $location : string
Tags
Return values
void —deleteDirectory()
public
deleteDirectory(string $location) : void
Parameters
- $location : string
Tags
Return values
void —directoryExists()
public
directoryExists(string $location) : bool
Parameters
- $location : string
Tags
Return values
bool —fileExists()
public
fileExists(string $location) : bool
Parameters
- $location : string
Tags
Return values
bool —fileSize()
public
fileSize(string $path) : int
Parameters
- $path : string
Tags
Return values
int —has()
public
has(string $location) : bool
Parameters
- $location : string
Tags
Return values
bool —lastModified()
public
lastModified(string $path) : int
Parameters
- $path : string
Tags
Return values
int —listContents()
public
listContents(string $location[, bool $deep = self::LIST_SHALLOW ]) : DirectoryListing<string|int, StorageAttributes>
Parameters
- $location : string
- $deep : bool = self::LIST_SHALLOW
Tags
Return values
DirectoryListing<string|int, StorageAttributes> —mimeType()
public
mimeType(string $path) : string
Parameters
- $path : string
Tags
Return values
string —move()
public
move(string $source, string $destination[, array<string|int, mixed> $config = [] ]) : void
Parameters
- $source : string
- $destination : string
- $config : array<string|int, mixed> = []
Tags
Return values
void —read()
public
read(string $location) : string
Parameters
- $location : string
Tags
Return values
string —readStream()
public
readStream(string $location) : resource
Parameters
- $location : string
Tags
Return values
resource —setVisibility()
public
setVisibility(string $path, string $visibility) : void
Parameters
- $path : string
- $visibility : string
Tags
Return values
void —visibility()
public
visibility(string $path) : string
Parameters
- $path : string
Tags
Return values
string —write()
public
write(string $location, string $contents[, array<string|int, mixed> $config = [] ]) : void
Parameters
- $location : string
- $contents : string
- $config : array<string|int, mixed> = []
Tags
Return values
void —writeStream()
public
writeStream(string $location, mixed $contents[, array<string|int, mixed> $config = [] ]) : void
Parameters
- $location : string
- $contents : mixed
- $config : array<string|int, mixed> = []