\League\FlysystemFilesystem

addPlugin()

addPlugin(\League\Flysystem\PluginInterface  $plugin) : $this

Register a plugin.

Parameters

Throws

\LogicException

Returns

__call()

__call(string  $method, array  $arguments) : mixed

Plugins pass-through.

Parameters

Throws

\BadMethodCallException

Returns

__construct()

__construct(\League\Flysystem\AdapterInterface  $adapter, \League\Flysystem\Config|array  $config = null) 

Constructor.

Parameters

getAdapter()

getAdapter() : \League\Flysystem\AdapterInterface

Get the Adapter.

Returns

adapter

has()

has(string  $path) : boolean

Check whether a file exists.

Parameters

Returns

write()

write(string  $path, string  $contents, array  $config = array()) : boolean

Write a new file.

Parameters

Returns

True on success, false on failure.

writeStream()

writeStream(string  $path, resource  $resource, array  $config = array()) : boolean

Write a new file using a stream.

Parameters

Returns

True on success, false on failure.

put()

put(string  $path, string  $contents, array  $config = array()) : boolean

Create a file or update if exists.

Parameters

Returns

True on success, false on failure.

putStream()

putStream(string  $path, resource  $resource, array  $config = array()) : boolean

Create a file or update if exists.

Parameters

Returns

True on success, false on failure.

readAndDelete()

readAndDelete(string  $path) : string|false

Read and delete a file.

Parameters

Returns

The file contents, or false on failure.

update()

update(string  $path, string  $contents, array  $config = array()) : boolean

Update an existing file.

Parameters

Returns

True on success, false on failure.

updateStream()

updateStream(string  $path, resource  $resource, array  $config = array()) : boolean

Update an existing file using a stream.

Parameters

Returns

True on success, false on failure.

read()

read(string  $path) : string|false

Read a file.

Parameters

Returns

The file contents or false on failure.

readStream()

readStream(string  $path) : resource|false

Retrieves a read-stream for a path.

Parameters

Returns

The path resource or false on failure.

rename()

rename(string  $path, string  $newpath) : boolean

Rename a file.

Parameters

Returns

True on success, false on failure.

copy()

copy(string  $path, string  $newpath) : boolean

Copy a file.

Parameters

Returns

True on success, false on failure.

delete()

delete(string  $path) : boolean

Delete a file.

Parameters

Returns

True on success, false on failure.

deleteDir()

deleteDir(string  $dirname) : boolean

Delete a directory.

Parameters

Returns

True on success, false on failure.

createDir()

createDir(string  $dirname, array  $config = array()) : boolean

Create a directory.

Parameters

Returns

True on success, false on failure.

listContents()

listContents(string  $directory = '', boolean  $recursive = false) : array

List contents of a directory.

Parameters

Returns

A list of file metadata.

getMimetype()

getMimetype(string  $path) : string|false

Get a file's mime-type.

Parameters

Returns

The file mime-type or false on failure.

getTimestamp()

getTimestamp(string  $path) : string|false

Get a file's timestamp.

Parameters

Returns

The timestamp or false on failure.

getVisibility()

getVisibility(string  $path) : string|false

Get a file's visibility.

Parameters

Returns

The visibility (public|private) or false on failure.

getSize()

getSize(string  $path) : integer|false

Get a file's size.

Parameters

Returns

The file size or false on failure.

setVisibility()

setVisibility(string  $path, string  $visibility) : boolean

Set the visibility for a file.

Parameters

Returns

True on success, false on failure.

getMetadata()

getMetadata(string  $path) : array|false

Get a file's metadata.

Parameters

Returns

The file metadata or false on failure.

get()

get(string  $path, \League\Flysystem\Handler  $handler = null) : \League\Flysystem\Handler

Get a file/directory handler.

Parameters

Returns

Either a file or directory handler.

assertPresent()

assertPresent(string  $path) : void

Assert a file is present.

Parameters

Throws

\League\Flysystem\FileNotFoundException

assertAbsent()

assertAbsent(string  $path) : void

Assert a file is absent.

Parameters

Throws

\League\Flysystem\FileExistsException

getWithMetadata()

getWithMetadata(string  $path, array  $metadata) : array

Parameters

Returns

forceCopy()

forceCopy(string  $path, string  $newpath) : boolean

Parameters

Returns

forceRename()

forceRename(string  $path, string  $newpath) : boolean

Parameters

Returns

listFiles()

listFiles(string  $path = '', boolean  $recursive = false) : array

Parameters

Returns

listPaths()

listPaths(string  $path = '', boolean  $recursive = false) : array

Parameters

Returns

listWith()

listWith(array  $keys = [], mixed  $directory = '', mixed  $recursive = false) : array

Parameters

Returns

findPlugin()

findPlugin(string  $method) : \League\Flysystem\PluginInterface

Find a specific plugin.

Parameters

Throws

\League\Flysystem\Plugin\PluginNotFoundException

Returns

invokePlugin()

invokePlugin(string  $method, array  $arguments, \League\Flysystem\FilesystemInterface  $filesystem) : mixed

Invoke a plugin by method name.

Parameters

Throws

\League\Flysystem\Plugin\PluginNotFoundException

Returns