You are here

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

class WebformScheduledTask in Webform Scheduled Tasks 8.2

Same name in this branch
  1. 8.2 src/Annotation/WebformScheduledTask.php \Drupal\webform_scheduled_tasks\Annotation\WebformScheduledTask
  2. 8.2 src/Entity/WebformScheduledTask.php \Drupal\webform_scheduled_tasks\Entity\WebformScheduledTask

Defines the webform schedule entity type.

Plugin annotation


@ConfigEntityType(
  id = "webform_scheduled_task",
  label = @Translation("Scheduled task"),
  label_collection = @Translation("Scheduled tasks"),
  label_singular = @Translation("scheduled task"),
  label_plural = @Translation("scheduled tasks"),
  label_count = @PluralTranslation(
    singular = "@count scheduled task",
    plural = "@count scheduled tasks",
  ),
  handlers = {
    "access" = "\Drupal\Core\Entity\EntityAccessControlHandler",
    "list_builder" = "\Drupal\webform_scheduled_tasks\WebformScheduledTaskListBuilder",
    "form" = {
      "add" = "\Drupal\webform_scheduled_tasks\Form\WebformScheduledTaskForm",
      "edit" = "\Drupal\webform_scheduled_tasks\Form\WebformScheduledTaskForm",
      "delete" = "\Drupal\Core\Entity\EntityDeleteForm",
    },
    "route_provider" = {
      "html" = "Drupal\webform_scheduled_tasks\ScheduledTaskRouteProvider",
    },
  },
  config_prefix = "scheduled_task",
  admin_permission = "administer webform",
  entity_keys = {
    "id" = "id",
    "label" = "label",
  },
  links = {
    "add-form" = "/admin/structure/webform/manage/{webform}/scheduled-tasks/add",
    "edit-form" = "/admin/structure/webform/manage/{webform}/scheduled-tasks/{webform_scheduled_task}/edit",
    "delete-form" = "/admin/structure/webform/manage/scheduled-tasks/{webform_scheduled_task}/delete",
    "collection" = "/admin/structure/webform/manage/{webform}/scheduled-tasks",
  },
  config_export = {
    "id",
    "label",
    "task_type",
    "result_set_type",
    "task_settings",
    "result_set_settings",
    "interval",
    "webform",
  },
)

Hierarchy

Expanded class hierarchy of WebformScheduledTask

16 files declare their use of WebformScheduledTask
AllSubmissionsTest.php in tests/src/Kernel/AllSubmissionsTest.php
EmailedExportTest.php in tests/src/Kernel/EmailedExportTest.php
EmailedExportUiTest.php in tests/src/FunctionalJavascript/EmailedExportUiTest.php
HaltedTasksCheck.php in src/Plugin/HealthzCheck/HaltedTasksCheck.php
HaltedTasksHealthzTest.php in tests/src/Kernel/HaltedTasksHealthzTest.php

... See full list

File

src/Entity/WebformScheduledTask.php, line 59

Namespace

Drupal\webform_scheduled_tasks\Entity
View source 
class WebformScheduledTask extends ConfigEntityBase implements WebformScheduledTaskInterface, EntityWithPluginCollectionInterface {

  /**
   * The ID of the scheduled task.
   *
   * @var string
   */
  protected $id;

  /**
   * The task type.
   *
   * @var string
   */
  protected $task_type;

  /**
   * The result set type.
   *
   * @var string
   */
  protected $result_set_type;

  /**
   * A list of task settings.
   *
   * @var array
   */
  protected $task_settings = [];

  /**
   * A the result set settings.
   *
   * @var array
   */
  protected $result_set_settings = [];

  /**
   * The webform ID the schedule is attached to.
   *
   * @var string
   */
  protected $webform;

  /**
   * The interval values for the task.
   *
   * @var array
   */
  protected $interval = [];

  /**
   * The scheduling state service.
   *
   * @var \Drupal\webform_scheduled_tasks\SchedulingStateInterface
   */
  protected $scheduleState;

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

  /**
   * {@inheritdoc}
   */
  public function getPluginCollections() {
    return [
      'task_settings' => $this
        ->getPluginCollection('plugin.manager.webform_scheduled_tasks.task', $this->task_type, $this->task_settings),
      'result_set_settings' => $this
        ->getPluginCollection('plugin.manager.webform_scheduled_tasks.result_set', $this->result_set_type, $this->result_set_settings),
    ];
  }

  /**
   * Get a plugin collection from a manager, type and settings.
   *
   * @return \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection|null
   *   A collection, or NULL if none is instantiable yet.
   */
  protected function getPluginCollection($plugin_manager, $type, $settings) {

    // Plugin collections must be stored as a single root property on the entity
    // so that the serialization traits unset it correctly.
    $key = 'plugin_collection_' . $type;
    if (empty($this->{$key}) && !empty($type)) {
      $this->{$key} = new DefaultSingleLazyPluginCollection(\Drupal::service($plugin_manager), $type, $settings);
    }
    return !empty($this->{$key}) ? $this->{$key} : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getTaskPlugin() {
    return $this
      ->getPluginCollections()['task_settings']
      ->get($this->task_type)
      ->setScheduledTask($this);
  }

  /**
   * {@inheritdoc}
   */
  public function getResultSetPlugin() {
    return $this
      ->getPluginCollections()['result_set_settings']
      ->get($this->result_set_type)
      ->setScheduledTask($this);
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) {
    return parent::urlRouteParameters($rel) + [
      'webform' => $this->webform,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getRunIntervalAmount() {
    return isset($this->interval['amount']) ? $this->interval['amount'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getRunIntervalMultiplier() {
    return isset($this->interval['multiplier']) ? $this->interval['multiplier'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function registerSuccessfulTask() {
    $this
      ->getResultSetPlugin()
      ->onSuccess($this
      ->getWebform());
    $this
      ->getTaskPlugin()
      ->onSuccess($this
      ->getWebform());
  }

  /**
   * {@inheritdoc}
   */
  public function registerFailedTask(\Exception $e = NULL) {
    $this
      ->getResultSetPlugin()
      ->onFailure($this
      ->getWebform());
    $this
      ->getTaskPlugin()
      ->onFailure($this
      ->getWebform());
  }

  /**
   * {@inheritdoc}
   */
  public function setNextTaskRunDate($timestamp) {
    $this
      ->getScheduleState()
      ->setNextScheduledTime($this, $timestamp);
    return $this;
  }

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

    // If this task has not had a time scheduled and we have set both run
    // intervals, initialize the next run date of the task, to ensure this
    // method always return something usable in a scheduling context.
    if (!$this
      ->getScheduleState()
      ->hasTimeScheduled($this) && $this
      ->getRunIntervalMultiplier() !== NULL && $this
      ->getRunIntervalAmount() !== NULL) {
      $this
        ->incrementTaskRunDateByInterval();
    }
    return $this
      ->getScheduleState()
      ->getNextScheduledTime($this);
  }

  /**
   * {@inheritdoc}
   */
  public function incrementTaskRunDateByInterval() {
    $this
      ->setNextTaskRunDate($this
      ->getTime()
      ->getRequestTime() + $this
      ->getRunIntervalMultiplier() * $this
      ->getRunIntervalAmount());
  }

  /**
   * {@inheritdoc}
   */
  public function getWebform() {
    return Webform::load($this->webform);
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();
    $this
      ->addDependency($this
      ->getWebform()
      ->getConfigDependencyKey(), $this
      ->getWebform()
      ->getConfigDependencyName());
    return $this;
  }

  /**
   * Get the schedule state service.
   *
   * @return \Drupal\webform_scheduled_tasks\SchedulingStateInterface
   *   The state service.
   */
  protected function getScheduleState() {
    if (!isset($this->scheduleState)) {
      $this->scheduleState = \Drupal::service('webform_scheduled_tasks.scheduling_state');
    }
    return $this->scheduleState;
  }

  /**
   * Get the time service.
   *
   * @return \Drupal\Component\Datetime\TimeInterface
   *   The time service.
   */
  protected function getTime() {
    if (!isset($this->time)) {
      $this->time = \Drupal::service('datetime.time');
    }
    return $this->time;
  }

  /**
   * {@inheritdoc}
   */
  public function halt($reason = '') {
    $this
      ->getScheduleState()
      ->haltTask($this, $reason);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function resume() {
    $this
      ->getScheduleState()
      ->resumeTask($this);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isHalted() {
    return $this
      ->getScheduleState()
      ->isHalted($this);
  }

  /**
   * {@inheritdoc}
   */
  public function getHaltedReason() {
    return $this
      ->getScheduleState()
      ->getHaltedMessage($this);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
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 Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
WebformScheduledTask::$id protected property The ID of the scheduled task.
WebformScheduledTask::$interval protected property The interval values for the task.
WebformScheduledTask::$result_set_settings protected property A the result set settings.
WebformScheduledTask::$result_set_type protected property The result set type.
WebformScheduledTask::$scheduleState protected property The scheduling state service.
WebformScheduledTask::$task_settings protected property A list of task settings.
WebformScheduledTask::$task_type protected property The task type.
WebformScheduledTask::$time protected property The time service.
WebformScheduledTask::$webform protected property The webform ID the schedule is attached to.
WebformScheduledTask::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
WebformScheduledTask::getHaltedReason public function Get the reason a task was halted. Overrides WebformScheduledTaskInterface::getHaltedReason
WebformScheduledTask::getNextTaskRunDate public function Get the next run date for the task. Overrides WebformScheduledTaskInterface::getNextTaskRunDate
WebformScheduledTask::getPluginCollection protected function Get a plugin collection from a manager, type and settings.
WebformScheduledTask::getPluginCollections public function Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
WebformScheduledTask::getResultSetPlugin public function Get the result set plugin. Overrides WebformScheduledTaskInterface::getResultSetPlugin
WebformScheduledTask::getRunIntervalAmount public function Get the interval the admin has configured to run the task at. Overrides WebformScheduledTaskInterface::getRunIntervalAmount
WebformScheduledTask::getRunIntervalMultiplier public function Get a multiplier for the run interval. Overrides WebformScheduledTaskInterface::getRunIntervalMultiplier
WebformScheduledTask::getScheduleState protected function Get the schedule state service.
WebformScheduledTask::getTaskPlugin public function Get the task plugin. Overrides WebformScheduledTaskInterface::getTaskPlugin
WebformScheduledTask::getTime protected function Get the time service.
WebformScheduledTask::getWebform public function Get the webform this task is associated with. Overrides WebformScheduledTaskInterface::getWebform
WebformScheduledTask::halt public function Halt a scheduled task and provide a reason. Overrides WebformScheduledTaskInterface::halt
WebformScheduledTask::incrementTaskRunDateByInterval public function Increment the next task run date by the current time + the run interval. Overrides WebformScheduledTaskInterface::incrementTaskRunDateByInterval
WebformScheduledTask::isHalted public function Check if a task has been halted. Overrides WebformScheduledTaskInterface::isHalted
WebformScheduledTask::registerFailedTask public function Register a failed task run. Overrides WebformScheduledTaskInterface::registerFailedTask
WebformScheduledTask::registerSuccessfulTask public function Register a successful task run. Overrides WebformScheduledTaskInterface::registerSuccessfulTask
WebformScheduledTask::resume public function Resume a schedule. Overrides WebformScheduledTaskInterface::resume
WebformScheduledTask::setNextTaskRunDate public function Set the date and time the next task is scheduled to be run. Overrides WebformScheduledTaskInterface::setNextTaskRunDate
WebformScheduledTask::urlRouteParameters protected function Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters