DependencyCheck Class Reference

Inheritance diagram for DependencyCheck:

Public Member Functions
	__construct (DependencyReadinessCheck $dependencyReadinessCheck, UninstallDependencyCheck $uninstallDependencyCheck, ModuleStatusFactory $moduleStatusFactory)
	componentDependencyAction ()
	uninstallDependencyCheckAction ()
	enableDisableDependencyCheckAction ()

Protected Attributes
	$dependencyReadinessCheck
	$uninstallDependencyCheck
	$moduleStatus

Detailed Description

Class DependencyCheck

Checks dependencies.

Definition at line 22 of file DependencyCheck.php.

Constructor & Destructor Documentation

__construct()

__construct	(	DependencyReadinessCheck	$dependencyReadinessCheck,
		UninstallDependencyCheck	$uninstallDependencyCheck,
		ModuleStatusFactory	$moduleStatusFactory
	)

Constructor

Parameters

DependencyReadinessCheck	$dependencyReadinessCheck
UninstallDependencyCheck	$uninstallDependencyCheck
ModuleStatusFactory	$moduleStatusFactory

Definition at line 52 of file DependencyCheck.php.

      {
        $this->dependencyReadinessCheck = $dependencyReadinessCheck;
        $this->uninstallDependencyCheck = $uninstallDependencyCheck;
        $this->moduleStatus = $moduleStatusFactory->create();
    }

Member Function Documentation

componentDependencyAction()

componentDependencyAction

(

)

Verifies component dependency

Returns

JsonModel

Definition at line 67 of file DependencyCheck.php.

    {
        $responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;
        $packages = Json::decode($this->getRequest()->getContent(), Json::TYPE_ARRAY);
        $data = [];
        foreach ($packages as $package) {
            $data[] = implode(' ', $package);
        }
        $dependencyCheck = $this->dependencyReadinessCheck->runReadinessCheck($data);
        $data = [];
        if (!$dependencyCheck['success']) {
            $responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
            $data['errorMessage'] = $dependencyCheck['error'];
        }
        $data['responseType'] = $responseType;
        return new JsonModel($data);
    }

enableDisableDependencyCheckAction()

enableDisableDependencyCheckAction

(

)

Verifies component dependency for enable/disable actions

Returns

JsonModel

Definition at line 115 of file DependencyCheck.php.

    {
        $responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;
        $data = Json::decode($this->getRequest()->getContent(), Json::TYPE_ARRAY);

        try {
            if (empty($data['packages'])) {
                throw new \Exception('No packages have been found.');
            }

            if (empty($data['type'])) {
                throw new \Exception('Can not determine the flow.');
            }

            $modules = $data['packages'];

            $isEnable = ($data['type'] !== 'disable');

            $modulesToChange = [];
            foreach ($modules as $module) {
                if (!isset($module['name'])) {
                    throw new \Exception('Can not find module name.');
                }
                $modulesToChange[] = $module['name'];
            }

            $constraints = $this->moduleStatus->checkConstraints($isEnable, $modulesToChange);
            $data = [];

            if ($constraints) {
                $data['errorMessage'] = "Unable to change status of modules because of the following constraints: "
                    . implode("<br>", $constraints);
                $responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
            }
        } catch (\Exception $e) {
            $responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
            $data['errorMessage'] = $e->getMessage();
        }

        $data['responseType'] = $responseType;
        return new JsonModel($data);
    }

uninstallDependencyCheckAction()

uninstallDependencyCheckAction

(

)

Verifies component dependency for uninstall

Returns

JsonModel

Definition at line 90 of file DependencyCheck.php.

    {
        $responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;
        $packages = Json::decode($this->getRequest()->getContent(), Json::TYPE_ARRAY);

        $packagesToDelete = [];
        foreach ($packages as $package) {
            $packagesToDelete[] = $package['name'];
        }

        $dependencyCheck = $this->uninstallDependencyCheck->runUninstallReadinessCheck($packagesToDelete);
        $data = [];
        if (!$dependencyCheck['success']) {
            $responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
            $data['errorMessage'] = $dependencyCheck['error'];
        }
        $data['responseType'] = $responseType;
        return new JsonModel($data);
    }

Field Documentation

$dependencyReadinessCheck

$dependencyReadinessCheck

protected

Definition at line 29 of file DependencyCheck.php.

$moduleStatus

$moduleStatus

protected

Definition at line 43 of file DependencyCheck.php.

$uninstallDependencyCheck

$uninstallDependencyCheck

protected

Definition at line 36 of file DependencyCheck.php.

---

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

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