Filesystem Class Reference

Inheritance diagram for Filesystem:

Data Structures
class	FileResolverTest
class	FilesystemTest

Public Member Functions
	__construct (\Magento\Framework\Filesystem\DirectoryList $directoryList, \Magento\Framework\Filesystem\Directory\ReadFactory $readFactory, \Magento\Framework\Filesystem\Directory\WriteFactory $writeFactory)
	getDirectoryRead ($directoryCode, $driverCode=DriverPool::FILE)
	getDirectoryReadByPath ($path, $driverCode=DriverPool::FILE)
	getDirectoryWrite ($directoryCode, $driverCode=DriverPool::FILE)
	getUri ($code)

Protected Member Functions
	getDirPath ($code)

Protected Attributes
	$directoryList
	$readFactory
	$writeFactory
	$readInstances = []
	$writeInstances = []

Detailed Description

@api

Since

100.0.2

Definition at line 16 of file Filesystem.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Filesystem\DirectoryList	$directoryList,
		\Magento\Framework\Filesystem\Directory\ReadFactory	$readFactory,
		\Magento\Framework\Filesystem\Directory\WriteFactory	$writeFactory
	)

Parameters

Filesystem\DirectoryList	$directoryList
Filesystem\Directory\ReadFactory	$readFactory
Filesystem\Directory\WriteFactory	$writeFactory

Definition at line 48 of file Filesystem.php.

      {
        $this->directoryList = $directoryList;
        $this->readFactory = $readFactory;
        $this->writeFactory = $writeFactory;
    }

Member Function Documentation

getDirectoryRead()

getDirectoryRead	(		$directoryCode,
			$driverCode = DriverPool::FILE
	)

Create an instance of directory with read permissions

Parameters

string	$directoryCode
string	$driverCode

Returns

\Magento\Framework\Filesystem\Directory\ReadInterface

Definition at line 65 of file Filesystem.php.

    {
        $code = $directoryCode . '_' . $driverCode;
        if (!array_key_exists($code, $this->readInstances)) {
            $this->readInstances[$code] = $this->readFactory->create($this->getDirPath($directoryCode), $driverCode);
        }
        return $this->readInstances[$code];
    }

getDirectoryReadByPath()

getDirectoryReadByPath	(		$path,
			$driverCode = DriverPool::FILE
	)

Create an instance of directory with read permissions by path.

Parameters

string	$path
string	$driverCode

Returns

\Magento\Framework\Filesystem\Directory\ReadInterface

Definition at line 83 of file Filesystem.php.

    {
        return $this->readFactory->create($path, $driverCode);
    }

getDirectoryWrite()

getDirectoryWrite	(		$directoryCode,
			$driverCode = DriverPool::FILE
	)

Create an instance of directory with write permissions

Parameters

string	$directoryCode
string	$driverCode

Returns

\Magento\Framework\Filesystem\Directory\WriteInterface

Exceptions

Definition at line 96 of file Filesystem.php.

    {
        $code = $directoryCode . '_' . $driverCode;
        if (!array_key_exists($code, $this->writeInstances)) {
            $this->writeInstances[$code] = $this->writeFactory->create($this->getDirPath($directoryCode), $driverCode);
        }
        return $this->writeInstances[$code];
    }

getDirPath()

getDirPath (   $code )

protected

Gets configuration of a directory

Parameters

string

$code

Returns

string

Definition at line 111 of file Filesystem.php.

    {
        return $this->directoryList->getPath($code);
    }

getUri()

getUri

(

$code

)

Retrieve uri for given code

Parameters

string

$code

Returns

string

Definition at line 122 of file Filesystem.php.

    {
        return $this->directoryList->getUrlPath($code);
    }

Field Documentation

$directoryList

$directoryList

protected

Definition at line 21 of file Filesystem.php.

$readFactory

$readFactory

protected

Definition at line 26 of file Filesystem.php.

$readInstances

$readInstances = []

protected

Definition at line 36 of file Filesystem.php.

$writeFactory

$writeFactory

protected

Definition at line 31 of file Filesystem.php.

$writeInstances

$writeInstances = []

protected

Definition at line 41 of file Filesystem.php.

---

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

• vendor/magento/framework/Filesystem.php