League\Flysystem\Plugin\ForcedRename Class Reference

Inheritance diagram for League\Flysystem\Plugin\ForcedRename:

Collaboration diagram for League\Flysystem\Plugin\ForcedRename:

Public Member Functions
	getMethod ()
	Get the method name. Returns string More...
	handle ($path, $newpath)
	Renames a file, overwriting the destination if it exists. More...
Public Member Functions inherited from League\Flysystem\Plugin\AbstractPlugin
	setFilesystem (FilesystemInterface $filesystem)
	Set the Filesystem object. More...
	getMethod ()
	Get the method name. More...
	setFilesystem (FilesystemInterface $filesystem)
	Set the Filesystem object. More...

Additional Inherited Members
Protected Attributes inherited from League\Flysystem\Plugin\AbstractPlugin
	$filesystem

Detailed Description

Definition at line 7 of file ForcedRename.php.

Member Function Documentation

getMethod()

League\Flysystem\Plugin\ForcedRename::getMethod

(

)

Get the method name.

Returns

string

Implements League\Flysystem\PluginInterface.

Definition at line 12 of file ForcedRename.php.

    {
        return 'forceRename';
    }

handle()

League\Flysystem\Plugin\ForcedRename::handle	(		$path,
			$newpath
	)

Renames a file, overwriting the destination if it exists.

Parameters

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

Exceptions

FileNotFoundException

Thrown if $path does not exist.

Returns

bool True on success, false on failure.

Definition at line 27 of file ForcedRename.php.

    {
        try {
            $deleted = $this->filesystem->delete($newpath);
        } catch (FileNotFoundException $e) {
            // The destination path does not exist. That's ok.
            $deleted = true;
        }
 
        if ($deleted) {
            return $this->filesystem->rename($path, $newpath);
        }
 
        return false;
    }

References $path.

---

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

• libs/composer/vendor/league/flysystem/src/Plugin/ForcedRename.php