class ContentUninstallValidator

Same name in this branch
  1. 9 core/lib/Drupal/Core/ProxyClass/Entity/ContentUninstallValidator.php \Drupal\Core\ProxyClass\Entity\ContentUninstallValidator
Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/ProxyClass/Entity/ContentUninstallValidator.php \Drupal\Core\ProxyClass\Entity\ContentUninstallValidator
  2. 8.9.x core/lib/Drupal/Core/Entity/ContentUninstallValidator.php \Drupal\Core\Entity\ContentUninstallValidator
  3. 10 core/lib/Drupal/Core/ProxyClass/Entity/ContentUninstallValidator.php \Drupal\Core\ProxyClass\Entity\ContentUninstallValidator
  4. 10 core/lib/Drupal/Core/Entity/ContentUninstallValidator.php \Drupal\Core\Entity\ContentUninstallValidator
  5. 11.x core/lib/Drupal/Core/ProxyClass/Entity/ContentUninstallValidator.php \Drupal\Core\ProxyClass\Entity\ContentUninstallValidator
  6. 11.x core/lib/Drupal/Core/Entity/ContentUninstallValidator.php \Drupal\Core\Entity\ContentUninstallValidator

Validates module uninstall readiness based on existing content entities.

Hierarchy

Expanded class hierarchy of ContentUninstallValidator

1 string reference to 'ContentUninstallValidator'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses ContentUninstallValidator
content_uninstall_validator in core/core.services.yml
Drupal\Core\Entity\ContentUninstallValidator

File

core/lib/Drupal/Core/Entity/ContentUninstallValidator.php, line 13

Namespace

Drupal\Core\Entity
View source
class ContentUninstallValidator implements ModuleUninstallValidatorInterface {
    use StringTranslationTrait;
    
    /**
     * The entity type manager service.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a new ContentUninstallValidator.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager service.
     * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
     *   The string translation service.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, TranslationInterface $string_translation) {
        $this->entityTypeManager = $entity_type_manager;
        $this->stringTranslation = $string_translation;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validate($module) {
        $entity_types = $this->entityTypeManager
            ->getDefinitions();
        $reasons = [];
        foreach ($entity_types as $entity_type) {
            if ($module == $entity_type->getProvider() && $entity_type instanceof ContentEntityTypeInterface && $this->entityTypeManager
                ->getStorage($entity_type->id())
                ->hasData()) {
                $reasons[] = $this->t('There is content for the entity type: @entity_type. <a href=":url">Remove @entity_type_plural</a>.', [
                    '@entity_type' => $entity_type->getLabel(),
                    '@entity_type_plural' => $entity_type->getPluralLabel(),
                    ':url' => Url::fromRoute('system.prepare_modules_entity_uninstall', [
                        'entity_type_id' => $entity_type->id(),
                    ])
                        ->toString(),
                ]);
            }
        }
        return $reasons;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContentUninstallValidator::$entityTypeManager protected property The entity type manager service.
ContentUninstallValidator::validate public function Determines the reasons a module can not be uninstalled. Overrides ModuleUninstallValidatorInterface::validate
ContentUninstallValidator::__construct public function Constructs a new ContentUninstallValidator.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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