ILIAS\Filesystem\Provider\FileReadAccess Interface Reference

Inheritance diagram for ILIAS\Filesystem\Provider\FileReadAccess:

Collaboration diagram for ILIAS\Filesystem\Provider\FileReadAccess:

Public Member Functions
	read (string $path)
	Reads a file content to a string. More...
	has (string $path)
	Checks whether a file exists. More...
	getMimeType (string $path)
	Get a files mime-type. More...
	getTimestamp (string $path)
	Get the timestamp of the file. More...
	getSize (string $path, int $unit)
	Get the size of a file. More...
	setVisibility (string $path, string $visibility)
	Sets the visibility for a file. More...
	getVisibility (string $path)
	Get the file visibility. More...

Detailed Description

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 29 of file FileReadAccess.php.

Member Function Documentation

getMimeType()

ILIAS\Filesystem\Provider\FileReadAccess::getMimeType

(

string

$path

)

Get a files mime-type.

Parameters

string

$path

The file which should be used to get the mime-type.

Returns

string The mime-type of the file.

Exceptions

FileNotFoundException	If the file is not found.
IOException	If the mime-type could not be determined.

Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.

getSize()

ILIAS\Filesystem\Provider\FileReadAccess::getSize	(	string	$path,
		int	$unit
	)

Get the size of a file.

The file size units are provided by the DataSize class.

Parameters

string	$path	The path to the file.
int	$unit	The unit of the file size, which are defined in the DataSize class.

Exceptions

IOException	Thrown if the file is not accessible or the underlying filesystem adapter failed.
FileNotFoundException	Thrown if the specified file was not found.

See also

DataSize

Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.

getTimestamp()

ILIAS\Filesystem\Provider\FileReadAccess::getTimestamp

(

string

$path

)

Get the timestamp of the file.

Parameters

string

$path

The path to the file.

Returns

The timestamp of the file.

Exceptions

FileNotFoundException	If the file is not found.
IOException	If the file can not be red.

Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.

getVisibility()

ILIAS\Filesystem\Provider\FileReadAccess::getVisibility

(

string

$path

)

Get the file visibility.

The file visibility could be 'public' or 'private'.

Please note that the Visibility interface defines two constants PUBLIC_ACCESS and PRIVATE_ACCESS to ease the development process.

Parameters

string

$path

The path to the file which should be used.

Returns

string The string 'public' or 'private'.

Exceptions

FileNotFoundException

If the file could not be found.

Implemented in ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess, ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, and ILIAS\Filesystem\Decorator\ReadOnlyDecorator.

has()

ILIAS\Filesystem\Provider\FileReadAccess::has

(

string

$path

)

Checks whether a file exists.

Parameters

string

$path

The file path which should be checked.

Returns

bool True if the file exists, otherwise false.

Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.

read()

ILIAS\Filesystem\Provider\FileReadAccess::read

(

string

$path

)

Reads a file content to a string.

Parameters

string

$path

The path to the file which should be read.

Returns

string The file content.

Exceptions

FileNotFoundException	If the file doesn't exist.
IOException	If the file could not be red.

Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.

setVisibility()

ILIAS\Filesystem\Provider\FileReadAccess::setVisibility	(	string	$path,
		string	$visibility
	)

Sets the visibility for a file.

Please note that the $visibility must 'public' or 'private'.

The Visibility interface provides two constants PUBLIC_ACCESS and PRIVATE_ACCESS. We strongly encourage the consumers of this API to use the constants.

Parameters

string	$path	The path to the file.
string	$visibility	The new visibility for the given file. This value must be 'private' or 'public'.

Returns

bool True on success or false on failure.

Exceptions

Implemented in ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator, ILIAS\Filesystem\FilesystemFacade, ILIAS\Filesystem\Decorator\ReadOnlyDecorator, and ILIAS\Filesystem\Provider\FlySystem\FlySystemFileAccess.

---

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

• components/ILIAS/Filesystem/src/Provider/FileReadAccess.php