interface EntityQueueHandlerInterface in Entityqueue 8

Provides an interface for an EntityQueueHandler plugin.

Hierarchy

• interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\DependentPluginInterface
  • interface \Drupal\entityqueue\EntityQueueHandlerInterface

See also

\Drupal\entityqueue\Annotation\EntityQueueHandler

\Drupal\entityqueue\EntityQueueHandlerManager

\Drupal\entityqueue\EntityQueueHandlerBase

Plugin API

File

src/EntityQueueHandlerInterface.php, line 20

Namespace

Drupal\entityqueue

interface EntityQueueHandlerInterface extends PluginFormInterface, ConfigurableInterface, PluginInspectionInterface, DerivativeInspectionInterface, DependentPluginInterface {

  /**
   * Sets the entity queue that is using this plugin.
   *
   * @param \Drupal\entityqueue\EntityQueueInterface $queue
   *   The entity queue.
   *
   * @return $this
   */
  public function setQueue(EntityQueueInterface $queue);

  /**
   * Whether or not the handler supports multiple subqueues.
   *
   * @return bool
   */
  public function supportsMultipleSubqueues();

  /**
   * Whether or not the handler contains subqueues with an automated lifecycle.
   *
   * For example, this property controls whether the title of subqueues can be
   * edited, or if they can be created or deleted through the UI or API calls.
   *
   * @return bool
   */
  public function hasAutomatedSubqueues();

  /**
   * Gets this queue handler's list builder operations.
   *
   * @return array
   *   An array of entity operations, as defined by
   *   \Drupal\Core\Entity\EntityListBuilderInterface::getOperations()
   */
  public function getQueueListBuilderOperations();

  /**
   * Acts on an entity queue before the presave hook is invoked.
   *
   * @param \Drupal\entityqueue\EntityQueueInterface $queue
   *   The entity queue object.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage object.
   */
  public function onQueuePreSave(EntityQueueInterface $queue, EntityStorageInterface $storage);

  /**
   * Acts on an entity queue before the insert or update hook is invoked.
   *
   * @param \Drupal\entityqueue\EntityQueueInterface $queue
   *   The entity queue object.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage object.
   * @param bool $update
   *   TRUE if the queue has been updated, or FALSE if it has been inserted.
   */
  public function onQueuePostSave(EntityQueueInterface $queue, EntityStorageInterface $storage, $update = TRUE);

  /**
   * Acts on entity queues before they are deleted and before hooks are invoked.
   *
   * @param \Drupal\entityqueue\EntityQueueInterface $queue
   *   The entity queue object.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage object.
   */
  public function onQueuePreDelete(EntityQueueInterface $queue, EntityStorageInterface $storage);

  /**
   * Acts on deleted entity queues before the delete hook is invoked.
   *
   * @param \Drupal\entityqueue\EntityQueueInterface $queue
   *   The entity queue object.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage object.
   */
  public function onQueuePostDelete(EntityQueueInterface $queue, EntityStorageInterface $storage);

  /**
   * Acts on loaded entity queues.
   *
   * @param \Drupal\entityqueue\EntityQueueInterface $queue
   *   The entity queue object.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage object.
   */
  public function onQueuePostLoad(EntityQueueInterface $queue, EntityStorageInterface $storage);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
EntityQueueHandlerInterface::getQueueListBuilderOperations	public	function	Gets this queue handler's list builder operations.	1
EntityQueueHandlerInterface::hasAutomatedSubqueues	public	function	Whether or not the handler contains subqueues with an automated lifecycle.	3
EntityQueueHandlerInterface::onQueuePostDelete	public	function	Acts on deleted entity queues before the delete hook is invoked.	1
EntityQueueHandlerInterface::onQueuePostLoad	public	function	Acts on loaded entity queues.	1
EntityQueueHandlerInterface::onQueuePostSave	public	function	Acts on an entity queue before the insert or update hook is invoked.	1
EntityQueueHandlerInterface::onQueuePreDelete	public	function	Acts on entity queues before they are deleted and before hooks are invoked.	1
EntityQueueHandlerInterface::onQueuePreSave	public	function	Acts on an entity queue before the presave hook is invoked.	1
EntityQueueHandlerInterface::setQueue	public	function	Sets the entity queue that is using this plugin.	1
EntityQueueHandlerInterface::supportsMultipleSubqueues	public	function	Whether or not the handler supports multiple subqueues.	3
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2