annotate core/modules/views/src/Plugin/DependentWithRemovalPluginInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\views\Plugin;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Provides an interface for a plugin that has dependencies that can be removed.
Chris@0 7 *
Chris@0 8 * @ingroup views_plugins
Chris@0 9 */
Chris@0 10 interface DependentWithRemovalPluginInterface {
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Allows a plugin to define whether it should be removed.
Chris@0 14 *
Chris@0 15 * If this method returns TRUE then the plugin should be removed.
Chris@0 16 *
Chris@0 17 * @param array $dependencies
Chris@0 18 * An array of dependencies that will be deleted keyed by dependency type.
Chris@0 19 * Dependency types are, for example, entity, module and theme.
Chris@0 20 *
Chris@0 21 * @return bool
Chris@0 22 * TRUE if the plugin instance should be removed.
Chris@0 23 *
Chris@0 24 * @see \Drupal\Core\Config\Entity\ConfigDependencyManager
Chris@0 25 * @see \Drupal\Core\Config\ConfigEntityBase::preDelete()
Chris@0 26 * @see \Drupal\Core\Config\ConfigManager::uninstall()
Chris@0 27 * @see \Drupal\Core\Entity\EntityDisplayBase::onDependencyRemoval()
Chris@0 28 */
Chris@0 29 public function onDependencyRemoval(array $dependencies);
Chris@0 30
Chris@0 31 }