FileSystem Class Reference

Public Member Functions
	__construct (\Magento\Framework\View\Design\FileResolution\Fallback\File $fallbackFile, \Magento\Framework\View\Design\FileResolution\Fallback\TemplateFile $fallbackTemplateFile, \Magento\Framework\View\Design\FileResolution\Fallback\LocaleFile $fallbackLocaleFile, \Magento\Framework\View\Design\FileResolution\Fallback\StaticFile $fallbackStaticFile, \Magento\Framework\View\Design\FileResolution\Fallback\EmailTemplateFile $fallbackEmailTemplateFile, \Magento\Framework\View\Asset\Repository $assetRepo)
	getFilename ($fileId, array $params=[])
	getLocaleFileName ($file, array $params=[])
	getTemplateFileName ($fileId, array $params=[])
	getStaticFileName ($fileId, array $params=[])
	getEmailTemplateFileName ($fileId, array $params, $module)

Static Public Member Functions
static	normalizePath ($path)
static	offsetPath ($relatedPath, $path)
static	getRelatedPath ($relativeTo, $path)

Protected Attributes
	$_fileResolution
	$_templateFileResolution
	$_localeFileResolution
	$_staticFileResolution
	$_emailTemplateFileResolution
	$_assetRepo

Detailed Description

Model that finds file paths by their fileId

@api

Since

100.0.2

Definition at line 14 of file FileSystem.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\Design\FileResolution\Fallback\File	$fallbackFile,
		\Magento\Framework\View\Design\FileResolution\Fallback\TemplateFile	$fallbackTemplateFile,
		\Magento\Framework\View\Design\FileResolution\Fallback\LocaleFile	$fallbackLocaleFile,
		\Magento\Framework\View\Design\FileResolution\Fallback\StaticFile	$fallbackStaticFile,
		\Magento\Framework\View\Design\FileResolution\Fallback\EmailTemplateFile	$fallbackEmailTemplateFile,
		\Magento\Framework\View\Asset\Repository	$assetRepo
	)

Constructor

Parameters

\Magento\Framework\View\Design\FileResolution\Fallback\File	$fallbackFile
\Magento\Framework\View\Design\FileResolution\Fallback\TemplateFile	$fallbackTemplateFile
\Magento\Framework\View\Design\FileResolution\Fallback\LocaleFile	$fallbackLocaleFile
\Magento\Framework\View\Design\FileResolution\Fallback\StaticFile	$fallbackStaticFile
\Magento\Framework\View\Design\FileResolution\Fallback\EmailTemplateFile	$fallbackEmailTemplateFile
\Magento\Framework\View\Asset\Repository	$assetRepo

Definition at line 58 of file FileSystem.php.

      {
        $this->_fileResolution = $fallbackFile;
        $this->_templateFileResolution = $fallbackTemplateFile;
        $this->_localeFileResolution = $fallbackLocaleFile;
        $this->_staticFileResolution = $fallbackStaticFile;
        $this->_emailTemplateFileResolution = $fallbackEmailTemplateFile;
        $this->_assetRepo = $assetRepo;
    }

Member Function Documentation

getEmailTemplateFileName()

getEmailTemplateFileName	(		$fileId,
		array	$params,
			$module
	)

Get an email template file

Parameters

string	$fileId
array	$params
string	$module

Returns

string|bool

Definition at line 157 of file FileSystem.php.

    {
        $this->_assetRepo->updateDesignParams($params);
        return $this->_emailTemplateFileResolution
            ->getFile($params['area'], $params['themeModel'], $params['locale'], $fileId, $module);
    }

getFilename()

getFilename	(		$fileId,
		array	$params = []
	)

Get existing file name with fallback to default

Parameters

string	$fileId
array	$params

Returns

string

Definition at line 81 of file FileSystem.php.

    {
        list($module, $filePath) = \Magento\Framework\View\Asset\Repository::extractModule(
            $this->normalizePath($fileId)
        );
        if ($module) {
            $params['module'] = $module;
        }
        $this->_assetRepo->updateDesignParams($params);
        $file = $this->_fileResolution
            ->getFile($params['area'], $params['themeModel'], $filePath, $params['module']);
        return $file;
    }

getLocaleFileName()

getLocaleFileName	(		$file,
		array	$params = []
	)

Get a locale file

Parameters

string	$file
array	$params

Returns

string

Definition at line 102 of file FileSystem.php.

    {
        $this->_assetRepo->updateDesignParams($params);
        return $this->_localeFileResolution
            ->getFile($params['area'], $params['themeModel'], $params['locale'], $file);
    }

getRelatedPath()

static getRelatedPath (   $relativeTo,   $path  )

static

Concatenate/normalize a path to another path as a relative, assuming it will be relative to its directory

Parameters

string	$relativeTo
string	$path

Returns

string

Definition at line 230 of file FileSystem.php.

    {
        return self::normalizePath(dirname($relativeTo) . '/' . $path);
    }

getStaticFileName()

getStaticFileName	(		$fileId,
		array	$params = []
	)

Find a static view file using fallback mechanism

Parameters

string	$fileId
array	$params

Returns

string

Definition at line 136 of file FileSystem.php.

    {
        list($module, $filePath) = \Magento\Framework\View\Asset\Repository::extractModule(
            $this->normalizePath($fileId)
        );
        if ($module) {
            $params['module'] = $module;
        }
        $this->_assetRepo->updateDesignParams($params);
        return $this->_staticFileResolution
            ->getFile($params['area'], $params['themeModel'], $params['locale'], $filePath, $params['module']);
    }

getTemplateFileName()

getTemplateFileName	(		$fileId,
		array	$params = []
	)

Get a template file

Parameters

string	$fileId
array	$params

Returns

string|bool

Definition at line 116 of file FileSystem.php.

    {
        list($module, $filePath) = \Magento\Framework\View\Asset\Repository::extractModule(
            $this->normalizePath($fileId)
        );
        if ($module) {
            $params['module'] = $module;
        }
        $this->_assetRepo->updateDesignParams($params);
        return $this->_templateFileResolution
            ->getFile($params['area'], $params['themeModel'], $filePath, $params['module']);
    }

normalizePath()

static normalizePath (   $path )

static

Remove excessive "." and ".." parts from a path

For example foo/bar/../file.ext -> foo/file.ext

Parameters

string

$path

Returns

string

Definition at line 172 of file FileSystem.php.

    {
        $parts = explode('/', $path);
        $result = [];

        foreach ($parts as $part) {
            if ('..' === $part) {
                if (!count($result) || ($result[count($result) - 1] == '..')) {
                    $result[] = $part;
                } else {
                    array_pop($result);
                }
            } elseif ('.' !== $part) {
                $result[] = $part;
            }
        }
        return implode('/', $result);
    }

offsetPath()

static offsetPath (   $relatedPath,   $path  )

static

Get a relative path between $relatedPath and $path paths as if $path was to refer to $relatedPath relatively of itself

Returns new calculated relative path. Examples: $path: /some/directory/one/file.ext $relatedPath: /some/directory/two/another/file.ext Result: ../two/another

$path: http://example.com/themes/demo/css/styles.css $relatedPath: http://example.com/images/logo.gif Result: ../../../images

Parameters

string	$relatedPath
string	$path

Returns

string

Definition at line 209 of file FileSystem.php.

    {
        $relatedPath = self::normalizePath($relatedPath);
        $path = self::normalizePath($path);
        list($relatedPath, $path) = self::ltrimSamePart($relatedPath, $path);
        $toDir = ltrim(dirname($path), '/');
        if ($toDir == '.') {
            $offset = '';
        } else {
            $offset = str_repeat('../', count(explode('/', $toDir)));
        }
        return rtrim($offset . dirname($relatedPath), '/');
    }

Field Documentation

$_assetRepo

$_assetRepo

protected

Definition at line 46 of file FileSystem.php.

$_emailTemplateFileResolution

$_emailTemplateFileResolution

protected

Definition at line 39 of file FileSystem.php.

$_fileResolution

$_fileResolution

protected

Definition at line 19 of file FileSystem.php.

$_localeFileResolution

$_localeFileResolution

protected

Definition at line 29 of file FileSystem.php.

$_staticFileResolution

$_staticFileResolution

protected

Definition at line 34 of file FileSystem.php.

$_templateFileResolution

$_templateFileResolution

protected

Definition at line 24 of file FileSystem.php.

---

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

• vendor/magento/framework/View/FileSystem.php