www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/src/Plugin/DependentWithRemovalPluginInterface.php

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