class Test in Entityqueue 8

Defines an entity queue handler for testing.

Plugin annotation

@EntityQueueHandler(
  id = "test",
  title = @Translation("Test handler")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\entityqueue\EntityQueueHandlerBase implements EntityQueueHandlerInterface uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\entityqueue_test\Plugin\EntityQueueHandler\Test

File

tests/modules/entityqueue_test/src/Plugin/EntityQueueHandler/Test.php, line 16

Namespace

Drupal\entityqueue_test\Plugin\EntityQueueHandler

class Test extends EntityQueueHandlerBase {

  /**
   * {@inheritdoc}
   */
  public function supportsMultipleSubqueues() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function hasAutomatedSubqueues() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'shape' => 'round',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['shape'] = [
      '#type' => 'textfield',
      '#title' => 'Shape',
      '#default_value' => $this->configuration['shape'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('shape') === 'square') {
      $form_state
        ->setErrorByName('shape', $this
        ->t('The shape can not be square.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['shape'] = $form_state
      ->getValue('shape');
  }

}

Members

Name	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::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
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::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	2
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.
Test::buildConfigurationForm	public	function	Form constructor. Overrides EntityQueueHandlerBase::buildConfigurationForm
Test::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides EntityQueueHandlerBase::defaultConfiguration
Test::hasAutomatedSubqueues	public	function	Whether or not the handler contains subqueues with an automated lifecycle. Overrides EntityQueueHandlerInterface::hasAutomatedSubqueues
Test::submitConfigurationForm	public	function	Form submission handler. Overrides EntityQueueHandlerBase::submitConfigurationForm
Test::supportsMultipleSubqueues	public	function	Whether or not the handler supports multiple subqueues. Overrides EntityQueueHandlerInterface::supportsMultipleSubqueues
Test::validateConfigurationForm	public	function	Form validation handler. Overrides EntityQueueHandlerBase::validateConfigurationForm