Manager Class Reference

Public Member Functions
	__construct (Output\ConfigInterface $outputConfig, ModuleListInterface $moduleList, array $outputConfigPaths=[])
	isEnabled ($moduleName)
	isOutputEnabled ($moduleName)

Protected Member Functions
	_isCustomOutputConfigEnabled ($moduleName)

Detailed Description

Module status manager.

Usage:

$manager->isEnabled('Vendor_Module');

Definition at line 20 of file Manager.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Output\ConfigInterface	$outputConfig,
		ModuleListInterface	$moduleList,
		array	$outputConfigPaths = []
	)

Parameters

Output\ConfigInterface	$outputConfig
ModuleListInterface	$moduleList
array	$outputConfigPaths

Definition at line 44 of file Manager.php.

      {
        $this->outputConfig = $outputConfig;
        $this->moduleList = $moduleList;
        $this->outputConfigPaths = $outputConfigPaths;
    }

Member Function Documentation

_isCustomOutputConfigEnabled()

_isCustomOutputConfigEnabled (   $moduleName )

protected

Whether a configuration switch for a module output permits output or not

Parameters

string

$moduleName

Fully-qualified module name

Returns

boolean

Deprecated:

101.0.0

Definition at line 90 of file Manager.php.

    {
        if (isset($this->outputConfigPaths[$moduleName])) {
            $configPath = $this->outputConfigPaths[$moduleName];
            if (defined($configPath)) {
                $configPath = constant($configPath);
            }
            return $this->outputConfig->isSetFlag($configPath);
        }
        return true;
    }

isEnabled()

isEnabled

(

$moduleName

)

Whether a module is enabled in the configuration or not

Parameters

string

$moduleName

Fully-qualified module name

Returns

boolean

Definition at line 60 of file Manager.php.

    {
        return $this->moduleList->has($moduleName);
    }

isOutputEnabled()

isOutputEnabled

(

$moduleName

)

Whether a module output is permitted by the configuration or not

Parameters

string

$moduleName

Fully-qualified module name

Returns

boolean

Deprecated:

101.0.0 Magento does not support disabling/enabling modules output from the Admin Panel since 2.2.0 version. Module output can still be enabled/disabled in configuration files. However, this functionality should not be used in future development. Module design should explicitly state dependencies to avoid requiring output disabling. This functionality will temporarily be kept in Magento core, as there are unresolved modularity issues that will be addressed in future releases.

Definition at line 76 of file Manager.php.

    {
        return $this->isEnabled($moduleName)
            && $this->_isCustomOutputConfigEnabled($moduleName)
            && !$this->outputConfig->isEnabled($moduleName);
    }

---

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

• vendor/magento/framework/Module/Manager.php