Documentation

MountManager
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

$filesystems  : array<string, FilesystemOperator>
__construct()  : mixed
MountManager constructor.
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
copyAcrossFilesystem()  : void
copyInSameFilesystem()  : void
determineFilesystemAndPath()  : array<string|int, mixed>
guardAgainstInvalidMount()  : void
mountFilesystem()  : void
mountFilesystems()  : void
moveAcrossFilesystems()  : void
moveInTheSameFilesystem()  : 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 $location) : int
Parameters
$location : string
Return values
int

has()

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

lastModified()

public lastModified(string $location) : int
Parameters
$location : string
Return values
int

mimeType()

public mimeType(string $location) : string
Parameters
$location : 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 $location) : string
Parameters
$location : 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

copyAcrossFilesystem()

private copyAcrossFilesystem(string|null $visibility, FilesystemOperator $sourceFilesystem, string $sourcePath, FilesystemOperator $destinationFilesystem, string $destinationPath, string $source, string $destination) : void
Parameters
$visibility : string|null
$sourceFilesystem : FilesystemOperator
$sourcePath : string
$destinationFilesystem : FilesystemOperator
$destinationPath : string
$source : string
$destination : string
Return values
void

copyInSameFilesystem()

private copyInSameFilesystem(FilesystemOperator $sourceFilesystem, string $sourcePath, string $destinationPath, string $source, string $destination) : void
Parameters
$sourceFilesystem : FilesystemOperator
$sourcePath : string
$destinationPath : string
$source : string
$destination : string
Return values
void

determineFilesystemAndPath()

private determineFilesystemAndPath(string $path) : array<string|int, mixed>
Parameters
$path : string
Return values
array<string|int, mixed>

guardAgainstInvalidMount()

private guardAgainstInvalidMount(mixed $key, mixed $filesystem) : void
Parameters
$key : mixed
$filesystem : mixed
Return values
void

mountFilesystems()

private mountFilesystems(array<string|int, mixed> $filesystems) : void
Parameters
$filesystems : array<string|int, mixed>
Return values
void

moveAcrossFilesystems()

private moveAcrossFilesystems(string $source, string $destination) : void
Parameters
$source : string
$destination : string
Return values
void

moveInTheSameFilesystem()

private moveInTheSameFilesystem(FilesystemOperator $sourceFilesystem, string $sourcePath, string $destinationPath, string $source, string $destination) : void
Parameters
$sourceFilesystem : FilesystemOperator
$sourcePath : string
$destinationPath : string
$source : string
$destination : string
Return values
void

Search results