\League\Flysystem\PluginForcedRename

Summary

Methods
Properties
Constants
setFilesystem()
getMethod()
handle()
No public properties found
No constants found
No protected methods found
$filesystem
N/A
No private methods found
No private properties found
N/A

Properties

Methods

setFilesystem()

setFilesystem(\League\Flysystem\FilesystemInterface  $filesystem) : mixed

Set the Filesystem object.

Parameters

\League\Flysystem\FilesystemInterface $filesystem

Returns

mixed —

getMethod()

getMethod() : mixed

Returns

mixed —

handle()

handle(string  $path, string  $newpath) : bool

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.

Throws

\League\Flysystem\FileNotFoundException

Thrown if $path does not exist.

\League\Flysystem\FileExistsException

Returns

bool —

True on success, false on failure.