UninstallDependencyCheck Class Reference

Public Member Functions
	__construct (ComposerInformation $composerInfo, DependencyChecker $dependencyChecker, ThemeDependencyCheckerFactory $themeDependencyCheckerFactory)
	runUninstallReadinessCheck (array $packages)

Detailed Description

Class checks components dependencies for uninstall flow

Definition at line 16 of file UninstallDependencyCheck.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ComposerInformation	$composerInfo,
		DependencyChecker	$dependencyChecker,
		ThemeDependencyCheckerFactory	$themeDependencyCheckerFactory
	)

Constructor

Parameters

ComposerInformation	$composerInfo
DependencyChecker	$dependencyChecker
ThemeDependencyCheckerFactory	$themeDependencyCheckerFactory

Definition at line 42 of file UninstallDependencyCheck.php.

      {
        $this->composerInfo = $composerInfo;
        $this->packageDependencyChecker = $dependencyChecker;
        $this->themeDependencyChecker = $themeDependencyCheckerFactory->create();
    }

Member Function Documentation

runUninstallReadinessCheck()

runUninstallReadinessCheck

(

array

$packages

)

Run Composer dependency check for uninstall

Parameters

array

$packages

Returns

array

Exceptions

Definition at line 59 of file UninstallDependencyCheck.php.

    {
        try {
            $packagesAndTypes = $this->composerInfo->getRootRequiredPackageTypesByName();
            $dependencies = $this->packageDependencyChecker->checkDependencies($packages, true);
            $messages = [];
            $themes = [];

            foreach ($packages as $package) {
                if (!isset($packagesAndTypes[$package])) {
                    throw new \RuntimeException('Package ' . $package . ' not found in the system.');
                }

                switch ($packagesAndTypes[$package]) {
                    case ComposerInformation::METAPACKAGE_PACKAGE_TYPE:
                        unset($dependencies[$package]);
                        break;
                    case ComposerInformation::THEME_PACKAGE_TYPE:
                        $themes[] = $package;
                        break;
                }

                if (!empty($dependencies[$package])) {
                    $messages[] = $package . " has the following dependent package(s): "
                        . implode(', ', $dependencies[$package]);
                }
            }

            if (!empty($themes)) {
                $messages = array_merge(
                    $messages,
                    $this->themeDependencyChecker->checkChildThemeByPackagesName($themes)
                );
            }

            if (!empty($messages)) {
                throw new \RuntimeException(implode(PHP_EOL, $messages));
            }

            return ['success' => true];
        } catch (\RuntimeException $e) {
            $message = str_replace(PHP_EOL, '<br/>', htmlspecialchars($e->getMessage()));
            return ['success' => false, 'error' => $message];
        }
    }

---

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

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