Documentation

Filesystem
in package
implements FilesystemOperator

Interfaces, Classes, Traits and Enums

FilesystemOperator
This interface contains everything to read from and inspect a filesystem. All methods containing are non-destructive.

Table of Contents

$adapter  : FilesystemAdapter
$config  : Config
$pathNormalizer  : PathNormalizer
__construct()  : mixed
copy()  : void
createDirectory()  : void
delete()  : void
deleteDirectory()  : void
directoryExists()  : bool
fileExists()  : bool
fileSize()  : int
has()  : bool
lastModified()  : int
listContents()  : DirectoryListing
mimeType()  : string
move()  : void
read()  : string
readStream()  : mixed
setVisibility()  : void
visibility()  : string
write()  : void
writeStream()  : void
assertIsResource()  : void
rewindStream()  : void

Properties

Methods

copy()

public copy(string $source, string $destination[, array<string|int, mixed> $config = [] ]) : void
Parameters
$source : string
$destination : string
$config : array<string|int, mixed> = []
Return values
void —

createDirectory()

public createDirectory(string $location[, array<string|int, mixed> $config = [] ]) : void
Parameters
$location : string
$config : array<string|int, mixed> = []
Return values
void —

delete()

public delete(string $location) : void
Parameters
$location : string
Return values
void —

deleteDirectory()

public deleteDirectory(string $location) : void
Parameters
$location : string
Return values
void —

directoryExists()

public directoryExists(string $location) : bool
Parameters
$location : string
Return values
bool —

fileExists()

public fileExists(string $location) : bool
Parameters
$location : string
Return values
bool —

fileSize()

public fileSize(string $path) : int
Parameters
$path : string
Return values
int —

has()

public has(string $location) : bool
Parameters
$location : string
Return values
bool —

lastModified()

public lastModified(string $path) : int
Parameters
$path : string
Return values
int —

listContents()

public listContents(string $location[, bool $deep = self::LIST_SHALLOW ]) : DirectoryListing
Parameters
$location : string
$deep : bool = self::LIST_SHALLOW
Return values
DirectoryListing —

mimeType()

public mimeType(string $path) : string
Parameters
$path : string
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> = []
Return values
void —

read()

public read(string $location) : string
Parameters
$location : string
Return values
string —

readStream()

public readStream(string $location) : mixed
Parameters
$location : string
Return values
mixed —

setVisibility()

public setVisibility(string $path, string $visibility) : void
Parameters
$path : string
$visibility : string
Return values
void —

visibility()

public visibility(string $path) : string
Parameters
$path : string
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> = []
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> = []
Return values
void —

assertIsResource()

private assertIsResource(mixed $contents) : void
Parameters
$contents : mixed
Return values
void —

rewindStream()

private rewindStream(resource $resource) : void
Parameters
$resource : resource
Return values
void —

Search results