Version 1

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

diff --git a/web/modules/contrib/entityqueue/src/EntityQueueHandlerBase.php b/web/modules/contrib/entityqueue/src/EntityQueueHandlerBase.php
new file mode 100644 (file)
index 0000000..94cc9d2
--- /dev/null
+++ b/web/modules/contrib/entityqueue/src/EntityQueueHandlerBase.php
@@ -0,0 +1,131 @@
+<?php
+
+namespace Drupal\entityqueue;
+
+use Drupal\Component\Plugin\PluginBase;
+use Drupal\Core\DependencyInjection\DependencySerializationTrait;
+use Drupal\Core\Entity\EntityStorageInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+
+/**
+ * Base class for EntityQueueHandler plugins.
+ */
+abstract class EntityQueueHandlerBase extends PluginBase implements EntityQueueHandlerInterface {
+
+  use DependencySerializationTrait;
+  use StringTranslationTrait;
+
+  /**
+   * The entity queue that is using this plugin.
+   *
+   * @var \Drupal\entityqueue\Entity\EntityQueue
+   */
+  protected $queue;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(array $configuration, $plugin_id, array $plugin_definition) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+    $this->configuration += $this->defaultConfiguration();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getConfiguration() {
+    return $this->configuration;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setConfiguration(array $configuration) {
+    $this->configuration = $configuration;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return [];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function calculateDependencies() {
+    return [];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
+    // Override this.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+    // Override this.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setQueue(EntityQueueInterface $queue) {
+    $this->queue = $queue;
+
+    return $this;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getQueueListBuilderOperations() {
+    // Add an operation to list all subqueues by default.
+    $operations['view_subqueues'] = [
+      'title' => $this->t('View subqueues'),
+      'weight' => -9,
+      'url' => $this->queue->urlInfo('subqueue-list'),
+    ];
+
+    return $operations;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function onQueuePreSave(EntityQueueInterface $queue, EntityStorageInterface $storage) { }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function onQueuePostSave(EntityQueueInterface $queue, EntityStorageInterface $storage, $update = TRUE) { }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function onQueuePreDelete(EntityQueueInterface $queue, EntityStorageInterface $storage) { }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function onQueuePostDelete(EntityQueueInterface $queue, EntityStorageInterface $storage) { }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function onQueuePostLoad(EntityQueueInterface $queue, EntityStorageInterface $storage) { }
+
+}