You are here

Home » API reference » Entityqueue 8 » EntityQueueHandlerBase.php

abstract class EntityQueueHandlerBase in Entityqueue 8

Base class for EntityQueueHandler plugins.

Hierarchy

Expanded class hierarchy of EntityQueueHandlerBase

3 files declare their use of EntityQueueHandlerBase
Multiple.php in src/Plugin/EntityQueueHandler/Multiple.php
Simple.php in src/Plugin/EntityQueueHandler/Simple.php
Test.php in tests/modules/entityqueue_test/src/Plugin/EntityQueueHandler/Test.php

File

src/EntityQueueHandlerBase.php, line 15

Namespace

Drupal\entityqueue
View source 
abstract class EntityQueueHandlerBase extends PluginBase implements EntityQueueHandlerInterface {
  use DependencySerializationTrait;
  use StringTranslationTrait;

  /**
   * The entity queue that is using this plugin.
   *
   * @var \Drupal\entityqueue\EntityQueueInterface
   */
  protected $queue;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this
      ->setConfiguration($configuration);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep($this
      ->defaultConfiguration(), $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
        ->toUrl('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) {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityQueueHandlerBase::$queue protected property The entity queue that is using this plugin.
EntityQueueHandlerBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
EntityQueueHandlerBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
EntityQueueHandlerBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 2
EntityQueueHandlerBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
EntityQueueHandlerBase::getQueueListBuilderOperations public function Gets this queue handler's list builder operations. Overrides EntityQueueHandlerInterface::getQueueListBuilderOperations 1
EntityQueueHandlerBase::onQueuePostDelete public function Acts on deleted entity queues before the delete hook is invoked. Overrides EntityQueueHandlerInterface::onQueuePostDelete 2
EntityQueueHandlerBase::onQueuePostLoad public function Acts on loaded entity queues. Overrides EntityQueueHandlerInterface::onQueuePostLoad
EntityQueueHandlerBase::onQueuePostSave public function Acts on an entity queue before the insert or update hook is invoked. Overrides EntityQueueHandlerInterface::onQueuePostSave 2
EntityQueueHandlerBase::onQueuePreDelete public function Acts on entity queues before they are deleted and before hooks are invoked. Overrides EntityQueueHandlerInterface::onQueuePreDelete
EntityQueueHandlerBase::onQueuePreSave public function Acts on an entity queue before the presave hook is invoked. Overrides EntityQueueHandlerInterface::onQueuePreSave
EntityQueueHandlerBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
EntityQueueHandlerBase::setQueue public function Sets the entity queue that is using this plugin. Overrides EntityQueueHandlerInterface::setQueue
EntityQueueHandlerBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 2
EntityQueueHandlerBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
EntityQueueHandlerBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 2
EntityQueueHandlerInterface::hasAutomatedSubqueues public function Whether or not the handler contains subqueues with an automated lifecycle. 3
EntityQueueHandlerInterface::supportsMultipleSubqueues public function Whether or not the handler supports multiple subqueues. 3
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.