function ModuleHandler::buildModuleDependencies

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Extension/ModuleHandler.php \Drupal\Core\Extension\ModuleHandler::buildModuleDependencies()
  2. 8.9.x core/lib/Drupal/Core/Extension/ModuleHandler.php \Drupal\Core\Extension\ModuleHandler::buildModuleDependencies()
  3. 11.x core/lib/Drupal/Core/Extension/ModuleHandler.php \Drupal\Core\Extension\ModuleHandler::buildModuleDependencies()

Determines which modules require and are required by each module.

Parameters

array $modules: An array of module objects keyed by module name. Each object contains information discovered during a Drupal\Core\Extension\ExtensionDiscovery scan.

Return value

array The same array with the new keys for each module:

  • requires: An array with the keys being the modules that this module requires.
  • required_by: An array with the keys being the modules that will not work without this module.

Overrides ModuleHandlerInterface::buildModuleDependencies

File

core/lib/Drupal/Core/Extension/ModuleHandler.php, line 223

Class

ModuleHandler
Class that manages modules in a Drupal installation.

Namespace

Drupal\Core\Extension

Code

public function buildModuleDependencies(array $modules) {
  foreach ($modules as $module) {
    $graph[$module->getName()]['edges'] = [];
    if (isset($module->info['dependencies']) && is_array($module->info['dependencies'])) {
      foreach ($module->info['dependencies'] as $dependency) {
        $dependency_data = Dependency::createFromString($dependency);
        $graph[$module->getName()]['edges'][$dependency_data->getName()] = $dependency_data;
      }
    }
  }
  $graph_object = new Graph($graph ?? []);
  $graph = $graph_object->searchAndSort();
  foreach ($graph as $module_name => $data) {
    $modules[$module_name]->required_by = $data['reverse_paths'] ?? [];
    $modules[$module_name]->requires = $data['paths'] ?? [];
    $modules[$module_name]->sort = $data['weight'];
  }
  return $modules;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.