ModuleStatus Class Reference

Public Member Functions
	__construct (ModuleLoader $moduleLoader, DeploymentConfig $deploymentConfig, ObjectManagerProvider $objectManagerProvider)
	getAllModules (array $selectedModules=null)
	setIsEnabled ($status, $moduleName)

Protected Attributes
	$allModules
	$deploymentConfig

Detailed Description

Definition at line 14 of file ModuleStatus.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ModuleLoader	$moduleLoader,
		DeploymentConfig	$deploymentConfig,
		ObjectManagerProvider	$objectManagerProvider
	)

Constructor

Parameters

ModuleLoader	$moduleLoader
DeploymentConfig	$deploymentConfig
ObjectManagerProvider	$objectManagerProvider

Definition at line 44 of file ModuleStatus.php.

      {
        $this->allModules = $moduleLoader->load();
        foreach (array_keys($this->allModules) as $module) {
            $this->allModules[$module]['selected'] = true;
            $this->allModules[$module]['disabled'] = true;
        }
        $this->deploymentConfig = $deploymentConfig;
        $this->dependencyChecker = $objectManagerProvider->get()
            ->get(\Magento\Framework\Module\DependencyChecker::class);
    }

Member Function Documentation

getAllModules()

getAllModules

(

array

$selectedModules = null

)

Returns list of Modules to be displayed

Parameters

array

$selectedModules

Returns

array

Definition at line 65 of file ModuleStatus.php.

    {
        if (isset($this->allModules)) {
            if (isset($selectedModules)) {
                $diff = array_diff(array_keys($this->allModules), $selectedModules);
                foreach ($diff as $module) {
                    $this->allModules[$module]['selected'] = false;
                }
            } else {
                $this->deselectDisabledModules();
            }
            $disableModules = $this->getListOfDisableModules();
            if (isset($disableModules)) {
                foreach ($disableModules as $module) {
                    $this->allModules[$module]['disabled'] = false;
                }
            }
            //check if module is not checked and disabled - possible when config is incorrectly modified.
            foreach ($this->allModules as $module) {
                if (!$module['selected'] && $module['disabled']) {
                    $this->allModules[$module['name']]['disabled'] = false;
                }
            }
            return $this->allModules;
        }
        return [];
    }

setIsEnabled()

setIsEnabled	(		$status,
			$moduleName
	)

Parameters

bool	$status
String	$moduleName

Returns

void

Definition at line 136 of file ModuleStatus.php.

    {
        $this->allModules[$moduleName]['selected'] = $status;
    }

Field Documentation

$allModules

$allModules

protected

Definition at line 21 of file ModuleStatus.php.

$deploymentConfig

$deploymentConfig

protected

Definition at line 28 of file ModuleStatus.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Model/ModuleStatus.php