StaticResource Class Reference

Inheritance diagram for StaticResource:

Public Member Functions
	__construct (State $state, Response\FileInterface $response, Request\Http $request, View\Asset\Publisher $publisher, \Magento\Framework\View\Asset\Repository $assetRepo, \Magento\Framework\Module\ModuleList $moduleList, \Magento\Framework\ObjectManagerInterface $objectManager, ConfigLoaderInterface $configLoader, DeploymentConfig $deploymentConfig=null)
	launch ()
	catchException (Bootstrap $bootstrap, \Exception $exception)
Public Member Functions inherited from AppInterface
	catchException (App\Bootstrap $bootstrap, \Exception $exception)

Protected Member Functions
	parsePath ($path)

Additional Inherited Members
Data Fields inherited from AppInterface
const	DISTRO_LOCALE_CODE = 'en_US'

Detailed Description

Entry point for retrieving static resources like JS, CSS, images by requested public path

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 19 of file StaticResource.php.

Constructor & Destructor Documentation

__construct()

__construct	(	State	$state,
		Response\FileInterface	$response,
		Request\Http	$request,
		View\Asset\Publisher	$publisher,
		\Magento\Framework\View\Asset\Repository	$assetRepo,
		\Magento\Framework\Module\ModuleList	$moduleList,
		\Magento\Framework\ObjectManagerInterface	$objectManager,
		ConfigLoaderInterface	$configLoader,
		DeploymentConfig	$deploymentConfig = null
	)

Parameters

State	$state
Response\FileInterface	$response
Request\Http	$request
View\Asset\Publisher	$publisher
\Magento\Framework\View\Asset\Repository	$assetRepo
\Magento\Framework\Module\ModuleList	$moduleList
\Magento\Framework\ObjectManagerInterface	$objectManager
ConfigLoaderInterface	$configLoader
DeploymentConfig | null	$deploymentConfig

Definition at line 87 of file StaticResource.php.

      {
        $this->state = $state;
        $this->response = $response;
        $this->request = $request;
        $this->publisher = $publisher;
        $this->assetRepo = $assetRepo;
        $this->moduleList = $moduleList;
        $this->objectManager = $objectManager;
        $this->configLoader = $configLoader;
        $this->deploymentConfig = $deploymentConfig ?: ObjectManager::getInstance()->get(DeploymentConfig::class);
    }

Member Function Documentation

catchException()

catchException	(	Bootstrap	$bootstrap,
		\Exception	$exception
	)

{}

Definition at line 143 of file StaticResource.php.

    {
        $this->getLogger()->critical($exception->getMessage());
        if ($bootstrap->isDeveloperMode()) {
            $this->response->setHttpResponseCode(404);
            $this->response->setHeader('Content-Type', 'text/plain');
            $this->response->setBody($exception->getMessage() . "\n" . $exception->getTraceAsString());
            $this->response->sendResponse();
        } else {
            require $this->getFilesystem()->getDirectoryRead(DirectoryList::PUB)->getAbsolutePath('errors/404.php');
        }
        return true;
    }

launch()

launch

(

)

Finds requested resource and provides it to the client

Returns

\Magento\Framework\App\ResponseInterface

Exceptions

Implements AppInterface.

Definition at line 115 of file StaticResource.php.

    {
        // disabling profiling when retrieving static resource
        \Magento\Framework\Profiler::reset();
        $appMode = $this->state->getMode();
        if ($appMode == \Magento\Framework\App\State::MODE_PRODUCTION
            && !$this->deploymentConfig->getConfigData(
                ConfigOptionsListConstants::CONFIG_PATH_SCD_ON_DEMAND_IN_PRODUCTION
            )
        ) {
            $this->response->setHttpResponseCode(404);
        } else {
            $path = $this->request->get('resource');
            $params = $this->parsePath($path);
            $this->state->setAreaCode($params['area']);
            $this->objectManager->configure($this->configLoader->load($params['area']));
            $file = $params['file'];
            unset($params['file']);
            $asset = $this->assetRepo->createAsset($file, $params);
            $this->response->setFilePath($asset->getSourceFile());
            $this->publisher->publish($asset);
        }
        return $this->response;
    }

parsePath()

parsePath (   $path )

protected

Parse path to identify parts needed for searching original file

Parameters

string

$path

Exceptions

Definition at line 164 of file StaticResource.php.

    {
        $path = ltrim($path, '/');
        $parts = explode('/', $path, 6);
        if (count($parts) < 5 || preg_match('/\.\.(\\\|\/)/', $path)) {
            //Checking that path contains all required parts and is not above static folder.
            throw new \InvalidArgumentException("Requested path '$path' is wrong.");
        }

        $result = [];
        $result['area'] = $parts[0];
        $result['theme'] = $parts[1] . '/' . $parts[2];
        $result['locale'] = $parts[3];
        if (count($parts) >= 6 && $this->moduleList->has($parts[4])) {
            $result['module'] = $parts[4];
        } else {
            $result['module'] = '';
            if (isset($parts[5])) {
                $parts[5] = $parts[4] . '/' . $parts[5];
            } else {
                $parts[5] = $parts[4];
            }
        }
        $result['file'] = $parts[5];
        return $result;
    }

---

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

• vendor/magento/framework/App/StaticResource.php