FileResolver Class Reference

Inheritance diagram for FileResolver:

Public Member Functions
	__construct (DirReader $moduleReader, FileIteratorFactory $iteratorFactory, DesignInterface $designInterface, DirectoryList $directoryList, Filesystem $filesystem, ResolverInterface $resolver)
	get ($filename, $scope)
	getParents ($filename, $scope)

Protected Attributes
	$moduleReader
	$iteratorFactory
	$currentTheme
	$area
	$rootDirectory
	$resolver

Detailed Description

Class FileResolver @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 22 of file FileResolver.php.

Constructor & Destructor Documentation

__construct()

__construct	(	DirReader	$moduleReader,
		FileIteratorFactory	$iteratorFactory,
		DesignInterface	$designInterface,
		DirectoryList	$directoryList,
		Filesystem	$filesystem,
		ResolverInterface	$resolver
	)

Parameters

DirReader	$moduleReader
FileIteratorFactory	$iteratorFactory
DesignInterface	$designInterface
DirectoryList	$directoryList

Deprecated:

Parameters

Filesystem	$filesystem
ResolverInterface	$resolver

Definition at line 70 of file FileResolver.php.

      {
        $this->directoryList = $directoryList;
        $this->iteratorFactory = $iteratorFactory;
        $this->moduleReader = $moduleReader;
        $this->currentTheme = $designInterface->getDesignTheme();
        $this->area = $designInterface->getArea();
        $this->rootDirectory = $filesystem->getDirectoryRead(DirectoryList::ROOT);
        $this->resolver = $resolver;
    }

Member Function Documentation

get()

get	(		$filename,
			$scope
	)

{Retrieve the list of configuration files with given name that relate to specified scope

Parameters

string	$filename
string	$scope

Returns

array

}

Implements FileResolverInterface.

Definition at line 90 of file FileResolver.php.

    {
        switch ($scope) {
            case 'global':
                $iterator = $this->moduleReader->getConfigurationFiles($filename)->toArray();
                $themeConfigFile = $this->currentTheme->getCustomization()->getCustomViewConfigPath();
                if ($themeConfigFile
                    && $this->rootDirectory->isExist($this->rootDirectory->getRelativePath($themeConfigFile))
                ) {
                    $iterator[$this->rootDirectory->getRelativePath($themeConfigFile)] =
                        $this->rootDirectory->readFile(
                            $this->rootDirectory->getRelativePath(
                                $themeConfigFile
                            )
                        );
                } else {
                    $designPath = $this->resolver->resolve(
                        RulePool::TYPE_FILE,
                        'etc/view.xml',
                        $this->area,
                        $this->currentTheme
                    );
                    if (file_exists($designPath)) {
                        try {
                            $designDom = new \DOMDocument();
                            $designDom->load($designPath);
                            $iterator[$designPath] = $designDom->saveXML();
                        } catch (\Exception $e) {
                            throw new \Magento\Framework\Exception\LocalizedException(
                                new \Magento\Framework\Phrase('Could not read config file')
                            );
                        }
                    }
                }
                break;
            default:
                $iterator = $this->iteratorFactory->create([]);
                break;
        }
        return $iterator;
    }

getParents()

getParents	(		$filename,
			$scope
	)

{Retrieve parent configs

Parameters

string	$filename
string	$scope

Returns

array

Since

100.1.0

}

Implements DesignResolverInterface.

Definition at line 135 of file FileResolver.php.

    {
        switch ($scope) {
            case 'global':
                $iterator = $this->moduleReader->getConfigurationFiles($filename)->toArray();
                $designPath = $this->resolver->resolve(
                    RulePool::TYPE_FILE,
                    'etc/view.xml',
                    $this->area,
                    $this->currentTheme
                );

                if (file_exists($designPath)) {
                    try {
                        $iterator = $this->getParentConfigs($this->currentTheme, []);
                    } catch (\Exception $e) {
                        throw new \Magento\Framework\Exception\LocalizedException(
                            new \Magento\Framework\Phrase('Could not read config file')
                        );
                    }
                }
                break;
            default:
                $iterator = $this->iteratorFactory->create([]);
                break;
        }

        return $iterator;
    }

Field Documentation

$area

$area

protected

Definition at line 44 of file FileResolver.php.

$currentTheme

$currentTheme

protected

Definition at line 39 of file FileResolver.php.

$iteratorFactory

$iteratorFactory

protected

Definition at line 34 of file FileResolver.php.

$moduleReader

$moduleReader

protected

Definition at line 29 of file FileResolver.php.

$resolver

$resolver

protected

Definition at line 54 of file FileResolver.php.

$rootDirectory

$rootDirectory

protected

Definition at line 49 of file FileResolver.php.

---

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

• vendor/magento/framework/Config/FileResolver.php