You are here

Home » API reference » Advanced Queue 8 » BackendBase.php

abstract class BackendBase in Advanced Queue 8

Provides the base class for queue backends.

Hierarchy

Expanded class hierarchy of BackendBase

File

src/Plugin/AdvancedQueue/Backend/BackendBase.php, line 15

Namespace

Drupal\advancedqueue\Plugin\AdvancedQueue\Backend
View source 
abstract class BackendBase extends PluginBase implements BackendInterface, ContainerFactoryPluginInterface {

  /**
   * The time.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * The current queue ID.
   *
   * @var string
   */
  protected $queueId;

  /**
   * Constructs a new BackendBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, TimeInterface $time) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->time = $time;
    if (array_key_exists('_entity_id', $configuration)) {
      $this->queueId = $configuration['_entity_id'];
      unset($configuration['_entity_id']);
    }
    $this
      ->setConfiguration($configuration);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('datetime.time'));
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

  /**
   * {@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 [
      'lease_time' => 300,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['lease_time'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Lease time'),
      '#description' => $this
        ->t('How long a job is reserved for processing.'),
      '#field_suffix' => $this
        ->t('seconds'),
      '#default_value' => $this->configuration['lease_time'],
      '#min' => 1,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    if (!$form_state
      ->getErrors()) {
      $values = $form_state
        ->getValue($form['#parents']);
      $this->configuration = [];
      $this->configuration['lease_time'] = $values['lease_time'];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return (string) $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function cleanupQueue() {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BackendBase::$queueId protected property The current queue ID.
BackendBase::$time protected property The time.
BackendBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
BackendBase::calculateDependencies public function
BackendBase::cleanupQueue public function Cleans up the queue. Overrides BackendInterface::cleanupQueue 1
BackendBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
BackendBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
BackendBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
BackendBase::getLabel public function Gets the backend label. Overrides BackendInterface::getLabel
BackendBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
BackendBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
BackendBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
BackendBase::__construct public function Constructs a new BackendBase object. Overrides PluginBase::__construct 1
BackendInterface::claimJob public function Claims the next available job for processing. 1
BackendInterface::countJobs public function Gets an estimated number of jobs in the queue. 1
BackendInterface::createQueue public function Creates the queue. 1
BackendInterface::deleteQueue public function Deletes the queue. 1
BackendInterface::enqueueJob public function Enqueues the given job. 1
BackendInterface::enqueueJobs public function Enqueues the given jobs. 1
BackendInterface::onFailure public function Called when job processing has failed. 1
BackendInterface::onSuccess public function Called when a job has been successfully processed. 1
BackendInterface::retryJob public function Retries the given job. 1
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.