Minification Class Reference

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, State $appState, $scope='store')
	isEnabled ($contentType)
	addMinifiedSign ($filename)
	removeMinifiedSign ($filename)
	isMinifiedFilename ($filename)
	isExcluded ($filename)
	getExcludes ($contentType)

Data Fields
const	XML_PATH_MINIFICATION_ENABLED = 'dev/%s/minify_files'
const	XML_PATH_MINIFICATION_EXCLUDES = 'dev/%s/minify_exclude'

Detailed Description

Helper class for static files minification related processes. @api

Since

100.0.2

Definition at line 16 of file Minification.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
		State	$appState,
			$scope = 'store'
	)

Parameters

ScopeConfigInterface	$scopeConfig
State	$appState
string	$scope

Definition at line 50 of file Minification.php.

    {
        $this->scopeConfig = $scopeConfig;
        $this->appState = $appState;
        $this->scope = $scope;
    }

Member Function Documentation

addMinifiedSign()

addMinifiedSign

(

$filename

)

Add 'min' suffix if minification is enabled and $filename has no one.

Parameters

string

$filename

Returns

string

Definition at line 83 of file Minification.php.

    {
        $extension = pathinfo($filename, PATHINFO_EXTENSION);

        if ($this->isEnabled($extension) &&
            !$this->isExcluded($filename) &&
            !$this->isMinifiedFilename($filename)
        ) {
            $filename = substr($filename, 0, -strlen($extension)) . 'min.' . $extension;
        }
        return $filename;
    }

getExcludes()

getExcludes

(

$contentType

)

Parameters

string

$contentType

Returns

string[]

Definition at line 142 of file Minification.php.

    {
        if (!isset($this->configCache[self::XML_PATH_MINIFICATION_EXCLUDES][$contentType])) {
            $this->configCache[self::XML_PATH_MINIFICATION_EXCLUDES][$contentType] = [];
            $key = sprintf(self::XML_PATH_MINIFICATION_EXCLUDES, $contentType);
            $excludeValues = $this->getMinificationExcludeValues($key);
            foreach ($excludeValues as $exclude) {
                if (trim($exclude) != '') {
                    $this->configCache[self::XML_PATH_MINIFICATION_EXCLUDES][$contentType][] = trim($exclude);
                }
            }
        }
        return $this->configCache[self::XML_PATH_MINIFICATION_EXCLUDES][$contentType];
    }

isEnabled()

isEnabled

(

$contentType

)

Check whether asset minification is on for specified content type

Parameters

string

$contentType

Returns

bool

Definition at line 63 of file Minification.php.

    {
        if (!isset($this->configCache[self::XML_PATH_MINIFICATION_ENABLED][$contentType])) {
            $this->configCache[self::XML_PATH_MINIFICATION_ENABLED][$contentType] =
                $this->appState->getMode() != State::MODE_DEVELOPER &&
                (bool)$this->scopeConfig->isSetFlag(
                    sprintf(self::XML_PATH_MINIFICATION_ENABLED, $contentType),
                    $this->scope
                );
        }

        return $this->configCache[self::XML_PATH_MINIFICATION_ENABLED][$contentType];
    }

isExcluded()

isExcluded

(

$filename

)

Parameters

string

$filename

Returns

boolean

Definition at line 128 of file Minification.php.

    {
        foreach ($this->getExcludes(pathinfo($filename, PATHINFO_EXTENSION)) as $exclude) {
            if (preg_match('/' . str_replace('/', '\/', $exclude) . '/', $filename)) {
                return true;
            }
        }
        return false;
    }

isMinifiedFilename()

isMinifiedFilename

(

$filename

)

Parameters

string

$filename

Returns

bool

Definition at line 119 of file Minification.php.

    {
        return substr($filename, strrpos($filename, '.') - 4, 5) == '.min.';
    }

removeMinifiedSign()

removeMinifiedSign

(

$filename

)

Remove 'min' suffix if exists and minification is enabled

Parameters

string

$filename

Returns

string

Definition at line 102 of file Minification.php.

    {
        $extension = pathinfo($filename, PATHINFO_EXTENSION);

        if ($this->isEnabled($extension) &&
            !$this->isExcluded($filename) &&
            $this->isMinifiedFilename($filename)
        ) {
            $filename = substr($filename, 0, -strlen($extension) - 4) . $extension;
        }
        return $filename;
    }

Field Documentation

XML_PATH_MINIFICATION_ENABLED

const XML_PATH_MINIFICATION_ENABLED = 'dev/%s/minify_files'

XML path for asset minification configuration

Definition at line 21 of file Minification.php.

XML_PATH_MINIFICATION_EXCLUDES

const XML_PATH_MINIFICATION_EXCLUDES = 'dev/%s/minify_exclude'

Definition at line 23 of file Minification.php.

---

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

• vendor/magento/framework/View/Asset/Minification.php