ILIAS\Filesystem\FilesystemFacade Class Reference

Class FilesystemFacade. More...

Inheritance diagram for ILIAS\Filesystem\FilesystemFacade:

Collaboration diagram for ILIAS\Filesystem\FilesystemFacade:

Public Member Functions
	__construct (FileStreamAccess $fileStreamAccess, FileAccess $fileAccess, DirectoryAccess $directoryAccess)
	FilesystemFacade constructor. More...
	hasDir (string $path)
	listContents (string $path='', bool $recursive=false)
	createDir (string $path, string $visibility=Visibility::PUBLIC_ACCESS)
	copyDir (string $source, string $destination)
	deleteDir (string $path)
	read (string $path)
	has (string $path)
	getMimeType (string $path)
	getTimestamp (string $path)
	getSize (string $path, int $fileSizeUnit)
	setVisibility (string $path, string $visibility)
	getVisibility (string $path)
	readStream (string $path)
	writeStream (string $path, FileStream $stream)
	putStream (string $path, FileStream $stream)
	updateStream (string $path, FileStream $stream)
	write (string $path, string $content)
	update (string $path, string $newContent)
	put (string $path, string $content)
	delete (string $path)
	readAndDelete (string $path)
	rename (string $path, string $newPath)
	copy (string $path, string $copyPath)

Private Attributes
	$fileStreamAccess
	$fileAccess
	$directoryAccess

Detailed Description

Class FilesystemFacade.

The filesystem facade is used internally to satisfy the Filesystem interface because the implementations are split into different classes to reduce the size and responsibility of each class.

This class simply delegates the work to the classes which are responsible for the task.

Author

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

Since

5.3

Version

1.0.0

Definition at line 26 of file FilesystemFacade.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\FilesystemFacade::__construct	(	FileStreamAccess	$fileStreamAccess,
		FileAccess	$fileAccess,
		DirectoryAccess	$directoryAccess
	)

FilesystemFacade constructor.

Creates a new instance of the facade with the provided access classes.

Parameters

FileStreamAccess	$fileStreamAccess
FileAccess	$fileAccess
DirectoryAccess	$directoryAccess

Definition at line 52 of file FilesystemFacade.php.

References ILIAS\Filesystem\FilesystemFacade\$directoryAccess, ILIAS\Filesystem\FilesystemFacade\$fileAccess, and ILIAS\Filesystem\FilesystemFacade\$fileStreamAccess.

    {
        $this->fileStreamAccess = $fileStreamAccess;
        $this->fileAccess = $fileAccess;
        $this->directoryAccess = $directoryAccess;
    }

Member Function Documentation

copy()

ILIAS\Filesystem\FilesystemFacade::copy	(	string	$path,
		string	$copyPath
	)

Implements ILIAS\Filesystem\Provider\FileWriteAccess.

Definition at line 261 of file FilesystemFacade.php.

    {
        $this->fileAccess->copy($path, $copyPath);
    }

copyDir()

ILIAS\Filesystem\FilesystemFacade::copyDir	(	string	$source,
		string	$destination
	)

Implements ILIAS\Filesystem\Provider\DirectoryWriteAccess.

Definition at line 90 of file FilesystemFacade.php.

    {
        $this->directoryAccess->copyDir($source, $destination);
    }

createDir()

ILIAS\Filesystem\FilesystemFacade::createDir	(	string	$path,
		string	$visibility = Visibility::PUBLIC_ACCESS
	)

Implements ILIAS\Filesystem\Provider\DirectoryWriteAccess.

Definition at line 81 of file FilesystemFacade.php.

    {
        $this->directoryAccess->createDir($path, $visibility);
    }

delete()

ILIAS\Filesystem\FilesystemFacade::delete

(

string

$path

)

Implements ILIAS\Filesystem\Provider\FileWriteAccess.

Definition at line 234 of file FilesystemFacade.php.

References $path.

    {
        $this->fileAccess->delete($path);
    }

deleteDir()

ILIAS\Filesystem\FilesystemFacade::deleteDir

(

string

$path

)

Implements ILIAS\Filesystem\Provider\DirectoryWriteAccess.

Definition at line 99 of file FilesystemFacade.php.

    {
        $this->directoryAccess->deleteDir($path);
    }

getMimeType()

ILIAS\Filesystem\FilesystemFacade::getMimeType

(

string

$path

)

Implements ILIAS\Filesystem\Provider\FileReadAccess.

Definition at line 126 of file FilesystemFacade.php.

                                              : string
    {
        return $this->fileAccess->getMimeType($path);
    }

getSize()

ILIAS\Filesystem\FilesystemFacade::getSize	(	string	$path,
		int	$fileSizeUnit
	)

Implements ILIAS\Filesystem\Provider\FileReadAccess.

Definition at line 144 of file FilesystemFacade.php.

References ILIAS\Data\DataSize\getSize().

                                                             : DataSize
    {
        return $this->fileAccess->getSize($path, $fileSizeUnit);
    }

Here is the call graph for this function:

getTimestamp()

ILIAS\Filesystem\FilesystemFacade::getTimestamp

(

string

$path

)

Implements ILIAS\Filesystem\Provider\FileReadAccess.

Definition at line 135 of file FilesystemFacade.php.

                                               : \DateTimeImmutable
    {
        return $this->fileAccess->getTimestamp($path);
    }

getVisibility()

ILIAS\Filesystem\FilesystemFacade::getVisibility

(

string

$path

)

Implements ILIAS\Filesystem\Provider\FileReadAccess.

Definition at line 162 of file FilesystemFacade.php.

                                                : string
    {
        return $this->fileAccess->getVisibility($path);
    }

has()

ILIAS\Filesystem\FilesystemFacade::has

(

string

$path

)

Implements ILIAS\Filesystem\Provider\FileReadAccess.

Definition at line 117 of file FilesystemFacade.php.

                                      : bool
    {
        return $this->fileAccess->has($path);
    }

hasDir()

ILIAS\Filesystem\FilesystemFacade::hasDir

(

string

$path

)

Implements ILIAS\Filesystem\Provider\DirectoryReadAccess.

Definition at line 63 of file FilesystemFacade.php.

                                         : bool
    {
        return $this->directoryAccess->hasDir($path);
    }

listContents()

ILIAS\Filesystem\FilesystemFacade::listContents	(	string	$path = '',
		bool	$recursive = false
	)

Implements ILIAS\Filesystem\Provider\DirectoryReadAccess.

Definition at line 72 of file FilesystemFacade.php.

References $path.

                                                                             : array
    {
        return $this->directoryAccess->listContents($path, $recursive);
    }

put()

ILIAS\Filesystem\FilesystemFacade::put	(	string	$path,
		string	$content
	)

Implements ILIAS\Filesystem\Provider\FileWriteAccess.

Definition at line 225 of file FilesystemFacade.php.

    {
        $this->fileAccess->put($path, $content);
    }

putStream()

ILIAS\Filesystem\FilesystemFacade::putStream	(	string	$path,
		FileStream	$stream
	)

Implements ILIAS\Filesystem\Provider\FileStreamWriteAccess.

Definition at line 189 of file FilesystemFacade.php.

    {
        $this->fileStreamAccess->putStream($path, $stream);
    }

read()

ILIAS\Filesystem\FilesystemFacade::read

(

string

$path

)

Implements ILIAS\Filesystem\Provider\FileReadAccess.

Definition at line 108 of file FilesystemFacade.php.

                                       : string
    {
        return $this->fileAccess->read($path);
    }

readAndDelete()

ILIAS\Filesystem\FilesystemFacade::readAndDelete

(

string

$path

)

Implements ILIAS\Filesystem\Provider\FileWriteAccess.

Definition at line 243 of file FilesystemFacade.php.

                                                : string
    {
        return $this->fileAccess->readAndDelete($path);
    }

readStream()

ILIAS\Filesystem\FilesystemFacade::readStream

(

string

$path

)

Implements ILIAS\Filesystem\Provider\FileStreamReadAccess.

Definition at line 171 of file FilesystemFacade.php.

                                             : FileStream
    {
        return $this->fileStreamAccess->readStream($path);
    }

rename()

ILIAS\Filesystem\FilesystemFacade::rename	(	string	$path,
		string	$newPath
	)

Implements ILIAS\Filesystem\Provider\FileWriteAccess.

Definition at line 252 of file FilesystemFacade.php.

    {
        $this->fileAccess->rename($path, $newPath);
    }

setVisibility()

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

Implements ILIAS\Filesystem\Provider\FileReadAccess.

Definition at line 153 of file FilesystemFacade.php.

                                                                    : bool
    {
        return $this->fileAccess->setVisibility($path, $visibility);
    }

update()

ILIAS\Filesystem\FilesystemFacade::update	(	string	$path,
		string	$newContent
	)

Implements ILIAS\Filesystem\Provider\FileWriteAccess.

Definition at line 216 of file FilesystemFacade.php.

    {
        $this->fileAccess->update($path, $newContent);
    }

updateStream()

ILIAS\Filesystem\FilesystemFacade::updateStream	(	string	$path,
		FileStream	$stream
	)

Implements ILIAS\Filesystem\Provider\FileStreamWriteAccess.

Definition at line 198 of file FilesystemFacade.php.

    {
        $this->fileStreamAccess->updateStream($path, $stream);
    }

write()

ILIAS\Filesystem\FilesystemFacade::write	(	string	$path,
		string	$content
	)

Implements ILIAS\Filesystem\Provider\FileWriteAccess.

Definition at line 207 of file FilesystemFacade.php.

    {
        $this->fileAccess->write($path, $content);
    }

writeStream()

ILIAS\Filesystem\FilesystemFacade::writeStream	(	string	$path,
		FileStream	$stream
	)

Implements ILIAS\Filesystem\Provider\FileStreamWriteAccess.

Definition at line 180 of file FilesystemFacade.php.

    {
        $this->fileStreamAccess->writeStream($path, $stream);
    }

Field Documentation

$directoryAccess

DirectoryAccess ILIAS\Filesystem\FilesystemFacade::$directoryAccess

private

Definition at line 40 of file FilesystemFacade.php.

Referenced by ILIAS\Filesystem\FilesystemFacade\__construct().

$fileAccess

FileAccess ILIAS\Filesystem\FilesystemFacade::$fileAccess

private

Definition at line 36 of file FilesystemFacade.php.

Referenced by ILIAS\Filesystem\FilesystemFacade\__construct().

$fileStreamAccess

FileStreamAccess ILIAS\Filesystem\FilesystemFacade::$fileStreamAccess

private

Definition at line 32 of file FilesystemFacade.php.

Referenced by ILIAS\Filesystem\FilesystemFacade\__construct().

---

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

• src/Filesystem/FilesystemFacade.php