ContentUninstallValidator.php

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

Namespace

Drupal\Core\Entity

File

core/lib/Drupal/Core/Entity/ContentUninstallValidator.php

View source
<?php

namespace Drupal\Core\Entity;

use Drupal\Core\Extension\ModuleUninstallValidatorInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\Core\Url;

/**
 * Validates module uninstall readiness based on existing content entities.
 */
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;
    }

}

Classes

Title Deprecated Summary
ContentUninstallValidator Validates module uninstall readiness based on existing content entities.

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