Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Extension/ModuleUninstallValidatorInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Extension\ModuleUninstallValidatorInterface.
6	*/
7
8	namespace Drupal\Core\Extension;
9
10	/**
11	* Common interface for module uninstall validators.
12	*
13	* A module uninstall validator must implement this interface and be defined in
14	* a Drupal @link container service @endlink that is tagged
15	* module_install.uninstall_validator.
16	*/
17	interface ModuleUninstallValidatorInterface {
18
19	/**
20	* Determines the reasons a module can not be uninstalled.
21	*
22	* Example implementation:
23	* @code
24	* public function validate($module) {
25	* $entity_types = $this->entityManager->getDefinitions();
26	* $reasons = array();
27	* foreach ($entity_types as $entity_type) {
28	* if ($module == $entity_type->getProvider() && $entity_type instanceof ContentEntityTypeInterface && $this->entityManager->getStorage($entity_type->id())->hasData()) {
29	* $reasons[] = $this->t('There is content for the entity type: @entity_type', array('@entity_type' => $entity_type->getLabel()));
30	* }
31	* }
32	* return $reasons;
33	* }
34	* @endcode
35	*
36	* @param string $module
37	* A module name.
38	*
39	* @return string[]
40	* An array of reasons the module can not be uninstalled, empty if it can.
41	* Each reason should not end with any punctuation since multiple reasons
42	* can be displayed together.
43	*
44	* @see template_preprocess_system_modules_uninstall()
45	*/
46	public function validate($module);
47	}