ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
League\Flysystem\ReadInterface Interface Reference
+ Inheritance diagram for League\Flysystem\ReadInterface:
+ Collaboration diagram for League\Flysystem\ReadInterface:

Public Member Functions

 has ($path)
 Check whether a file exists. More...
 
 read ($path)
 Read a file. More...
 
 readStream ($path)
 Read a file as a stream. More...
 
 listContents ($directory='', $recursive=false)
 List contents of a directory. More...
 
 getMetadata ($path)
 Get all the meta data of a file or directory. More...
 
 getSize ($path)
 Get the size of a file. More...
 
 getMimetype ($path)
 Get the mimetype of a file. More...
 
 getTimestamp ($path)
 Get the timestamp of a file. More...
 
 getVisibility ($path)
 Get the visibility of a file. More...
 

Detailed Description

Definition at line 5 of file ReadInterface.php.

Member Function Documentation

◆ getMetadata()

League\Flysystem\ReadInterface::getMetadata (   $path)

◆ getMimetype()

League\Flysystem\ReadInterface::getMimetype (   $path)

Get the mimetype of a file.

Parameters
string$path
Returns
array|false

Implemented in League\Flysystem\Adapter\Ftp, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

◆ getSize()

League\Flysystem\ReadInterface::getSize (   $path)

Get the size of a file.

Parameters
string$path
Returns
array|false

Implemented in League\Flysystem\Adapter\AbstractFtpAdapter, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

◆ getTimestamp()

League\Flysystem\ReadInterface::getTimestamp (   $path)

Get the timestamp of a file.

Parameters
string$path
Returns
array|false

Implemented in League\Flysystem\Adapter\Ftp, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

◆ getVisibility()

League\Flysystem\ReadInterface::getVisibility (   $path)

Get the visibility of a file.

Parameters
string$path
Returns
array|false

Implemented in League\Flysystem\Adapter\AbstractFtpAdapter, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

◆ has()

League\Flysystem\ReadInterface::has (   $path)

Check whether a file exists.

Parameters
string$path
Returns
array|bool|null

Implemented in League\Flysystem\Adapter\AbstractFtpAdapter, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

◆ listContents()

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

List contents of a directory.

Parameters
string$directory
bool$recursive
Returns
array

Implemented in League\Flysystem\Adapter\AbstractFtpAdapter, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

◆ read()

League\Flysystem\ReadInterface::read (   $path)

Read a file.

Parameters
string$path
Returns
array|false

Implemented in League\Flysystem\Adapter\Ftp, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

◆ readStream()

League\Flysystem\ReadInterface::readStream (   $path)

Read a file as a stream.

Parameters
string$path
Returns
array|false

Implemented in League\Flysystem\Adapter\Ftp, and League\Flysystem\Adapter\Local.


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