Modules Class Reference

Inheritance diagram for Modules:

Public Member Functions
	__construct (ModuleStatus $allModules, ObjectManagerProvider $objectManagerProvider)
	indexAction ()
	allModulesValidAction ()
	validateAction ()

Protected Attributes
	$allModules

Detailed Description

Definition at line 14 of file Modules.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ModuleStatus	$allModules,
		ObjectManagerProvider	$objectManagerProvider
	)

Parameters

ModuleStatus	$allModules
ObjectManagerProvider	$objectManagerProvider

Definition at line 32 of file Modules.php.

    {
        $this->allModules = $allModules;
        $this->objectManager = $objectManagerProvider->get();
    }

Member Function Documentation

allModulesValidAction()

allModulesValidAction

(

)

Result of checking Modules Validity

Returns

JsonModel

Definition at line 68 of file Modules.php.

    {
        try {
            $params = Json::decode($this->getRequest()->getContent(), Json::TYPE_ARRAY);
            $enabledModules = isset($params['selectedModules']) ? $params['selectedModules'] : [];
            return $this->checkGraph($enabledModules);
        } catch (\Exception $e) {
            return new JsonModel(['success' => false, 'error' => $e->getMessage()]);
        }
    }

indexAction()

indexAction

(

)

Returns list of Modules

Returns

JsonModel

Definition at line 43 of file Modules.php.

    {
        $allModules = $this->allModules->getAllModules();
        $enabledModules = [];
        foreach ($allModules as $module) {
            if ($module['selected']) {
                $enabledModules[] = $module['name'];
            }
        }
        $validity = $this->checkGraph($enabledModules);
        ksort($allModules);
        if ($validity->getVariable("success")) {
            return new JsonModel(['success' => true, 'modules' => $allModules]);
        } else {
            $errorMessage = $validity->getVariable("error");
            return new JsonModel(['success' => false, 'modules' => $allModules,
                'error' => '<b> Corrupt config.php!</b> <br />' . $errorMessage]);
        }
    }

validateAction()

validateAction

(

)

Check Module Dependencies

Returns

JsonModel

Definition at line 105 of file Modules.php.

    {
        $params = Json::decode($this->getRequest()->getContent(), Json::TYPE_ARRAY);
        $status = $this->objectManager->create(\Magento\Framework\Module\Status::class);

        $constraints = $status->checkConstraints(
            $params['status'],
            [$params['module']],
            array_diff($params['selectedModules'], [$params['module']])
        );
        if ($constraints) {
            $message = $this->getConstraintsFailureMessage($params['status'], $constraints);
            return new JsonModel(['success' => false, 'error' => $message]);
        }

        $this->allModules->setIsEnabled($params['status'], $params['module']);
        $allModules = $this->allModules->getAllModules($params['selectedModules']);
        ksort($allModules);
        return new JsonModel(['modules' => $allModules]);
    }

Field Documentation

$allModules

$allModules

protected

Definition at line 26 of file Modules.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Controller/Modules.php