interface TaskPluginInterface in Webform Scheduled Tasks 8.2

An interface for scheduled tasks.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks\ScheduledTaskNotifyInterface; interface \Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks\ScheduledTaskAwarePluginInterface
  • interface \Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks\TaskPluginInterface

2 files declare their use of TaskPluginInterface

TaskRunnerTest.php in tests/src/Unit/TaskRunnerTest.php

WebformScheduledTaskManager.php in src/WebformScheduledTaskManager.php

File

src/Plugin/WebformScheduledTasks/TaskPluginInterface.php, line 13

Namespace

Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks

interface TaskPluginInterface extends PluginInspectionInterface, PluginFormInterface, ConfigurableInterface, DependentPluginInterface, ScheduledTaskNotifyInterface, ScheduledTaskAwarePluginInterface {

  /**
   * Execute a task.
   *
   * @param \Iterator $submissions
   *   An iterator of webform submissions to process.
   *
   * @throws \Exception
   * @throws \Drupal\webform_scheduled_tasks\Exception\RetryScheduledTaskException
   * @throws \Drupal\webform_scheduled_tasks\Exception\HaltScheduledTaskException
   */
  public function executeTask(\Iterator $submissions);

  /**
   * Get the label of the task.
   *
   * @return string
   *   The label of the task.
   */
  public function label();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
ScheduledTaskAwarePluginInterface::getScheduledTask	public	function	Get the scheduled task.	2
ScheduledTaskAwarePluginInterface::setScheduledTask	public	function	Set the scheduled task as context for this plugin.	2
ScheduledTaskNotifyInterface::onFailure	public	function	Called when a task fails.	2
ScheduledTaskNotifyInterface::onSuccess	public	function	Called when a task is successful.	2
TaskPluginInterface::executeTask	public	function	Execute a task.	4
TaskPluginInterface::label	public	function	Get the label of the task.	1