Properties

$plugins

$plugins : array

Type

array

Methods

addPlugin()

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

Register a plugin.

Parameters

\League\Flysystem\PluginInterface $plugin

Throws

\LogicException

Returns

$this —

__call()

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

Call forwarder.

Parameters

string $method
array $arguments

Throws

\InvalidArgumentException
\League\Flysystem\FilesystemNotFoundException

Returns

mixed —

__construct()

__construct(\League\Flysystem\FilesystemInterface[]  $filesystems = []) : mixed

Constructor.

Parameters

\League\Flysystem\FilesystemInterface[] $filesystems

[:prefix => Filesystem,]

Throws

\InvalidArgumentException

Returns

mixed —

mountFilesystems()

mountFilesystems(\League\Flysystem\FilesystemInterface[]  $filesystems) : $this

Mount filesystems.

Parameters

\League\Flysystem\FilesystemInterface[] $filesystems

[:prefix => Filesystem,]

Throws

\InvalidArgumentException

Returns

$this —

mountFilesystem()

mountFilesystem(string  $prefix, \League\Flysystem\FilesystemInterface  $filesystem) : $this

Mount filesystems.

Parameters

string $prefix
\League\Flysystem\FilesystemInterface $filesystem

Throws

\InvalidArgumentException

Returns

$this —

getFilesystem()

getFilesystem(string  $prefix) : \League\Flysystem\FilesystemInterface

Get the filesystem with the corresponding prefix.

Parameters

string $prefix

Throws

\League\Flysystem\FilesystemNotFoundException

Returns

\League\Flysystem\FilesystemInterface —

filterPrefix()

filterPrefix(array  $arguments) : array

Retrieve the prefix from an arguments array.

Parameters

array $arguments

Throws

\InvalidArgumentException

Returns

array —

[:prefix, :arguments]

listContents()

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

Parameters

string $directory
bool $recursive

Throws

\InvalidArgumentException
\League\Flysystem\FilesystemNotFoundException

Returns

array —

copy()

copy(string  $from, string  $to, array  $config = []) : bool

Parameters

string $from
string $to
array $config

Throws

\InvalidArgumentException
\League\Flysystem\FilesystemNotFoundException
\League\Flysystem\FileExistsException

Returns

bool —

listWith()

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

List with plugin adapter.

Parameters

array $keys
string $directory
bool $recursive

Throws

\InvalidArgumentException
\League\Flysystem\FilesystemNotFoundException

Returns

array —

move()

move(string  $from, string  $to, array  $config = []) : bool

Move a file.

Parameters

string $from
string $to
array $config

Throws

\InvalidArgumentException
\League\Flysystem\FilesystemNotFoundException

Returns

bool —

invokePluginOnFilesystem()

invokePluginOnFilesystem(string  $method, array  $arguments, string  $prefix) : mixed

Invoke a plugin on a filesystem mounted on a given prefix.

Parameters

string $method
array $arguments
string $prefix

Throws

\League\Flysystem\FilesystemNotFoundException

Returns

mixed —

getAdapter()

getAdapter(mixed  $prefix) : \League\Flysystem\AdapterInterface

Parameters

mixed $prefix

Returns

\League\Flysystem\AdapterInterface —

getConfig()

getConfig(mixed  $prefix) : \League\Flysystem\Config

Parameters

mixed $prefix

Returns

\League\Flysystem\Config —

has()

has(mixed  $path) : bool

Parameters

mixed $path

Returns

bool —

write()

write(mixed  $path, mixed  $contents, array  $config = []) : bool

Parameters

mixed $path
mixed $contents
array $config = []

Returns

bool —

writeStream()

writeStream(mixed  $path, mixed  $resource, array  $config = []) : bool

Parameters

mixed $path
mixed $resource
array $config = []

Returns

bool —

put()

put(mixed  $path, mixed  $contents, mixed  $config) : bool

Parameters

mixed $path
mixed $contents
mixed $config

Returns

bool —

putStream()

putStream(mixed  $path, mixed  $contents, mixed  $config) : bool

Parameters

mixed $path
mixed $contents
mixed $config

Returns

bool —

readAndDelete()

readAndDelete(mixed  $path) : string

Parameters

mixed $path

Returns

string —

update()

update(mixed  $path, mixed  $contents, mixed  $config) : bool

Parameters

mixed $path
mixed $contents
mixed $config

Returns

bool —

updateStream()

updateStream(mixed  $path, mixed  $resource, mixed  $config) : bool

Parameters

mixed $path
mixed $resource
mixed $config

Returns

bool —

read()

read(mixed  $path) : string|false

Parameters

mixed $path

Returns

string|false —

readStream()

readStream(mixed  $path) : resource|false

Parameters

mixed $path

Returns

resource|false —

rename()

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

Parameters

mixed $path
mixed $newpath

Returns

bool —

delete()

delete(mixed  $path) : bool

Parameters

mixed $path

Returns

bool —

deleteDir()

deleteDir(mixed  $dirname) : bool

Parameters

mixed $dirname

Returns

bool —

createDir()

createDir(mixed  $dirname, mixed  $config) : bool

Parameters

mixed $dirname
mixed $config

Returns

bool —

listFiles()

listFiles(mixed  $directory, mixed  $recursive) : array

Parameters

mixed $directory
mixed $recursive

Returns

array —

listPaths()

listPaths(mixed  $directory, mixed  $recursive) : array

Parameters

mixed $directory
mixed $recursive

Returns

array —

getWithMetadata()

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

Parameters

mixed $path
array $metadata

Returns

array —

getMimetype()

getMimetype(mixed  $path) : string|false

Parameters

mixed $path

Returns

string|false —

getTimestamp()

getTimestamp(mixed  $path) : int|false

Parameters

mixed $path

Returns

int|false —

getVisibility()

getVisibility(mixed  $path) : string|false

Parameters

mixed $path

Returns

string|false —

getSize()

getSize(mixed  $path) : int|false

;

Parameters

mixed $path

Returns

int|false —

setVisibility()

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

Parameters

mixed $path
mixed $visibility

Returns

bool —

getMetadata()

getMetadata(mixed  $path) : array|false

Parameters

mixed $path

Returns

array|false —

get()

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

Parameters

mixed $path
\League\Flysystem\Handler $handler = null

Returns

\League\Flysystem\Handler —

flushCache()

flushCache() : \League\Flysystem\Filesystem

Returns

\League\Flysystem\Filesystem —

assertPresent()

assertPresent(mixed  $path) : void

Parameters

mixed $path

assertAbsent()

assertAbsent(mixed  $path) : void

Parameters

mixed $path

addPlugin()

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

Parameters

\League\Flysystem\PluginInterface $plugin

Returns

\League\Flysystem\Filesystem —

findPlugin()

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

Find a specific plugin.

Parameters

string $method

Throws

\League\Flysystem\Plugin\PluginNotFoundException

Returns

\League\Flysystem\PluginInterface —

invokePlugin()

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

Invoke a plugin by method name.

Parameters

string $method
array $arguments
\League\Flysystem\FilesystemInterface $filesystem

Throws

\League\Flysystem\Plugin\PluginNotFoundException

Returns

mixed —

getPrefixAndPath()

getPrefixAndPath(string  $path) : string[]

Parameters

string $path

Throws

\InvalidArgumentException

Returns

string[] —

[:prefix, :path]