Status Class Reference

Public Member Functions
	__construct (ModuleList\Loader $loader, ModuleList $list, Writer $writer, ConflictChecker $conflictChecker, DependencyChecker $dependencyChecker)
	checkConstraints ( $isEnabled, $modulesToBeChanged, $currentlyEnabledModules=null, $prettyMessage=false)
	setIsEnabled ($isEnabled, $modules)
	getModulesToChange ($isEnabled, $modules)

Detailed Description

A service for controlling module status

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 17 of file Status.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ModuleList\Loader	$loader,
		ModuleList	$list,
		Writer	$writer,
		ConflictChecker	$conflictChecker,
		DependencyChecker	$dependencyChecker
	)

Constructor

Parameters

ModuleList\Loader	$loader
ModuleList	$list
Writer	$writer
ConflictChecker	$conflictChecker
DependencyChecker	$dependencyChecker

Definition at line 63 of file Status.php.

      {
        $this->loader = $loader;
        $this->list = $list;
        $this->writer = $writer;
        $this->conflictChecker = $conflictChecker;
        $this->dependencyChecker = $dependencyChecker;
    }

Member Function Documentation

checkConstraints()

checkConstraints	(		$isEnabled,
			$modulesToBeChanged,
			$currentlyEnabledModules = null,
			$prettyMessage = false
	)

Whether it is allowed to enable or disable specified modules

Parameters

bool	$isEnabled
	string[]	$modulesToBeChanged
	string[]	$currentlyEnabledModules
bool	$prettyMessage

Returns

string[]

Definition at line 87 of file Status.php.

      {
        $errorMessages = [];
        if ($isEnabled) {
            $errorModulesDependency = $this->dependencyChecker->checkDependenciesWhenEnableModules(
                $modulesToBeChanged,
                $currentlyEnabledModules
            );
            $errorModulesConflict = $this->conflictChecker->checkConflictsWhenEnableModules(
                $modulesToBeChanged,
                $currentlyEnabledModules
            );
        } else {
            $errorModulesDependency = $this->dependencyChecker->checkDependenciesWhenDisableModules(
                $modulesToBeChanged,
                $currentlyEnabledModules
            );
            $errorModulesConflict = [];
        }

        foreach ($errorModulesDependency as $moduleName => $missingDependencies) {
            if (!empty($missingDependencies)) {
                if ($prettyMessage) {
                    $errorMessages[] = $this->createShortErrorMessage($isEnabled, $moduleName);
                } else {
                    $errorMessages = array_merge(
                        $errorMessages,
                        $this->createVerboseErrorMessage($isEnabled, $moduleName, $missingDependencies)
                    );
                }
            }
        }

        foreach ($errorModulesConflict as $moduleName => $conflictingModules) {
            if (!empty($conflictingModules)) {
                $errorMessages[] = "Cannot enable $moduleName because it conflicts with other modules:";
                $errorMessages[] = implode("\n", $conflictingModules);
            }
        }

        return $errorMessages;
    }

getModulesToChange()

getModulesToChange	(		$isEnabled,
			$modules
	)

Get a list of modules that will be changed

Parameters

bool	$isEnabled
	string[]	$modules

Returns

string[]

Definition at line 164 of file Status.php.

    {
        $changed = [];
        foreach ($this->getAllModules($modules) as $name) {
            $currentStatus = $this->list->has($name);
            if (in_array($name, $modules)) {
                if ($isEnabled != $currentStatus) {
                    $changed[] = $name;
                }
            }
        }
        return $changed;
    }

setIsEnabled()

setIsEnabled	(		$isEnabled,
			$modules
	)

Sets specified modules to enabled or disabled state

Performs other necessary routines, such as cache cleanup

Parameters

bool	$isEnabled
	string[]	$modules

Returns

void

Definition at line 143 of file Status.php.

    {
        $result = [];
        foreach ($this->getAllModules($modules) as $name) {
            $currentStatus = $this->list->has($name);
            if (in_array($name, $modules)) {
                $result[$name] = (int)$isEnabled;
            } else {
                $result[$name] = (int)$currentStatus;
            }
        }
        $this->writer->saveConfig([ConfigFilePool::APP_CONFIG => ['modules' => $result]], true);
    }

---

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

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