|
ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
@method array getWithMetadata(string $path, array $metadata) @method bool forceCopy(string $path, string $newpath) @method bool forceRename(string $path, string $newpath) @method array listFiles(string $path = '', boolean $recursive = false) @method array listPaths(string $path = '', boolean $recursive = false) @method 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.
| ||||||||||||||
| write ($path, $contents, array $config=[]) | ||||||||||||||
Write a new file.
| ||||||||||||||
| writeStream ($path, $resource, array $config=[]) | ||||||||||||||
Write a new file using a stream.
InvalidArgumentException If $resource is not a file handle.
| ||||||||||||||
| put ($path, $contents, array $config=[]) | ||||||||||||||
Create a file or update if exists.
| ||||||||||||||
| putStream ($path, $resource, array $config=[]) | ||||||||||||||
Create a file or update if exists.
InvalidArgumentException Thrown if $resource is not a resource.
| ||||||||||||||
| readAndDelete ($path) | ||||||||||||||
Read and delete a file.
| ||||||||||||||
| update ($path, $contents, array $config=[]) | ||||||||||||||
Update an existing file.
| ||||||||||||||
| updateStream ($path, $resource, array $config=[]) | ||||||||||||||
Update an existing file using a stream.
InvalidArgumentException If $resource is not a file handle.
| ||||||||||||||
| read ($path) | ||||||||||||||
Read a file.
| ||||||||||||||
| readStream ($path) | ||||||||||||||
Retrieves a read-stream for a path.
| ||||||||||||||
| rename ($path, $newpath) | ||||||||||||||
Rename a file.
| ||||||||||||||
| copy ($path, $newpath) | ||||||||||||||
Copy a file.
| ||||||||||||||
| delete ($path) | ||||||||||||||
Delete a file.
| ||||||||||||||
| deleteDir ($dirname) | ||||||||||||||
Delete a directory.
| ||||||||||||||
| createDir ($dirname, array $config=[]) | ||||||||||||||
Create a directory.
| ||||||||||||||
| listContents ($directory='', $recursive=false) | ||||||||||||||
List contents of a directory.
| ||||||||||||||
| getMimetype ($path) | ||||||||||||||
Get a file's mime-type.
| ||||||||||||||
| getTimestamp ($path) | ||||||||||||||
Get a file's timestamp.
| ||||||||||||||
| getVisibility ($path) | ||||||||||||||
Get a file's visibility.
| ||||||||||||||
| getSize ($path) | ||||||||||||||
Get a file's size.
| ||||||||||||||
| setVisibility ($path, $visibility) | ||||||||||||||
Set the visibility for a file.
| ||||||||||||||
| getMetadata ($path) | ||||||||||||||
Get a file's metadata.
| ||||||||||||||
| get ($path, Handler $handler=null) | ||||||||||||||
Get a file/directory handler.
| ||||||||||||||
| assertPresent ($path) | ||||||||||||||
| Assert a file is present. More... | ||||||||||||||
| assertAbsent ($path) | ||||||||||||||
| Assert a file is absent. More... | ||||||||||||||
Public Member Functions inherited from League\Flysystem\FilesystemInterface | ||||||||||||||
| has ($path) | ||||||||||||||
| Check whether a file exists. More... | ||||||||||||||
| read ($path) | ||||||||||||||
| Read a file. More... | ||||||||||||||
| readStream ($path) | ||||||||||||||
| Retrieves a read-stream for a path. More... | ||||||||||||||
| listContents ($directory='', $recursive=false) | ||||||||||||||
| List contents of a directory. More... | ||||||||||||||
| getMetadata ($path) | ||||||||||||||
| Get a file's metadata. More... | ||||||||||||||
| getSize ($path) | ||||||||||||||
| Get a file's size. More... | ||||||||||||||
| getMimetype ($path) | ||||||||||||||
| Get a file's mime-type. More... | ||||||||||||||
| getTimestamp ($path) | ||||||||||||||
| Get a file's timestamp. More... | ||||||||||||||
| getVisibility ($path) | ||||||||||||||
| Get a file's visibility. More... | ||||||||||||||
| write ($path, $contents, array $config=[]) | ||||||||||||||
| Write a new file. More... | ||||||||||||||
| writeStream ($path, $resource, array $config=[]) | ||||||||||||||
| Write a new file using a stream. More... | ||||||||||||||
| update ($path, $contents, array $config=[]) | ||||||||||||||
| Update an existing file. More... | ||||||||||||||
| updateStream ($path, $resource, array $config=[]) | ||||||||||||||
| Update an existing file using a stream. More... | ||||||||||||||
| rename ($path, $newpath) | ||||||||||||||
| Rename a file. More... | ||||||||||||||
| copy ($path, $newpath) | ||||||||||||||
| Copy a file. More... | ||||||||||||||
| delete ($path) | ||||||||||||||
| Delete a file. More... | ||||||||||||||
| deleteDir ($dirname) | ||||||||||||||
| Delete a directory. More... | ||||||||||||||
| createDir ($dirname, array $config=[]) | ||||||||||||||
| Create a directory. More... | ||||||||||||||
| setVisibility ($path, $visibility) | ||||||||||||||
| Set the visibility for a file. More... | ||||||||||||||
| put ($path, $contents, array $config=[]) | ||||||||||||||
| Create a file or update if exists. More... | ||||||||||||||
| putStream ($path, $resource, array $config=[]) | ||||||||||||||
| Create a file or update if exists. More... | ||||||||||||||
| readAndDelete ($path) | ||||||||||||||
| Read and delete a file. More... | ||||||||||||||
| get ($path, Handler $handler=null) | ||||||||||||||
| Get a file/directory handler. More... | ||||||||||||||
| addPlugin (PluginInterface $plugin) | ||||||||||||||
| Register a plugin. More... | ||||||||||||||
Protected Attributes | |
| $adapter | |
@method array getWithMetadata(string $path, array $metadata) @method bool forceCopy(string $path, string $newpath) @method bool forceRename(string $path, string $newpath) @method array listFiles(string $path = '', boolean $recursive = false) @method array listPaths(string $path = '', boolean $recursive = false) @method array listWith(array $keys = [], $directory = '', $recursive = false)
Definition at line 18 of file Filesystem.php.
| League\Flysystem\Filesystem::__construct | ( | AdapterInterface | $adapter, |
$config = null |
|||
| ) |
Constructor.
| AdapterInterface | $adapter | |
| Config | array | $config |
Definition at line 34 of file Filesystem.php.
References League\Flysystem\Filesystem\$adapter, $config, and League\Flysystem\setConfig().
Here is the call graph for this function:| League\Flysystem\Filesystem::assertAbsent | ( | $path | ) |
Assert a file is absent.
| string | $path | path to file |
| FileExistsException |
Definition at line 399 of file Filesystem.php.
References $path.
Referenced by League\Flysystem\Filesystem\copy(), League\Flysystem\Filesystem\rename(), League\Flysystem\Filesystem\write(), and League\Flysystem\Filesystem\writeStream().
Here is the caller graph for this function:| League\Flysystem\Filesystem::assertPresent | ( | $path | ) |
Assert a file is present.
| string | $path | path to file |
| FileNotFoundException |
Definition at line 383 of file Filesystem.php.
References $path.
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().
Here is the caller graph for this function:| League\Flysystem\Filesystem::copy | ( | $path, | |
| $newpath | |||
| ) |
Copy a file.
| string | $path | Path to the existing file. |
| string | $newpath | The new path of the file. |
| FileExistsException | Thrown if $newpath exists. |
| FileNotFoundException | Thrown if $path does not exist. |
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().
Here is the call graph for this function:| League\Flysystem\Filesystem::createDir | ( | $dirname, | |
| array | $config = [] |
||
| ) |
Create a directory.
| string | $dirname | The name of the new directory. |
| array | $config | An optional configuration array. |
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().
Here is the call graph for this function:| League\Flysystem\Filesystem::delete | ( | $path | ) |
Delete a file.
| string | $path |
| FileNotFoundException |
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().
Here is the call graph for this function:| League\Flysystem\Filesystem::deleteDir | ( | $dirname | ) |
Delete a directory.
| string | $dirname |
| RootViolationException | Thrown if $dirname is empty. |
Implements League\Flysystem\FilesystemInterface.
Definition at line 243 of file Filesystem.php.
References League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().
Here is the call graph for this function:| League\Flysystem\Filesystem::get | ( | $path, | |
| Handler | $handler = null |
||
| ) |
Get a file/directory handler.
| string | $path | The path to the file. |
| Handler | $handler | An optional existing handler to populate. |
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().
Here is the call graph for this function:| League\Flysystem\Filesystem::getAdapter | ( | ) |
Get the 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().
Here is the caller graph for this function:| League\Flysystem\Filesystem::getMetadata | ( | $path | ) |
Get a file's metadata.
| string | $path | The path to the file. |
| FileNotFoundException |
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().
Here is the call graph for this function:
Here is the caller graph for this function:| League\Flysystem\Filesystem::getMimetype | ( | $path | ) |
Get a file's mime-type.
| string | $path | The path to the file. |
| FileNotFoundException |
Implements League\Flysystem\FilesystemInterface.
Definition at line 279 of file Filesystem.php.
References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Filesystem\getMimetype(), and League\Flysystem\Util\normalizePath().
Referenced by League\Flysystem\Filesystem\getMimetype().
Here is the call graph for this function:
Here is the caller graph for this function:| League\Flysystem\Filesystem::getSize | ( | $path | ) |
Get a file's size.
| string | $path | The path to the file. |
Implements League\Flysystem\FilesystemInterface.
Definition at line 324 of file Filesystem.php.
References $path, League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Filesystem\getSize(), and League\Flysystem\Util\normalizePath().
Referenced by League\Flysystem\Filesystem\getSize().
Here is the call graph for this function:
Here is the caller graph for this function:| League\Flysystem\Filesystem::getTimestamp | ( | $path | ) |
Get a file's timestamp.
| string | $path | The path to the file. |
| FileNotFoundException |
Implements League\Flysystem\FilesystemInterface.
Definition at line 294 of file Filesystem.php.
References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Filesystem\getTimestamp(), and League\Flysystem\Util\normalizePath().
Referenced by League\Flysystem\Filesystem\getTimestamp().
Here is the call graph for this function:
Here is the caller graph for this function:| League\Flysystem\Filesystem::getVisibility | ( | $path | ) |
Get a file's visibility.
| string | $path | The path to the file. |
| FileNotFoundException |
Implements League\Flysystem\FilesystemInterface.
Definition at line 309 of file Filesystem.php.
References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Filesystem\getVisibility(), and League\Flysystem\Util\normalizePath().
Referenced by League\Flysystem\Filesystem\getVisibility().
Here is the call graph for this function:
Here is the caller graph for this function:| League\Flysystem\Filesystem::has | ( | $path | ) |
Check whether a file exists.
| string | $path |
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\put(), and League\Flysystem\Filesystem\putStream().
Here is the call graph for this function:
Here is the caller graph for this function:| League\Flysystem\Filesystem::listContents | ( | $directory = '', |
|
$recursive = false |
|||
| ) |
List contents of a directory.
| string | $directory | The directory to list. |
| bool | $recursive | Whether to list recursively. |
Implements League\Flysystem\FilesystemInterface.
Definition at line 268 of file Filesystem.php.
References League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().
Here is the call graph for this function:| League\Flysystem\Filesystem::put | ( | $path, | |
| $contents, | |||
| array | $config = [] |
||
| ) |
Create a file or update if exists.
| string | $path | The path to the file. |
| string | $contents | The file contents. |
| array | $config | An optional configuration array. |
Implements League\Flysystem\FilesystemInterface.
Definition at line 93 of file Filesystem.php.
References $config, $path, League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Filesystem\has(), League\Flysystem\Util\normalizePath(), and League\Flysystem\prepareConfig().
Here is the call graph for this function:| League\Flysystem\Filesystem::putStream | ( | $path, | |
| $resource, | |||
| array | $config = [] |
||
| ) |
Create a file or update if exists.
| string | $path | The path to the file. |
| resource | $resource | The file handle. |
| array | $config | An optional configuration array. |
InvalidArgumentException Thrown if $resource is not a resource.
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().
Here is the call graph for this function:| League\Flysystem\Filesystem::read | ( | $path | ) |
Read a file.
| string | $path | The path to the file. |
| FileNotFoundException |
Implements League\Flysystem\FilesystemInterface.
Definition at line 176 of file Filesystem.php.
References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), and League\Flysystem\Filesystem\read().
Referenced by League\Flysystem\Filesystem\read(), and League\Flysystem\Filesystem\readAndDelete().
Here is the call graph for this function:
Here is the caller graph for this function:| League\Flysystem\Filesystem::readAndDelete | ( | $path | ) |
Read and delete a file.
| string | $path | The path to the file. |
| FileNotFoundException |
Implements League\Flysystem\FilesystemInterface.
Definition at line 128 of file Filesystem.php.
References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Util\normalizePath(), and League\Flysystem\Filesystem\read().
Here is the call graph for this function:| League\Flysystem\Filesystem::readStream | ( | $path | ) |
Retrieves a read-stream for a path.
| string | $path | The path to the file. |
| FileNotFoundException |
Implements League\Flysystem\FilesystemInterface.
Definition at line 191 of file Filesystem.php.
References $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), and League\Flysystem\Filesystem\readStream().
Referenced by League\Flysystem\Filesystem\readStream().
Here is the call graph for this function:
Here is the caller graph for this function:| League\Flysystem\Filesystem::rename | ( | $path, | |
| $newpath | |||
| ) |
Rename a file.
| string | $path | Path to the existing file. |
| string | $newpath | The new path of the file. |
| FileExistsException | Thrown if $newpath exists. |
| FileNotFoundException | Thrown if $path does not exist. |
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().
Here is the call graph for this function:| League\Flysystem\Filesystem::setVisibility | ( | $path, | |
| $visibility | |||
| ) |
Set the visibility for a file.
| string | $path | The path to the file. |
| string | $visibility | One of 'public' or 'private'. |
Implements League\Flysystem\FilesystemInterface.
Definition at line 338 of file Filesystem.php.
References $path, League\Flysystem\Filesystem\getAdapter(), and League\Flysystem\Util\normalizePath().
Here is the call graph for this function:| League\Flysystem\Filesystem::update | ( | $path, | |
| $contents, | |||
| array | $config = [] |
||
| ) |
Update an existing file.
| string | $path | The path of the existing file. |
| string | $contents | The file contents. |
| array | $config | An optional configuration array. |
| FileNotFoundException |
Implements League\Flysystem\FilesystemInterface.
Definition at line 146 of file Filesystem.php.
References $config, $path, League\Flysystem\Filesystem\assertPresent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), and League\Flysystem\prepareConfig().
Here is the call graph for this function:| League\Flysystem\Filesystem::updateStream | ( | $path, | |
| $resource, | |||
| array | $config = [] |
||
| ) |
Update an existing file using a stream.
| string | $path | The path of the existing file. |
| resource | $resource | The file handle. |
| array | $config | An optional configuration array. |
InvalidArgumentException If $resource is not a file handle.
| FileNotFoundException |
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().
Here is the call graph for this function:| League\Flysystem\Filesystem::write | ( | $path, | |
| $contents, | |||
| array | $config = [] |
||
| ) |
Write a new file.
| string | $path | The path of the new file. |
| string | $contents | The file contents. |
| array | $config | An optional configuration array. |
| FileExistsException |
Implements League\Flysystem\FilesystemInterface.
Definition at line 63 of file Filesystem.php.
References $config, $path, League\Flysystem\Filesystem\assertAbsent(), League\Flysystem\Filesystem\getAdapter(), League\Flysystem\Util\normalizePath(), and League\Flysystem\prepareConfig().
Here is the call graph for this function:| League\Flysystem\Filesystem::writeStream | ( | $path, | |
| $resource, | |||
| array | $config = [] |
||
| ) |
Write a new file using a stream.
| string | $path | The path of the new file. |
| resource | $resource | The file handle. |
| array | $config | An optional configuration array. |
InvalidArgumentException If $resource is not a file handle.
| FileExistsException |
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().
Here is the call graph for this function:
|
protected |
Definition at line 26 of file Filesystem.php.
Referenced by League\Flysystem\Filesystem\__construct(), and League\Flysystem\Filesystem\getAdapter().