Constants

Properties

$pathPrefix

$pathPrefix : string|null

Type

string|null — path prefix

$pathSeparator

$pathSeparator : string

Type

string

$permissions

$permissions : array

Type

array

$permissionMap

$permissionMap : array

Type

array

$writeFlags

$writeFlags : int

Type

int

$linkHandling

$linkHandling : int

Type

int

Methods

setPathPrefix()

setPathPrefix(string  $prefix) : void

Set the path prefix.

Parameters

string $prefix

getPathPrefix()

getPathPrefix() : string|null

Get the path prefix.

Returns

string|null —

path prefix or null if pathPrefix is empty

applyPathPrefix()

applyPathPrefix(string  $path) : string

Prefix a path.

Parameters

string $path

Returns

string —

prefixed path

removePathPrefix()

removePathPrefix(string  $path) : string

Remove a path prefix.

Parameters

string $path

Returns

string —

path without the prefix

__construct()

__construct(string  $root, int  $writeFlags = LOCK_EX, int  $linkHandling = self::DISALLOW_LINKS, array  $permissions = []) : mixed

Constructor.

Parameters

string $root
int $writeFlags
int $linkHandling
array $permissions

Throws

\LogicException

Returns

mixed —

has()

has(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

write()

write(mixed  $path, mixed  $contents, \League\Flysystem\Config  $config) : mixed

Parameters

mixed $path
mixed $contents
\League\Flysystem\Config $config

Returns

mixed —

writeStream()

writeStream(mixed  $path, mixed  $resource, \League\Flysystem\Config  $config) : mixed

Parameters

mixed $path
mixed $resource
\League\Flysystem\Config $config

Returns

mixed —

readStream()

readStream(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

updateStream()

updateStream(mixed  $path, mixed  $resource, \League\Flysystem\Config  $config) : mixed

Parameters

mixed $path
mixed $resource
\League\Flysystem\Config $config

Returns

mixed —

update()

update(mixed  $path, mixed  $contents, \League\Flysystem\Config  $config) : mixed

Parameters

mixed $path
mixed $contents
\League\Flysystem\Config $config

Returns

mixed —

read()

read(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

rename()

rename(mixed  $path, mixed  $newpath) : mixed

Parameters

mixed $path
mixed $newpath

Returns

mixed —

copy()

copy(mixed  $path, mixed  $newpath) : mixed

Parameters

mixed $path
mixed $newpath

Returns

mixed —

delete()

delete(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

listContents()

listContents(mixed  $directory = '', mixed  $recursive = false) : mixed

Parameters

mixed $directory
mixed $recursive

Returns

mixed —

getMetadata()

getMetadata(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

getSize()

getSize(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

getMimetype()

getMimetype(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

getTimestamp()

getTimestamp(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

getVisibility()

getVisibility(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

setVisibility()

setVisibility(mixed  $path, mixed  $visibility) : mixed

Parameters

mixed $path
mixed $visibility

Returns

mixed —

createDir()

createDir(mixed  $dirname, \League\Flysystem\Config  $config) : mixed

Parameters

mixed $dirname
\League\Flysystem\Config $config

Returns

mixed —

deleteDir()

deleteDir(mixed  $dirname) : mixed

Parameters

mixed $dirname

Returns

mixed —

ensureDirectory()

ensureDirectory(string  $root) : void

Ensure the root directory exists.

Parameters

string $root

root directory path

Throws

\League\Flysystem\Exception

in case the root directory can not be created

deleteFileInfoObject()

deleteFileInfoObject(\SplFileInfo  $file) : mixed

Parameters

\SplFileInfo $file

Returns

mixed —

normalizeFileInfo()

normalizeFileInfo(\SplFileInfo  $file) : array|void

Normalize the file info.

Parameters

\SplFileInfo $file

Throws

\League\Flysystem\NotSupportedException

Returns

array|void —

getFilePath()

getFilePath(\SplFileInfo  $file) : string

Get the normalized path from a SplFileInfo object.

Parameters

\SplFileInfo $file

Returns

string —

getRecursiveDirectoryIterator()

getRecursiveDirectoryIterator(string  $path, int  $mode = RecursiveIteratorIterator::SELF_FIRST) : \RecursiveIteratorIterator

Parameters

string $path
int $mode

Returns

\RecursiveIteratorIterator —

getDirectoryIterator()

getDirectoryIterator(string  $path) : \DirectoryIterator

Parameters

string $path

Returns

\DirectoryIterator —

mapFileInfo()

mapFileInfo(\SplFileInfo  $file) : array

Parameters

\SplFileInfo $file

Returns

array —

guardAgainstUnreadableFileInfo()

guardAgainstUnreadableFileInfo(\SplFileInfo  $file) : mixed

Parameters

\SplFileInfo $file

Throws

\League\Flysystem\UnreadableFileException

Returns

mixed —