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 : integer

Type

integer

$linkHandling

$linkHandling : integer

Type

integer

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, integer  $writeFlags = LOCK_EX, integer  $linkHandling = self::DISALLOW_LINKS, array  $permissions = array()) 

Constructor.

Parameters

string $root
integer $writeFlags
integer $linkHandling
array $permissions

Throws

\LogicException

has()

has(  $path) 

Parameters

$path

write()

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

Parameters

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

writeStream()

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

Parameters

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

readStream()

readStream(  $path) 

Parameters

$path

updateStream()

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

Parameters

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

update()

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

Parameters

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

read()

read(  $path) 

Parameters

$path

rename()

rename(  $path,   $newpath) 

Parameters

$path
$newpath

copy()

copy(  $path,   $newpath) 

Parameters

$path
$newpath

delete()

delete(  $path) 

Parameters

$path

listContents()

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

Parameters

$directory
$recursive

getMetadata()

getMetadata(  $path) 

Parameters

$path

getSize()

getSize(  $path) 

Parameters

$path

getMimetype()

getMimetype(  $path) 

Parameters

$path

getTimestamp()

getTimestamp(  $path) 

Parameters

$path

getVisibility()

getVisibility(  $path) 

Parameters

$path

setVisibility()

setVisibility(  $path,   $visibility) 

Parameters

$path
$visibility

createDir()

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

Parameters

$dirname
\League\Flysystem\Config $config

deleteDir()

deleteDir(  $dirname) 

Parameters

$dirname

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) 

Parameters

\SplFileInfo $file

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, integer  $mode = \RecursiveIteratorIterator::SELF_FIRST) : \RecursiveIteratorIterator

Parameters

string $path
integer $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) 

Parameters

\SplFileInfo $file

Throws

\League\Flysystem\UnreadableFileException