Config Class Reference

Public Member Functions
	__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)
	getConfigFileRelativePath ()
	getMixinsFileRelativePath ()
	getRequireJsFileRelativePath ()
	getBaseConfig ()
	getMinResolverRelativePath ()
	getUrlResolverFileRelativePath ()
	getMapFileRelativePath ()
	getMinResolverCode ()

Data Fields
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
const	PARTIAL_CONFIG_TEMPLATE

Protected Member Functions
	getConfigFileName ()

Detailed Description

Provider of RequireJs config information

Definition at line 16 of file Config.php.

Constructor & Destructor Documentation

__construct()

__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
	)

Parameters

\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

Definition at line 131 of file Config.php.

      {
        $this->fileSource = $fileSource;
        $this->design = $design;
        $this->readFactory = $readFactory;
        $this->staticContext = $assetRepo->getStaticViewFileContext();
        $this->minifyAdapter = $minifyAdapter;
        $this->minification = $minification;
        $this->repositoryMap = $repositoryMap;
    }

Member Function Documentation

getBaseConfig()

getBaseConfig

(

)

Get base RequireJs configuration necessary for working with Magento application

Returns

string

Definition at line 227 of file Config.php.

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

getConfigFileName()

getConfigFileName ( )

protected

Returns

string

Definition at line 283 of file Config.php.

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

getConfigFileRelativePath()

getConfigFileRelativePath

(

)

Get path to config file relative to directory, where all config files with different context are located

Returns

string

Definition at line 187 of file Config.php.

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

getMapFileRelativePath()

getMapFileRelativePath

(

)

Get path to map file

Returns

string

Definition at line 275 of file Config.php.

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

getMinResolverCode()

getMinResolverCode

(

)

Returns

string

Definition at line 291 of file Config.php.

    {
        $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;
    }

getMinResolverRelativePath()

getMinResolverRelativePath

(

)

Get path to '.min' files resolver relative to config files directory

Returns

string

Definition at line 242 of file Config.php.

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

getMixinsFileRelativePath()

getMixinsFileRelativePath

(

)

Get path to config file relative to directory, where all config files with different context are located

Returns

string

Definition at line 197 of file Config.php.

    {
        $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;
    }

getRequireJsFileRelativePath()

getRequireJsFileRelativePath

(

)

Get path to config file relative to directory, where all config files with different context are located

Returns

string

Definition at line 217 of file Config.php.

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

getUrlResolverFileRelativePath()

getUrlResolverFileRelativePath

(

)

Get path to URL map resover file

Returns

string

Definition at line 255 of file Config.php.

    {
        $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;
    }

Field Documentation

BUNDLE_JS_DIR

const BUNDLE_JS_DIR = 'js/bundle'

File name of StaticJs

Definition at line 63 of file Config.php.

config

config

Definition at line 74 of file Config.php.

CONFIG_FILE_NAME

const CONFIG_FILE_NAME = 'requirejs-config.js'

File name of RequireJs config

Definition at line 28 of file Config.php.

DIR_NAME

const DIR_NAME = '_requirejs'

Name of sub-directory where generated RequireJs config is placed

Deprecated:

since 2.2.0 RequireJS Configuration file is moved into package directory

Definition at line 23 of file Config.php.

FULL_CONFIG_TEMPLATE

const FULL_CONFIG_TEMPLATE

Initial value:

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

%usages%
})(require)

Template for combined RequireJs config file

Definition at line 68 of file Config.php.

MAP_FILE_NAME

const MAP_FILE_NAME = 'requirejs-map.js'

File name of RequireJs mixins

Definition at line 53 of file Config.php.

MIN_RESOLVER_FILENAME

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

File name of minified files resolver

Definition at line 48 of file Config.php.

MIXINS_FILE_NAME

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

File name of RequireJs mixins

Definition at line 33 of file Config.php.

PARTIAL_CONFIG_TEMPLATE

const PARTIAL_CONFIG_TEMPLATE

Initial value:

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

Template for wrapped partial config

Definition at line 79 of file Config.php.

REQUIRE_JS_FILE_NAME

const REQUIRE_JS_FILE_NAME = 'requirejs/require.js'

File name of RequireJs

Definition at line 38 of file Config.php.

STATIC_FILE_NAME

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

File name of StaticJs

Definition at line 43 of file Config.php.

URL_RESOLVER_FILE_NAME

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

File name of BaseUrlInterceptorJs

Definition at line 58 of file Config.php.

---

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

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