public function ModulesUninstallForm::buildForm in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/system/src/Form/ModulesUninstallForm.php \Drupal\system\Form\ModulesUninstallForm::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides FormInterface::buildForm

File

core/modules/system/src/Form/ModulesUninstallForm.php, line 105

Class

ModulesUninstallForm

Provides a form for uninstalling modules.

Namespace

Drupal\system\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {

  // Make sure the install API is available.
  include_once DRUPAL_ROOT . '/core/includes/install.inc';

  // Get a list of all available modules that can be uninstalled.
  $uninstallable = array_filter($this->moduleExtensionList
    ->getList(), function ($module) {
    return empty($module->info['required']) && $module->status;
  });

  // Include system.admin.inc so we can use the sort callbacks.
  $this->moduleHandler
    ->loadInclude('system', 'inc', 'system.admin');
  $form['filters'] = [
    '#type' => 'container',
    '#attributes' => [
      'class' => [
        'table-filter',
        'js-show',
      ],
    ],
  ];
  $form['filters']['text'] = [
    '#type' => 'search',
    '#title' => $this
      ->t('Filter modules'),
    '#title_display' => 'invisible',
    '#size' => 30,
    '#placeholder' => $this
      ->t('Filter by name or description'),
    '#description' => $this
      ->t('Enter a part of the module name or description'),
    '#attributes' => [
      'class' => [
        'table-filter-text',
      ],
      'data-table' => '#system-modules-uninstall',
      'autocomplete' => 'off',
    ],
  ];
  $form['modules'] = [];

  // Only build the rest of the form if there are any modules available to
  // uninstall;
  if (empty($uninstallable)) {
    return $form;
  }

  // Sort all modules by their name.
  uasort($uninstallable, [
    ModuleExtensionList::class,
    'sortByName',
  ]);
  $validation_reasons = $this->moduleInstaller
    ->validateUninstall(array_keys($uninstallable));
  $form['uninstall'] = [
    '#tree' => TRUE,
  ];
  foreach ($uninstallable as $module_key => $module) {
    $name = $module->info['name'] ?: $module
      ->getName();
    $form['modules'][$module
      ->getName()]['#module_name'] = $name;
    $form['modules'][$module
      ->getName()]['name']['#markup'] = $name;
    $form['modules'][$module
      ->getName()]['description']['#markup'] = $this
      ->t($module->info['description']);
    $form['uninstall'][$module
      ->getName()] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Uninstall @module module', [
        '@module' => $name,
      ]),
      '#title_display' => 'invisible',
    ];

    // If a validator returns reasons not to uninstall a module,
    // list the reasons and disable the check box.
    if (isset($validation_reasons[$module_key])) {
      $form['modules'][$module
        ->getName()]['#validation_reasons'] = $validation_reasons[$module_key];
      $form['uninstall'][$module
        ->getName()]['#disabled'] = TRUE;
    }

    // All modules which depend on this one must be uninstalled first, before
    // we can allow this module to be uninstalled.
    foreach (array_keys($module->required_by) as $dependent) {
      if ($this->updateRegistry
        ->getInstalledVersion($dependent) !== $this->updateRegistry::SCHEMA_UNINSTALLED) {
        $form['modules'][$module
          ->getName()]['#required_by'][] = $dependent;
        $form['uninstall'][$module
          ->getName()]['#disabled'] = TRUE;
      }
    }
  }
  $form['#attached']['library'][] = 'system/drupal.system.modules';
  $form['actions'] = [
    '#type' => 'actions',
  ];
  $form['actions']['submit'] = [
    '#type' => 'submit',
    '#value' => $this
      ->t('Uninstall'),
  ];
  return $form;
}