You are here

Home » API reference » Webform Scheduled Tasks 8.2 » WebformScheduledTaskInterface.php

interface WebformScheduledTaskInterface in Webform Scheduled Tasks 8.2

An interface for the scheduled tasks.

Hierarchy

Expanded class hierarchy of WebformScheduledTaskInterface

All classes that implement WebformScheduledTaskInterface

8 files declare their use of WebformScheduledTaskInterface
ResultSetPluginBase.php in src/Plugin/WebformScheduledTasks/ResultSetPluginBase.php
ScheduledTaskAwarePluginInterface.php in src/Plugin/WebformScheduledTasks/ScheduledTaskAwarePluginInterface.php
SchedulingState.php in src/SchedulingState.php
SchedulingStateInterface.php in src/SchedulingStateInterface.php
TaskPluginBase.php in src/Plugin/WebformScheduledTasks/TaskPluginBase.php

... See full list

File

src/Entity/WebformScheduledTaskInterface.php, line 10

Namespace

Drupal\webform_scheduled_tasks\Entity
View source 
interface WebformScheduledTaskInterface extends ConfigEntityInterface {

  /**
   * Get the task plugin.
   *
   * @return \Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks\TaskPluginInterface
   *   The task plugin.
   */
  public function getTaskPlugin();

  /**
   * Get the result set plugin.
   *
   * @return \Drupal\webform_scheduled_tasks\Plugin\WebformScheduledTasks\ResultSetPluginInterface
   *   The result set plugin.
   */
  public function getResultSetPlugin();

  /**
   * Get the interval the admin has configured to run the task at.
   *
   * @return int
   *   The interval.
   */
  public function getRunIntervalAmount();

  /**
   * Get a multiplier for the run interval.
   *
   * This is set in instances where admins configure a multiple of a number of
   * seconds to run the task. For example, if they configured to run every 6
   * days, the multiple would 6 x seconds in 1 day.
   *
   * @return int
   *   The multiplier for the run interval.
   */
  public function getRunIntervalMultiplier();

  /**
   * Increment the next task run date by the current time + the run interval.
   */
  public function incrementTaskRunDateByInterval();

  /**
   * Register a successful task run.
   */
  public function registerSuccessfulTask();

  /**
   * Register a failed task run.
   */
  public function registerFailedTask(\Exception $e = NULL);

  /**
   * Get the webform this task is associated with.
   *
   * @return \Drupal\webform\WebformInterface
   *   The associated webform.
   */
  public function getWebform();

  /**
   * Set the date and time the next task is scheduled to be run.
   *
   * NOTE: setting this value will take effect immediately and does not require
   * an entity save.
   *
   * @param int $timestamp
   *   The timestamp for when the task will next be attempted to run.
   *
   * @return $this
   */
  public function setNextTaskRunDate($timestamp);

  /**
   * Halt a scheduled task and provide a reason.
   *
   * NOTE: this will take effect immediately and does not require an entity
   * save.
   *
   * @param string $reason
   *   The reason the task has been halted.
   *
   * @return $this
   */
  public function halt($reason = '');

  /**
   * Resume a schedule.
   *
   * NOTE: this will take effect immediately and does not require an entity
   * save.
   *
   * @return $this
   */
  public function resume();

  /**
   * Check if a task has been halted.
   *
   * @return bool
   *   TRUE if the task was halted, FALSE otherwise.
   */
  public function isHalted();

  /**
   * Get the reason a task was halted.
   *
   * @return string
   *   The reason a task was halted.
   *
   * @throws \Exception
   *   Throws an exception if the task has not been halted.
   */
  public function getHaltedReason();

  /**
   * Get the next run date for the task.
   *
   * @return int
   *   A timestamp for when the task will run next.
   */
  public function getNextTaskRunDate();

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5
WebformScheduledTaskInterface::getHaltedReason public function Get the reason a task was halted. 1
WebformScheduledTaskInterface::getNextTaskRunDate public function Get the next run date for the task. 1
WebformScheduledTaskInterface::getResultSetPlugin public function Get the result set plugin. 1
WebformScheduledTaskInterface::getRunIntervalAmount public function Get the interval the admin has configured to run the task at. 1
WebformScheduledTaskInterface::getRunIntervalMultiplier public function Get a multiplier for the run interval. 1
WebformScheduledTaskInterface::getTaskPlugin public function Get the task plugin. 1
WebformScheduledTaskInterface::getWebform public function Get the webform this task is associated with. 1
WebformScheduledTaskInterface::halt public function Halt a scheduled task and provide a reason. 1
WebformScheduledTaskInterface::incrementTaskRunDateByInterval public function Increment the next task run date by the current time + the run interval. 1
WebformScheduledTaskInterface::isHalted public function Check if a task has been halted. 1
WebformScheduledTaskInterface::registerFailedTask public function Register a failed task run. 1
WebformScheduledTaskInterface::registerSuccessfulTask public function Register a successful task run. 1
WebformScheduledTaskInterface::resume public function Resume a schedule. 1
WebformScheduledTaskInterface::setNextTaskRunDate public function Set the date and time the next task is scheduled to be run. 1