public function WebformScheduledTask::halt in Webform Scheduled Tasks 8.2

Halt a scheduled task and provide a reason.

NOTE: this will take effect immediately and does not require an entity save.

Parameters

string $reason: The reason the task has been halted.

Return value

$this

Overrides WebformScheduledTaskInterface::halt

File

src/Entity/WebformScheduledTask.php, line 280

Class

WebformScheduledTask

Defines the webform schedule entity type.

Namespace

Drupal\webform_scheduled_tasks\Entity

Code

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