class ContentUninstallValidator in Drupal 8

Validates module uninstall readiness based on existing content entities.

Hierarchy

• class \Drupal\Core\Entity\ContentUninstallValidator implements ModuleUninstallValidatorInterface uses DeprecatedServicePropertyTrait, StringTranslationTrait

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 14

Namespace

Drupal\Core\Entity

class ContentUninstallValidator implements ModuleUninstallValidatorInterface {
  use StringTranslationTrait;
  use DeprecatedServicePropertyTrait;

  /**
   * {@inheritdoc}
   */
  protected $deprecatedProperties = [
    'entityManager' => 'entity.manager',
  ];

  /**
   * 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) {
    if ($entity_type_manager instanceof EntityManagerInterface) {
      @trigger_error('Passing the entity.manager service to ContentUninstallValidator::__construct() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Pass the new dependencies instead. See https://www.drupal.org/node/2549139.', E_USER_DEPRECATED);
      $this->entityTypeManager = \Drupal::entityTypeManager();
    }
    else {
      $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

Name	Modifiers	Type	Description	Overrides
ContentUninstallValidator::$deprecatedProperties	protected	property
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.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.