League\Flysystem\Filesystem Class Reference

array getWithMetadata(string $path, array $metadata) bool forceCopy(string $path, string $newpath) bool forceRename(string $path, string $newpath) array listFiles(string $path = '', boolean $recursive = false) array listPaths(string $path = '', boolean $recursive = false) array listWith(array $keys = [], $directory = '', $recursive = false) More...

Inheritance diagram for League\Flysystem\Filesystem:

Collaboration diagram for League\Flysystem\Filesystem:

Public Member Functions
	__construct (AdapterInterface $adapter, $config=null)
	Constructor. More...
	getAdapter ()
	Get the Adapter. More...
	has ($path)
	Check whether a file exists. Parameters string $path Returns bool More...
	write ($path, $contents, array $config=[])
	Write a new file. Parameters string $path The path of the new file. string $contents The file contents. array $config An optional configuration array. Exceptions FileExistsException Returns bool True on success, false on failure. More...
	writeStream ($path, $resource, array $config=[])
	Write a new file using a stream. Parameters string $path The path of the new file. resource $resource The file handle. array $config An optional configuration array. Exceptions More...
	put ($path, $contents, array $config=[])
	Create a file or update if exists. Parameters string $path The path to the file. string $contents The file contents. array $config An optional configuration array. Returns bool True on success, false on failure. More...
	putStream ($path, $resource, array $config=[])
	Create a file or update if exists. Parameters string $path The path to the file. resource $resource The file handle. array $config An optional configuration array. Exceptions More...
	readAndDelete ($path)
	Read and delete a file. Parameters string $path The path to the file. Exceptions FileNotFoundException Returns string|false The file contents, or false on failure. More...
	update ($path, $contents, array $config=[])
	Update an existing file. Parameters string $path The path of the existing file. string $contents The file contents. array $config An optional configuration array. Exceptions FileNotFoundException Returns bool True on success, false on failure. More...
	updateStream ($path, $resource, array $config=[])
	Update an existing file using a stream. Parameters string $path The path of the existing file. resource $resource The file handle. array $config An optional configuration array. Exceptions More...
	read ($path)
	Read a file. Parameters string $path The path to the file. Exceptions FileNotFoundException Returns string|false The file contents or false on failure. More...
	readStream ($path)
	Retrieves a read-stream for a path. Parameters string $path The path to the file. Exceptions FileNotFoundException Returns resource|false The path resource or false on failure. More...
	rename ($path, $newpath)
	Rename a file. Parameters string $path Path to the existing file. string $newpath The new path of the file. Exceptions FileExistsException Thrown if $newpath exists. FileNotFoundException Thrown if $path does not exist. Returns bool True on success, false on failure. More...
	copy ($path, $newpath)
	Copy a file. Parameters string $path Path to the existing file. string $newpath The new path of the file. Exceptions FileExistsException Thrown if $newpath exists. FileNotFoundException Thrown if $path does not exist. Returns bool True on success, false on failure. More...
	delete ($path)
	Delete a file. Parameters string $path Exceptions FileNotFoundException Returns bool True on success, false on failure. More...
	deleteDir ($dirname)
	Delete a directory. Parameters string $dirname Exceptions RootViolationException Thrown if $dirname is empty. Returns bool True on success, false on failure. More...
	createDir ($dirname, array $config=[])
	Create a directory. Parameters string $dirname The name of the new directory. array $config An optional configuration array. Returns bool True on success, false on failure. More...
	listContents ($directory='', $recursive=false)
	List contents of a directory. Parameters string $directory The directory to list. bool $recursive Whether to list recursively. Returns array A list of file metadata. More...
	getMimetype ($path)
	Get a file's mime-type. Parameters string $path The path to the file. Exceptions FileNotFoundException Returns string|false The file mime-type or false on failure. More...
	getTimestamp ($path)
	Get a file's timestamp. Parameters string $path The path to the file. Exceptions FileNotFoundException Returns string|false The timestamp or false on failure. More...
	getVisibility ($path)
	Get a file's visibility. Parameters string $path The path to the file. Exceptions FileNotFoundException Returns string|false The visibility (public|private) or false on failure. More...
	getSize ($path)
	Get a file's size. Parameters string $path The path to the file. Returns int|false The file size or false on failure. More...
	setVisibility ($path, $visibility)
	Set the visibility for a file. Parameters string $path The path to the file. string $visibility One of 'public' or 'private'. Returns bool True on success, false on failure. More...
	getMetadata ($path)
	Get a file's metadata. Parameters string $path The path to the file. Exceptions FileNotFoundException Returns array|false The file metadata or false on failure. More...
	get ($path, Handler $handler=null)
	Get a file/directory handler. Parameters string $path The path to the file. Handler $handler An optional existing handler to populate. Returns Handler Either a file or directory handler. More...
	assertPresent ($path)
	Assert a file is present. More...
	assertAbsent ($path)
	Assert a file is absent. More...
Public Member Functions inherited from League\Flysystem\FilesystemInterface
	addPlugin (PluginInterface $plugin)
	Register a plugin. More...

Protected Attributes
	$adapter

Detailed Description

array getWithMetadata(string $path, array $metadata) bool forceCopy(string $path, string $newpath) bool forceRename(string $path, string $newpath) array listFiles(string $path = '', boolean $recursive = false) array listPaths(string $path = '', boolean $recursive = false) array listWith(array $keys = [], $directory = '', $recursive = false)

Definition at line 18 of file Filesystem.php.

Constructor & Destructor Documentation

__construct()

League\Flysystem\Filesystem::__construct	(	AdapterInterface	$adapter,
			$config = null
	)

Constructor.

Parameters

AdapterInterface	$adapter
Config | array	$config

Definition at line 34 of file Filesystem.php.

References League\Flysystem\Filesystem\$adapter, $config, and League\Flysystem\setConfig().

    {
        $this->adapter = $adapter;
        $this->setConfig($config);
    }

Here is the call graph for this function:

Member Function Documentation

assertAbsent()

League\Flysystem\Filesystem::assertAbsent

(

$path

)

Assert a file is absent.

Parameters

string

$path

path to file

Exceptions

FileExistsException

Returns

void

Definition at line 399 of file Filesystem.php.

References $path, and League\Flysystem\Filesystem\has().

Referenced by League\Flysystem\Filesystem\copy(), League\Flysystem\Filesystem\rename(), League\Flysystem\Filesystem\write(), and League\Flysystem\Filesystem\writeStream().

    {
        if ($this->config->get('disable_asserts', false) === false && $this->has($path)) {
            throw new FileExistsException($path);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

assertPresent()

League\Flysystem\Filesystem::assertPresent

(

$path

)

Assert a file is present.

Parameters

string

$path

path to file

Exceptions

FileNotFoundException

Returns

void

Definition at line 383 of file Filesystem.php.

References $path, and League\Flysystem\Filesystem\has().

Referenced by League\Flysystem\Filesystem\copy(), League\Flysystem\Filesystem\delete(), League\Flysystem\Filesystem\getMetadata(), League\Flysystem\Filesystem\getMimetype(), League\Flysystem\Filesystem\getTimestamp(), League\Flysystem\Filesystem\getVisibility(), League\Flysystem\Filesystem\read(), League\Flysystem\Filesystem\readAndDelete(), League\Flysystem\Filesystem\readStream(), League\Flysystem\Filesystem\rename(), League\Flysystem\Filesystem\update(), and League\Flysystem\Filesystem\updateStream().

    {
        if ($this->config->get('disable_asserts', false) === false && ! $this->has($path)) {
            throw new FileNotFoundException($path);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copy()

League\Flysystem\Filesystem::copy	(		$path,
			$newpath
	)

Copy a file.

Parameters

string	$path	Path to the existing file.
string	$newpath	The new path of the file.

Exceptions

FileExistsException	Thrown if $newpath exists.
FileNotFoundException	Thrown if $path does not exist.

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 219 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertAbsent(), League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);
        $newpath = Util::normalizePath($newpath);
        $this->assertPresent($path);
        $this->assertAbsent($newpath);

        return $this->getAdapter()->copy($path, $newpath);
    }

Here is the call graph for this function:

createDir()

League\Flysystem\Filesystem::createDir	(		$dirname,
		array	$config = []
	)

Create a directory.

Parameters

string	$dirname	The name of the new directory.
array	$config	An optional configuration array.

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 257 of file Filesystem.php.

References $config, League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), and League\Flysystem\prepareConfig().

    {
        $dirname = Util::normalizePath($dirname);
        $config = $this->prepareConfig($config);

        return (bool) $this->getAdapter()->createDir($dirname, $config);
    }

Here is the call graph for this function:

delete()

League\Flysystem\Filesystem::delete

(

$path

)

Delete a file.

Parameters

string

$path

Exceptions

FileNotFoundException

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 232 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);
        $this->assertPresent($path);

        return $this->getAdapter()->delete($path);
    }

Here is the call graph for this function:

deleteDir()

League\Flysystem\Filesystem::deleteDir

(

$dirname

)

Delete a directory.

Parameters

string

$dirname

Exceptions

RootViolationException

Thrown if $dirname is empty.

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 243 of file Filesystem.php.

References League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $dirname = Util::normalizePath($dirname);

        if ($dirname === '') {
            throw new RootViolationException('Root directories can not be deleted.');
        }

        return (bool) $this->getAdapter()->deleteDir($dirname);
    }

Here is the call graph for this function:

get()

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

Get a file/directory handler.

Parameters

string	$path	The path to the file.
Handler	$handler	An optional existing handler to populate.

Returns

Handler Either a file or directory handler.

Implements League\Flysystem\FilesystemInterface.

Definition at line 359 of file Filesystem.php.

References $handler, $metadata, $path, League\Flysystem\Filesystem\getMetadata(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);

        if ( ! $handler) {
            $metadata = $this->getMetadata($path);
            $handler = $metadata['type'] === 'file' ? new File($this, $path) : new Directory($this, $path);
        }

        $handler->setPath($path);
        $handler->setFilesystem($this);

        return $handler;
    }

Here is the call graph for this function:

getAdapter()

League\Flysystem\Filesystem::getAdapter

(

)

Get the Adapter.

Returns

AdapterInterface adapter

Definition at line 45 of file Filesystem.php.

References League\Flysystem\Filesystem\$adapter.

Referenced by League\Flysystem\Filesystem\copy(), League\Flysystem\Filesystem\createDir(), League\Flysystem\Filesystem\delete(), League\Flysystem\Filesystem\deleteDir(), League\Flysystem\Filesystem\getMetadata(), League\Flysystem\Filesystem\getMimetype(), League\Flysystem\Filesystem\getSize(), League\Flysystem\Filesystem\getTimestamp(), League\Flysystem\Filesystem\getVisibility(), League\Flysystem\Filesystem\has(), League\Flysystem\Filesystem\listContents(), League\Flysystem\Filesystem\put(), League\Flysystem\Filesystem\putStream(), League\Flysystem\Filesystem\read(), League\Flysystem\Filesystem\readStream(), League\Flysystem\Filesystem\rename(), League\Flysystem\Filesystem\setVisibility(), League\Flysystem\Filesystem\update(), League\Flysystem\Filesystem\updateStream(), League\Flysystem\Filesystem\write(), and League\Flysystem\Filesystem\writeStream().

    {
        return $this->adapter;
    }

Here is the caller graph for this function:

getMetadata()

League\Flysystem\Filesystem::getMetadata

(

$path

)

Get a file's metadata.

Parameters

string

$path

The path to the file.

Exceptions

FileNotFoundException

Returns

array|false The file metadata or false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 348 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

Referenced by League\Flysystem\Filesystem\get().

    {
        $path = Util::normalizePath($path);
        $this->assertPresent($path);

        return $this->getAdapter()->getMetadata($path);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMimetype()

League\Flysystem\Filesystem::getMimetype

(

$path

)

Get a file's mime-type.

Parameters

string

$path

The path to the file.

Exceptions

FileNotFoundException

Returns

string|false The file mime-type or false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 279 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);
        $this->assertPresent($path);

        if ( ! $object = $this->getAdapter()->getMimetype($path)) {
            return false;
        }

        return $object['mimetype'];
    }

Here is the call graph for this function:

getSize()

League\Flysystem\Filesystem::getSize

(

$path

)

Get a file's size.

Parameters

string

$path

The path to the file.

Returns

int|false The file size or false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 324 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);

        if (($object = $this->getAdapter()->getSize($path)) === false || ! isset($object['size'])) {
            return false;
        }

        return (int) $object['size'];
    }

Here is the call graph for this function:

getTimestamp()

League\Flysystem\Filesystem::getTimestamp

(

$path

)

Get a file's timestamp.

Parameters

string

$path

The path to the file.

Exceptions

FileNotFoundException

Returns

string|false The timestamp or false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 294 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);
        $this->assertPresent($path);

        if ( ! $object = $this->getAdapter()->getTimestamp($path)) {
            return false;
        }

        return $object['timestamp'];
    }

Here is the call graph for this function:

getVisibility()

League\Flysystem\Filesystem::getVisibility

(

$path

)

Get a file's visibility.

Parameters

string

$path

The path to the file.

Exceptions

FileNotFoundException

Returns

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

Implements League\Flysystem\FilesystemInterface.

Definition at line 309 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);
        $this->assertPresent($path);

        if (($object = $this->getAdapter()->getVisibility($path)) === false) {
            return false;
        }

        return $object['visibility'];
    }

Here is the call graph for this function:

has()

League\Flysystem\Filesystem::has

(

$path

)

Check whether a file exists.

Parameters

string

$path

Returns

bool

Implements League\Flysystem\FilesystemInterface.

Definition at line 53 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

Referenced by League\Flysystem\Filesystem\assertAbsent(), League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\put(), and League\Flysystem\Filesystem\putStream().

    {
        $path = Util::normalizePath($path);

        return strlen($path) === 0 ? false : (bool) $this->getAdapter()->has($path);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listContents()

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

List contents of a directory.

Parameters

string	$directory	The directory to list.
bool	$recursive	Whether to list recursively.

Returns

array A list of file metadata.

Implements League\Flysystem\FilesystemInterface.

Definition at line 268 of file Filesystem.php.

References $contents, League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $directory = Util::normalizePath($directory);
        $contents = $this->getAdapter()->listContents($directory, $recursive);

        return (new ContentListingFormatter($directory, $recursive))->formatListing($contents);
    }

Here is the call graph for this function:

put()

League\Flysystem\Filesystem::put	(		$path,
			$contents,
		array	$config = []
	)

Create a file or update if exists.

Parameters

string	$path	The path to the file.
string	$contents	The file contents.
array	$config	An optional configuration array.

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 93 of file Filesystem.php.

References $config, $contents, $path, League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Filesystem\has(), League\Flysystem\Util\normalizePath(), and League\Flysystem\prepareConfig().

    {
        $path = Util::normalizePath($path);
        $config = $this->prepareConfig($config);

        if ( ! $this->adapter instanceof CanOverwriteFiles && $this->has($path)) {
            return (bool) $this->getAdapter()->update($path, $contents, $config);
        }

        return (bool) $this->getAdapter()->write($path, $contents, $config);
    }

Here is the call graph for this function:

putStream()

League\Flysystem\Filesystem::putStream	(		$path,
			$resource,
		array	$config = []
	)

Create a file or update if exists.

Parameters

string	$path	The path to the file.
resource	$resource	The file handle.
array	$config	An optional configuration array.

Exceptions

Implements League\Flysystem\FilesystemInterface.

Definition at line 108 of file Filesystem.php.

References $config, $path, League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Filesystem\has(), League\Flysystem\Util\normalizePath(), League\Flysystem\prepareConfig(), and League\Flysystem\Util\rewindStream().

    {
        if ( ! is_resource($resource)) {
            throw new InvalidArgumentException(__METHOD__ . ' expects argument #2 to be a valid resource.');
        }

        $path = Util::normalizePath($path);
        $config = $this->prepareConfig($config);
        Util::rewindStream($resource);

        if ( ! $this->adapter instanceof CanOverwriteFiles &&$this->has($path)) {
            return (bool) $this->getAdapter()->updateStream($path, $resource, $config);
        }

        return (bool) $this->getAdapter()->writeStream($path, $resource, $config);
    }

Here is the call graph for this function:

read()

League\Flysystem\Filesystem::read

(

$path

)

Read a file.

Parameters

string

$path

The path to the file.

Exceptions

FileNotFoundException

Returns

string|false The file contents or false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 176 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

Referenced by League\Flysystem\Filesystem\readAndDelete().

    {
        $path = Util::normalizePath($path);
        $this->assertPresent($path);

        if ( ! ($object = $this->getAdapter()->read($path))) {
            return false;
        }

        return $object['contents'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readAndDelete()

League\Flysystem\Filesystem::readAndDelete

(

$path

)

Read and delete a file.

Parameters

string

$path

The path to the file.

Exceptions

FileNotFoundException

Returns

string|false The file contents, or false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 128 of file Filesystem.php.

References $contents, $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Util\normalizePath(), and League\Flysystem\Filesystem\read().

    {
        $path = Util::normalizePath($path);
        $this->assertPresent($path);
        $contents = $this->read($path);

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

        $this->delete($path);

        return $contents;
    }

Here is the call graph for this function:

readStream()

League\Flysystem\Filesystem::readStream

(

$path

)

Retrieves a read-stream for a path.

Parameters

string

$path

The path to the file.

Exceptions

FileNotFoundException

Returns

resource|false The path resource or false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 191 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);
        $this->assertPresent($path);

        if ( ! $object = $this->getAdapter()->readStream($path)) {
            return false;
        }

        return $object['stream'];
    }

Here is the call graph for this function:

rename()

League\Flysystem\Filesystem::rename	(		$path,
			$newpath
	)

Rename a file.

Parameters

string	$path	Path to the existing file.
string	$newpath	The new path of the file.

Exceptions

FileExistsException	Thrown if $newpath exists.
FileNotFoundException	Thrown if $path does not exist.

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 206 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\assertAbsent(), League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);
        $newpath = Util::normalizePath($newpath);
        $this->assertPresent($path);
        $this->assertAbsent($newpath);

        return (bool) $this->getAdapter()->rename($path, $newpath);
    }

Here is the call graph for this function:

setVisibility()

League\Flysystem\Filesystem::setVisibility	(		$path,
			$visibility
	)

Set the visibility for a file.

Parameters

string	$path	The path to the file.
string	$visibility	One of 'public' or 'private'.

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 338 of file Filesystem.php.

References $path, League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().

    {
        $path = Util::normalizePath($path);

        return (bool) $this->getAdapter()->setVisibility($path, $visibility);
    }

Here is the call graph for this function:

update()

League\Flysystem\Filesystem::update	(		$path,
			$contents,
		array	$config = []
	)

Update an existing file.

Parameters

string	$path	The path of the existing file.
string	$contents	The file contents.
array	$config	An optional configuration array.

Exceptions

FileNotFoundException

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 146 of file Filesystem.php.

References $config, $contents, $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), and League\Flysystem\prepareConfig().

    {
        $path = Util::normalizePath($path);
        $config = $this->prepareConfig($config);

        $this->assertPresent($path);

        return (bool) $this->getAdapter()->update($path, $contents, $config);
    }

Here is the call graph for this function:

updateStream()

League\Flysystem\Filesystem::updateStream	(		$path,
			$resource,
		array	$config = []
	)

Update an existing file using a stream.

Parameters

string	$path	The path of the existing file.
resource	$resource	The file handle.
array	$config	An optional configuration array.

Exceptions

Implements League\Flysystem\FilesystemInterface.

Definition at line 159 of file Filesystem.php.

References $config, $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), League\Flysystem\prepareConfig(), and League\Flysystem\Util\rewindStream().

    {
        if ( ! is_resource($resource)) {
            throw new InvalidArgumentException(__METHOD__ . ' expects argument #2 to be a valid resource.');
        }

        $path = Util::normalizePath($path);
        $config = $this->prepareConfig($config);
        $this->assertPresent($path);
        Util::rewindStream($resource);

        return (bool) $this->getAdapter()->updateStream($path, $resource, $config);
    }

Here is the call graph for this function:

write()

League\Flysystem\Filesystem::write	(		$path,
			$contents,
		array	$config = []
	)

Write a new file.

Parameters

string	$path	The path of the new file.
string	$contents	The file contents.
array	$config	An optional configuration array.

Exceptions

FileExistsException

Returns

bool True on success, false on failure.

Implements League\Flysystem\FilesystemInterface.

Definition at line 63 of file Filesystem.php.

References $config, $contents, $path, League\Flysystem\Filesystem\assertAbsent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), and League\Flysystem\prepareConfig().

    {
        $path = Util::normalizePath($path);
        $this->assertAbsent($path);
        $config = $this->prepareConfig($config);

        return (bool) $this->getAdapter()->write($path, $contents, $config);
    }

Here is the call graph for this function:

writeStream()

League\Flysystem\Filesystem::writeStream	(		$path,
			$resource,
		array	$config = []
	)

Write a new file using a stream.

Parameters

string	$path	The path of the new file.
resource	$resource	The file handle.
array	$config	An optional configuration array.

Exceptions

Implements League\Flysystem\FilesystemInterface.

Definition at line 75 of file Filesystem.php.

References $config, $path, League\Flysystem\Filesystem\assertAbsent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), League\Flysystem\prepareConfig(), and League\Flysystem\Util\rewindStream().

    {
        if ( ! is_resource($resource)) {
            throw new InvalidArgumentException(__METHOD__ . ' expects argument #2 to be a valid resource.');
        }

        $path = Util::normalizePath($path);
        $this->assertAbsent($path);
        $config = $this->prepareConfig($config);

        Util::rewindStream($resource);

        return (bool) $this->getAdapter()->writeStream($path, $resource, $config);
    }

Here is the call graph for this function:

Field Documentation

$adapter

League\Flysystem\Filesystem::$adapter

protected

Definition at line 26 of file Filesystem.php.

Referenced by League\Flysystem\Filesystem\__construct(), and League\Flysystem\Filesystem\getAdapter().

---

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

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