Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Attributes
DependencyChecker Class Reference

Public Member Functions

 __construct (ModuleList $list, ModuleList\Loader $loader, PackageInfoFactory $packageInfoFactory)
 
 checkDependenciesWhenDisableModules ($toBeDisabledModules, $currentlyEnabledModules=null)
 
 checkDependenciesWhenEnableModules ($toBeEnabledModules, $currentlyEnabledModules=null)
 

Protected Attributes

 $packageInfo
 

Detailed Description

Checks for dependencies between modules

Definition at line 13 of file DependencyChecker.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( ModuleList  $list,
ModuleList\Loader  $loader,
PackageInfoFactory  $packageInfoFactory 
)

Constructor

Parameters
ModuleList$list
ModuleList\Loader$loader
PackageInfoFactory$packageInfoFactory

Definition at line 48 of file DependencyChecker.php.

49  {
50  $this->enabledModuleList = $list->getNames();
51  $this->fullModuleList = $loader->load();
52  $this->packageInfo = $packageInfoFactory->create();
53  }
$loader
Definition: autoload.php:8

Member Function Documentation

◆ checkDependenciesWhenDisableModules()

checkDependenciesWhenDisableModules (   $toBeDisabledModules,
  $currentlyEnabledModules = null 
)

Checks dependencies when disabling modules

Parameters
string[]$toBeDisabledModules
string[]$currentlyEnabledModules
Returns
array

Definition at line 62 of file DependencyChecker.php.

63  {
64  $masterList = isset($currentlyEnabledModules) ? $currentlyEnabledModules : $this->enabledModuleList;
65  // assume disable succeeds: currently enabled modules - to-be-disabled modules
66  $enabledModules = array_diff($masterList, $toBeDisabledModules);
67  return $this->checkDependencyGraph(false, $toBeDisabledModules, $enabledModules);
68  }

◆ checkDependenciesWhenEnableModules()

checkDependenciesWhenEnableModules (   $toBeEnabledModules,
  $currentlyEnabledModules = null 
)

Checks dependencies when enabling modules

Parameters
string[]$toBeEnabledModules
string[]$currentlyEnabledModules
Returns
array

Definition at line 77 of file DependencyChecker.php.

78  {
79  $masterList = isset($currentlyEnabledModules) ? $currentlyEnabledModules : $this->enabledModuleList;
80  // assume enable succeeds: union of currently enabled modules and to-be-enabled modules
81  $enabledModules = array_unique(array_merge($masterList, $toBeEnabledModules));
82  return $this->checkDependencyGraph(true, $toBeEnabledModules, $enabledModules);
83  }

Field Documentation

◆ $packageInfo

$packageInfo
protected

Definition at line 39 of file DependencyChecker.php.


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