Documentation

LocalFilesystemAdapter
in package
implements FilesystemAdapter

Interfaces, Classes, Traits and Enums

FilesystemAdapter

Table of Contents

DISALLOW_LINKS  = 02
SKIP_LINKS  = 01
$linkHandling  : int
$mimeTypeDetector  : MimeTypeDetector
$prefixer  : PathPrefixer
$rootLocation  : string
$rootLocationIsSetup  : bool
$visibility  : VisibilityConverter
$writeFlags  : int
__construct()  : mixed
copy()  : void
createDirectory()  : void
delete()  : void
deleteDirectory()  : void
directoryExists()  : bool
fileExists()  : bool
fileSize()  : FileAttributes
lastModified()  : FileAttributes
listContents()  : iteratable<string|int, StorageAttributes>
mimeType()  : FileAttributes
move()  : void
read()  : string
readStream()  : resource
setVisibility()  : void
visibility()  : FileAttributes
write()  : void
writeStream()  : void
deleteFileInfoObject()  : bool
ensureDirectoryExists()  : void
ensureRootDirectoryExists()  : void
listDirectory()  : Generator
listDirectoryRecursively()  : Generator
resolveDirectoryVisibility()  : int
setPermissions()  : void
writeToFile()  : void

Constants

Properties

Methods

__construct()

public __construct(string $location[, VisibilityConverter $visibility = null ][, int $writeFlags = LOCK_EX ][, int $linkHandling = self::DISALLOW_LINKS ][, MimeTypeDetector $mimeTypeDetector = null ][, bool $lazyRootCreation = false ]) : mixed
Parameters
$location : string
$visibility : VisibilityConverter = null
$writeFlags : int = LOCK_EX
$linkHandling : int = self::DISALLOW_LINKS
$mimeTypeDetector : MimeTypeDetector = null
$lazyRootCreation : bool = false
Return values
mixed —

copy()

public copy(string $source, string $destination, Config $config) : void
Parameters
$source : string
$destination : string
$config : Config
Return values
void —

deleteDirectory()

public deleteDirectory(string $prefix) : void
Parameters
$prefix : 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 —

move()

public move(string $source, string $destination, Config $config) : void
Parameters
$source : string
$destination : string
$config : Config
Return values
void —

readStream()

public readStream(string $path) : resource
Parameters
$path : string
Return values
resource —

setVisibility()

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

write()

public write(string $path, string $contents, Config $config) : void
Parameters
$path : string
$contents : string
$config : Config
Return values
void —

writeStream()

public writeStream(string $path, mixed $contents, Config $config) : void
Parameters
$path : string
$contents : mixed
$config : Config
Return values
void —

deleteFileInfoObject()

protected deleteFileInfoObject(SplFileInfo $file) : bool
Parameters
$file : SplFileInfo
Return values
bool —

ensureDirectoryExists()

protected ensureDirectoryExists(string $dirname, int $visibility) : void
Parameters
$dirname : string
$visibility : int
Return values
void —

listDirectory()

private listDirectory(string $location) : Generator
Parameters
$location : string
Return values
Generator —

listDirectoryRecursively()

private listDirectoryRecursively(string $path[, int $mode = RecursiveIteratorIterator::SELF_FIRST ]) : Generator
Parameters
$path : string
$mode : int = RecursiveIteratorIterator::SELF_FIRST
Return values
Generator —

resolveDirectoryVisibility()

private resolveDirectoryVisibility(string|null $visibility) : int
Parameters
$visibility : string|null
Return values
int —

setPermissions()

private setPermissions(string $location, int $visibility) : void
Parameters
$location : string
$visibility : int
Return values
void —

writeToFile()

private writeToFile(string $path, resource|string $contents, Config $config) : void
Parameters
$path : string
$contents : resource|string
$config : Config
Return values
void —

Search results