class HaltExceptionTask in Webform Scheduled Tasks 8.2

A test plugin that throws an exception.

Plugin annotation

@WebformScheduledTask(
  id = "halt_exception_task",
  label = @Translation("Retry exception"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks\TaskPluginBase implements TaskPluginInterface
      • class \Drupal\webform_scheduled_tasks_test_types\Plugin\WebformScheduledTasks\Task\HaltExceptionTask

File

tests/modules/webform_scheduled_tasks_test_types/src/Plugin/WebformScheduledTasks/Task/HaltExceptionTask.php, line 16

Namespace

Drupal\webform_scheduled_tasks_test_types\Plugin\WebformScheduledTasks\Task

class HaltExceptionTask extends TaskPluginBase {

  /**
   * {@inheritdoc}
   */
  public function executeTask(\Iterator $submissions) {
    \Drupal::messenger()
      ->addStatus('Run halt_exception_task ::executeTask');
    throw new HaltScheduledTaskException('Something went terribly wrong.');
  }

  /**
   * {@inheritdoc}
   */
  public function onSuccess() {
    \Drupal::messenger()
      ->addStatus('Run halt_exception_task ::onSuccess');
  }

  /**
   * {@inheritdoc}
   */
  public function onFailure() {
    \Drupal::messenger()
      ->addStatus('Run halt_exception_task ::onFailure');
  }

}

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
HaltExceptionTask::executeTask	public	function	Execute a task. Overrides TaskPluginInterface::executeTask
HaltExceptionTask::onFailure	public	function	Called when a task fails. Overrides TaskPluginBase::onFailure
HaltExceptionTask::onSuccess	public	function	Called when a task is successful. Overrides TaskPluginBase::onSuccess
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.
TaskPluginBase::$scheduledTask	protected	property	The scheduled task this task is attached to.
TaskPluginBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
TaskPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
TaskPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	2
TaskPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
TaskPluginBase::getScheduledTask	public	function	Get the scheduled task. Overrides ScheduledTaskAwarePluginInterface::getScheduledTask
TaskPluginBase::label	public	function	Get the label of the task. Overrides TaskPluginInterface::label
TaskPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
TaskPluginBase::setScheduledTask	public	function	Set the scheduled task as context for this plugin. Overrides ScheduledTaskAwarePluginInterface::setScheduledTask
TaskPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
TaskPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
TaskPluginBase::__construct	public	function	TaskPluginBase constructor. Overrides PluginBase::__construct	1