League\Flysystem\MountManager Class Reference

Class MountManager. More...

Collaboration diagram for League\Flysystem\MountManager:

Public Member Functions
	__construct (array $filesystems=[])
	Constructor. More...
	mountFilesystems (array $filesystems)
	Mount filesystems. More...
	mountFilesystem ($prefix, FilesystemInterface $filesystem)
	Mount filesystems. More...
	getFilesystem ($prefix)
	Get the filesystem with the corresponding prefix. More...
	filterPrefix (array $arguments)
	Retrieve the prefix from an arguments array. More...
	listContents ($directory='', $recursive=false)
	__call ($method, $arguments)
	Call forwarder. More...
	copy ($from, $to, array $config=[])
	listWith (array $keys=[], $directory='', $recursive=false)
	List with plugin adapter. More...
	move ($from, $to, array $config=[])
	Move a file. More...
	invokePluginOnFilesystem ($method, $arguments, $prefix)
	Invoke a plugin on a filesystem mounted on a given prefix. More...

Protected Member Functions
	getPrefixAndPath ($path)

Protected Attributes
	$filesystems = []

Detailed Description

Class MountManager.

Proxies methods to Filesystem (

See also

__call):

AdapterInterface getAdapter($prefix) Config getConfig($prefix) bool has($path) bool write($path, $contents, array $config = []) bool writeStream($path, $resource, array $config = []) bool put($path, $contents, $config = []) bool putStream($path, $contents, $config = []) string readAndDelete($path) bool update($path, $contents, $config = []) bool updateStream($path, $resource, $config = []) string|false read($path) resource|false readStream($path) bool rename($path, $newpath) bool delete($path) bool deleteDir($dirname) bool createDir($dirname, $config = []) array listFiles($directory = '', $recursive = false) array listPaths($directory = '', $recursive = false) array getWithMetadata($path, array $metadata) string|false getMimetype($path) string|false getTimestamp($path) string|false getVisibility($path) int|false getSize($path); bool setVisibility($path, $visibility) array|false getMetadata($path) Handler get($path, Handler $handler = null) Filesystem flushCache() void assertPresent($path) void assertAbsent($path) Filesystem addPlugin(PluginInterface $plugin)

Definition at line 46 of file MountManager.php.

Constructor & Destructor Documentation

__construct()

League\Flysystem\MountManager::__construct

(

array

$filesystems = []

)

Constructor.

Parameters

FilesystemInterface[]

$filesystems [:prefix => Filesystem,]

Exceptions

InvalidArgumentException

Definition at line 62 of file MountManager.php.

References League\Flysystem\MountManager\$filesystems, and League\Flysystem\MountManager\mountFilesystems().

    {
        $this->mountFilesystems($filesystems);
    }

Here is the call graph for this function:

Member Function Documentation

__call()

League\Flysystem\MountManager::__call	(		$method,
			$arguments
	)

Call forwarder.

Parameters

string	$method
array	$arguments

Exceptions

InvalidArgumentException
FilesystemNotFoundException

Returns

mixed

Definition at line 184 of file MountManager.php.

References League\Flysystem\MountManager\filterPrefix(), and League\Flysystem\MountManager\invokePluginOnFilesystem().

    {
        list($prefix, $arguments) = $this->filterPrefix($arguments);

        return $this->invokePluginOnFilesystem($method, $arguments, $prefix);
    }

Here is the call graph for this function:

copy()

League\Flysystem\MountManager::copy	(		$from,
			$to,
		array	$config = []
	)

Parameters

string	$from
string	$to
array	$config

Exceptions

InvalidArgumentException
FilesystemNotFoundException

Returns

bool

Definition at line 201 of file MountManager.php.

References $config, $from, $result, League\Flysystem\MountManager\getFilesystem(), and League\Flysystem\MountManager\getPrefixAndPath().

Referenced by League\Flysystem\MountManager\move().

    {
        list($prefixFrom, $from) = $this->getPrefixAndPath($from);

        $buffer = $this->getFilesystem($prefixFrom)->readStream($from);

        if ($buffer === false) {
            return false;
        }

        list($prefixTo, $to) = $this->getPrefixAndPath($to);

        $result = $this->getFilesystem($prefixTo)->writeStream($to, $buffer, $config);

        if (is_resource($buffer)) {
            fclose($buffer);
        }

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

filterPrefix()

League\Flysystem\MountManager::filterPrefix

(

array

$arguments

)

Retrieve the prefix from an arguments array.

Parameters

array

$arguments

Exceptions

InvalidArgumentException

Returns

array [:prefix, :arguments]

Definition at line 133 of file MountManager.php.

References $path, and League\Flysystem\MountManager\getPrefixAndPath().

Referenced by League\Flysystem\MountManager\__call().

    {
        if (empty($arguments)) {
            throw new InvalidArgumentException('At least one argument needed');
        }

        $path = array_shift($arguments);

        if ( ! is_string($path)) {
            throw new InvalidArgumentException('First argument should be a string');
        }

        list($prefix, $path) = $this->getPrefixAndPath($path);
        array_unshift($arguments, $path);

        return [$prefix, $arguments];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFilesystem()

League\Flysystem\MountManager::getFilesystem

(

$prefix

)

Get the filesystem with the corresponding prefix.

Parameters

string

$prefix

Exceptions

FilesystemNotFoundException

Returns

FilesystemInterface

Definition at line 115 of file MountManager.php.

References ILIAS\Filesystem\filesystems().

Referenced by League\Flysystem\MountManager\copy(), League\Flysystem\MountManager\invokePluginOnFilesystem(), and League\Flysystem\MountManager\listContents().

    {
        if ( ! isset($this->filesystems[$prefix])) {
            throw new FilesystemNotFoundException('No filesystem mounted with prefix ' . $prefix);
        }

        return $this->filesystems[$prefix];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPrefixAndPath()

League\Flysystem\MountManager::getPrefixAndPath (   $path )

protected

Parameters

string

$path

Exceptions

InvalidArgumentException

Returns

string[] [:prefix, :path]

Definition at line 298 of file MountManager.php.

References $path.

Referenced by League\Flysystem\MountManager\copy(), League\Flysystem\MountManager\filterPrefix(), League\Flysystem\MountManager\listContents(), and League\Flysystem\MountManager\listWith().

    {
        if (strpos($path, '://') < 1) {
            throw new InvalidArgumentException('No prefix detected in path: ' . $path);
        }

        return explode('://', $path, 2);
    }

Here is the caller graph for this function:

invokePluginOnFilesystem()

League\Flysystem\MountManager::invokePluginOnFilesystem	(		$method,
			$arguments,
			$prefix
	)

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

Parameters

string	$method
array	$arguments
string	$prefix

Exceptions

FilesystemNotFoundException

Returns

mixed

Definition at line 276 of file MountManager.php.

References League\Flysystem\MountManager\getFilesystem(), and League\Flysystem\Plugin\invokePlugin().

Referenced by League\Flysystem\MountManager\__call(), and League\Flysystem\MountManager\listWith().

    {
        $filesystem = $this->getFilesystem($prefix);

        try {
            return $this->invokePlugin($method, $arguments, $filesystem);
        } catch (PluginNotFoundException $e) {
            // Let it pass, it's ok, don't panic.
        }

        $callback = [$filesystem, $method];

        return call_user_func_array($callback, $arguments);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listContents()

League\Flysystem\MountManager::listContents	(		$directory = '',
			$recursive = false
	)

Parameters

string	$directory
bool	$recursive

Exceptions

InvalidArgumentException
FilesystemNotFoundException

Returns

array

Definition at line 160 of file MountManager.php.

References $file, $result, League\Flysystem\MountManager\getFilesystem(), and League\Flysystem\MountManager\getPrefixAndPath().

    {
        list($prefix, $directory) = $this->getPrefixAndPath($directory);
        $filesystem = $this->getFilesystem($prefix);
        $result = $filesystem->listContents($directory, $recursive);

        foreach ($result as &$file) {
            $file['filesystem'] = $prefix;
        }

        return $result;
    }

Here is the call graph for this function:

listWith()

League\Flysystem\MountManager::listWith	(	array	$keys = [],
			$directory = '',
			$recursive = false
	)

List with plugin adapter.

Parameters

array	$keys
string	$directory
bool	$recursive

Exceptions

InvalidArgumentException
FilesystemNotFoundException

Returns

array

Definition at line 234 of file MountManager.php.

References $keys, League\Flysystem\MountManager\getPrefixAndPath(), and League\Flysystem\MountManager\invokePluginOnFilesystem().

    {
        list($prefix, $directory) = $this->getPrefixAndPath($directory);
        $arguments = [$keys, $directory, $recursive];

        return $this->invokePluginOnFilesystem('listWith', $arguments, $prefix);
    }

Here is the call graph for this function:

mountFilesystem()

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

Mount filesystems.

Parameters

string	$prefix
FilesystemInterface	$filesystem

Exceptions

InvalidArgumentException

Returns

$this

Definition at line 95 of file MountManager.php.

References ILIAS\Filesystem\filesystems().

Referenced by League\Flysystem\MountManager\mountFilesystems().

    {
        if ( ! is_string($prefix)) {
            throw new InvalidArgumentException(__METHOD__ . ' expects argument #1 to be a string.');
        }

        $this->filesystems[$prefix] = $filesystem;

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mountFilesystems()

League\Flysystem\MountManager::mountFilesystems

(

array

$filesystems

)

Mount filesystems.

Parameters

FilesystemInterface[]

$filesystems [:prefix => Filesystem,]

Exceptions

InvalidArgumentException

Returns

$this

Definition at line 76 of file MountManager.php.

References League\Flysystem\MountManager\mountFilesystem().

Referenced by League\Flysystem\MountManager\__construct().

    {
        foreach ($filesystems as $prefix => $filesystem) {
            $this->mountFilesystem($prefix, $filesystem);
        }

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

move()

League\Flysystem\MountManager::move	(		$from,
			$to,
		array	$config = []
	)

Move a file.

Parameters

string	$from
string	$to
array	$config

Exceptions

InvalidArgumentException
FilesystemNotFoundException

Returns

bool

Definition at line 254 of file MountManager.php.

References $config, $from, and League\Flysystem\MountManager\copy().

    {
        $copied = $this->copy($from, $to, $config);

        if ($copied) {
            return $this->delete($from);
        }

        return false;
    }

Here is the call graph for this function:

Field Documentation

$filesystems

League\Flysystem\MountManager::$filesystems = []

protected

Definition at line 53 of file MountManager.php.

Referenced by League\Flysystem\MountManager\__construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/league/flysystem/src/MountManager.php