RequiredModuleUninstallValidator.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?php
  2. namespace Drupal\Core\Extension;
  3. use Drupal\Core\StringTranslation\StringTranslationTrait;
  4. use Drupal\Core\StringTranslation\TranslationInterface;
  5. /**
  6. * Ensures that required modules cannot be uninstalled.
  7. */
  8. class RequiredModuleUninstallValidator implements ModuleUninstallValidatorInterface {
  9. use StringTranslationTrait;
  10. /**
  11. * The module extension list.
  12. *
  13. * @var \Drupal\Core\Extension\ModuleExtensionList
  14. */
  15. protected $moduleExtensionList;
  16. /**
  17. * Constructs a new RequiredModuleUninstallValidator.
  18. *
  19. * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
  20. * The string translation service.
  21. * @param \Drupal\Core\Extension\ModuleExtensionList $extension_list_module
  22. * The module extension list.
  23. */
  24. public function __construct(TranslationInterface $string_translation, ModuleExtensionList $extension_list_module) {
  25. $this->stringTranslation = $string_translation;
  26. $this->moduleExtensionList = $extension_list_module;
  27. }
  28. /**
  29. * {@inheritdoc}
  30. */
  31. public function validate($module) {
  32. $reasons = [];
  33. $module_info = $this->getModuleInfoByModule($module);
  34. if (!empty($module_info['required'])) {
  35. $reasons[] = $this->t('The @module module is required', ['@module' => $module_info['name']]);
  36. }
  37. return $reasons;
  38. }
  39. /**
  40. * Returns the module info for a specific module.
  41. *
  42. * @param string $module
  43. * The name of the module.
  44. *
  45. * @return array
  46. * The module info, or empty array if that module does not exist.
  47. */
  48. protected function getModuleInfoByModule($module) {
  49. if ($this->moduleExtensionList->exists($module)) {
  50. return $this->moduleExtensionList->get($module)->info;
  51. }
  52. return [];
  53. }
  54. }