Config.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\RequireJs;

use Magento\Framework\Filesystem\DriverPool;
use Magento\Framework\Filesystem\File\ReadFactory;
use Magento\Framework\View\Asset\Minification;
use Magento\Framework\View\Asset\RepositoryMap;

class Config
{
    const DIR_NAME = '_requirejs';

    const CONFIG_FILE_NAME = 'requirejs-config.js';

    const MIXINS_FILE_NAME = 'mage/requirejs/mixins.js';

    const REQUIRE_JS_FILE_NAME = 'requirejs/require.js';

    const STATIC_FILE_NAME = 'mage/requirejs/static.js';

    const MIN_RESOLVER_FILENAME = 'requirejs-min-resolver.js';

    const MAP_FILE_NAME = 'requirejs-map.js';

    const URL_RESOLVER_FILE_NAME = 'mage/requirejs/baseUrlResolver.js';

    const BUNDLE_JS_DIR = 'js/bundle';

    const FULL_CONFIG_TEMPLATE = <<<config
(function(require){
%function%

%usages%
})(require);
config;

    const PARTIAL_CONFIG_TEMPLATE = <<<config
(function() {
%config%
require.config(config);
})();

config;

    private $fileSource;

    private $design;

    private $readFactory;

    private $staticContext;

    private $minifyAdapter;

    private $minification;

    private $repositoryMap;

    public function __construct(
        \Magento\Framework\RequireJs\Config\File\Collector\Aggregated $fileSource,
        \Magento\Framework\View\DesignInterface $design,
        ReadFactory $readFactory,
        \Magento\Framework\View\Asset\Repository $assetRepo,
        \Magento\Framework\Code\Minifier\AdapterInterface $minifyAdapter,
        Minification $minification,
        RepositoryMap $repositoryMap
    ) {
        $this->fileSource = $fileSource;
        $this->design = $design;
        $this->readFactory = $readFactory;
        $this->staticContext = $assetRepo->getStaticViewFileContext();
        $this->minifyAdapter = $minifyAdapter;
        $this->minification = $minification;
        $this->repositoryMap = $repositoryMap;
    }

    public function getConfig()
    {
        $distributedConfig = '';
        $customConfigFiles = $this->fileSource->getFiles($this->design->getDesignTheme(), self::CONFIG_FILE_NAME);
        foreach ($customConfigFiles as $file) {
            $fileReader = $this->readFactory->create($file->getFilename(), DriverPool::FILE);
            $config = $fileReader->readAll($file->getName());
            $distributedConfig .= str_replace(
                ['%config%', '%context%'],
                [$config, $file->getModule()],
                self::PARTIAL_CONFIG_TEMPLATE
            );
        }

        $fullConfig = str_replace(
            ['%function%', '%usages%'],
            [$distributedConfig],
            self::FULL_CONFIG_TEMPLATE
        );

        if ($this->minification->isEnabled('js')) {
            $fullConfig = $this->minifyAdapter->minify($fullConfig);
        }

        return $fullConfig;
    }

    public function getConfigFileRelativePath()
    {
        return $this->staticContext->getConfigPath() . '/' . $this->getConfigFileName();
    }

    public function getMixinsFileRelativePath()
    {
        $map = $this->getRepositoryFilesMap(Config::MIXINS_FILE_NAME, [
            'area' => $this->staticContext->getAreaCode(),
            'theme' => $this->staticContext->getThemePath(),
            'locale' => $this->staticContext->getLocale(),
        ]);
        if ($map) {
            $relativePath = implode('/', $map) . '/' . Config::MIXINS_FILE_NAME;
        } else {
            $relativePath = $this->staticContext->getPath() . '/' . self::MIXINS_FILE_NAME;
        }
        return $relativePath;
    }

    public function getRequireJsFileRelativePath()
    {
        return $this->staticContext->getConfigPath() . '/' . self::REQUIRE_JS_FILE_NAME;
    }

    public function getBaseConfig()
    {
        $config = [
            'baseUrl' => $this->staticContext->getBaseUrl() . $this->staticContext->getPath(),
        ];
        $config = json_encode($config, JSON_UNESCAPED_SLASHES);
        $result = "require.config($config);";
        return $result;
    }

    public function getMinResolverRelativePath()
    {
        return
            $this->staticContext->getConfigPath() .
            '/' .
            $this->minification->addMinifiedSign(self::MIN_RESOLVER_FILENAME);
    }

    public function getUrlResolverFileRelativePath()
    {
        $map = $this->getRepositoryFilesMap(Config::URL_RESOLVER_FILE_NAME, [
            'area' => $this->staticContext->getAreaCode(),
            'theme' => $this->staticContext->getThemePath(),
            'locale' => $this->staticContext->getLocale(),
        ]);
        if ($map) {
            $relativePath = implode('/', $map) . '/' . Config::URL_RESOLVER_FILE_NAME;
        } else {
            $relativePath = $this->staticContext->getPath() . '/' . self::URL_RESOLVER_FILE_NAME;
        }
        return $relativePath;
    }

    public function getMapFileRelativePath()
    {
        return $this->minification->addMinifiedSign($this->staticContext->getPath() . '/' . self::MAP_FILE_NAME);
    }

    protected function getConfigFileName()
    {
        return $this->minification->addMinifiedSign(self::CONFIG_FILE_NAME);
    }

    public function getMinResolverCode()
    {
        $excludes = [];
        foreach ($this->minification->getExcludes('js') as $expression) {
            $excludes[] = '!url.match(/' . str_replace('/', '\/', $expression) . '/)';
        }
        $excludesCode = empty($excludes) ? 'true' : implode('&&', $excludes);

        $result = <<<code
    var ctx = require.s.contexts._,
        origNameToUrl = ctx.nameToUrl;

    ctx.nameToUrl = function() {
        var url = origNameToUrl.apply(ctx, arguments);
        if ({$excludesCode}) {
            url = url.replace(/(\.min)?\.js$/, '.min.js');
        }
        return url;
    };

code;

        if ($this->minification->isEnabled('js')) {
            $result = $this->minifyAdapter->minify($result);
        }
        return $result;
    }

    private function getRepositoryFilesMap($fileId, array $params)
    {
        return $this->repositoryMap->getMap($fileId, $params);
    }
}