Version 1

[yaffs-website] / web / modules / contrib / entityqueue / src / EntityQueueHandlerInterface.php

diff --git a/web/modules/contrib/entityqueue/src/EntityQueueHandlerInterface.php b/web/modules/contrib/entityqueue/src/EntityQueueHandlerInterface.php
new file mode 100644 (file)
index 0000000..0731c08
--- /dev/null
+++ b/web/modules/contrib/entityqueue/src/EntityQueueHandlerInterface.php
@@ -0,0 +1,107 @@
+<?php
+
+namespace Drupal\entityqueue;
+
+use Drupal\Core\Entity\EntityStorageInterface;
+use Drupal\Core\Plugin\PluginFormInterface;
+use Drupal\Component\Plugin\ConfigurablePluginInterface;
+
+/**
+ * Provides an interface for an EntityQueueHandler plugin.
+ *
+ * @see \Drupal\entityqueue\Annotation\EntityQueueHandler
+ * @see \Drupal\entityqueue\EntityQueueHandlerManager
+ * @see \Drupal\entityqueue\EntityQueueHandlerBase
+ * @see plugin_api
+ */
+interface EntityQueueHandlerInterface extends PluginFormInterface, ConfigurablePluginInterface {
+
+  /**
+   * 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
+   *   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
+   *   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
+   *   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
+   *   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
+   *   The entity queue object.
+   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
+   *   The entity storage object.
+   */
+  public function onQueuePostLoad(EntityQueueInterface $queue, EntityStorageInterface $storage);
+
+}