class WebformScheduledEmailCommands in Webform 8.5

Webform scheduled email commands for Drush 9.x.

Hierarchy

• class \Drupal\webform_scheduled_email\Commands\WebformScheduledEmailCommands extends \Drush\Commands\DrushCommands

1 string reference to 'WebformScheduledEmailCommands'

drush.services.yml in modules/webform_scheduled_email/drush.services.yml

modules/webform_scheduled_email/drush.services.yml

1 service uses WebformScheduledEmailCommands

webform_scheduled_email.manager.commands in modules/webform_scheduled_email/drush.services.yml

\Drupal\webform_scheduled_email\Commands\WebformScheduledEmailCommands

File

modules/webform_scheduled_email/src/Commands/WebformScheduledEmailCommands.php, line 14

Namespace

Drupal\webform_scheduled_email\Commands

class WebformScheduledEmailCommands extends DrushCommands {

  /**
   * The webform scheduled email manager.
   *
   * @var \Drupal\webform_scheduled_email\WebformScheduledEmailManagerInterface
   */
  protected $manager;

  /**
   * Constructs a WebformScheduledEmailController object.
   *
   * @param \Drupal\webform_scheduled_email\WebformScheduledEmailManagerInterface $manager
   *   The webform scheduled email manager.
   */
  public function __construct(WebformScheduledEmailManagerInterface $manager) {
    parent::__construct();
    $this->manager = $manager;
  }

  /**
   * @hook validate webform:scheduled-email:cron
   */
  public function drush_webform_scheduled_email_cron_validate(CommandData $commandData) {
    $arguments = $commandData
      ->arguments();
    $webform_id = $arguments['webform_id'];
    $handler_id = $arguments['handler_id'];

    // Get and validate optional $webform_id parameter.
    $webform = NULL;
    if ($webform_id) {
      $webform = Webform::load($webform_id);
      if (!$webform) {
        throw new \Exception(dt('Webform @id not recognized.', [
          '@id' => $webform_id,
        ]));
      }
    }

    // Get and validate optional $handler_id parameter.
    if ($handler_id) {
      try {
        $handler = $webform
          ->getHandler($handler_id);
      } catch (\Exception $exception) {
        throw new \Exception(dt('Handler @id not recognized.', [
          '@id' => $handler_id,
        ]));
      }
      if (!$handler instanceof ScheduleEmailWebformHandler) {
        throw new \Exception(dt('Handler @id is not a scheduled email handler.', [
          '@id' => $handler_id,
        ]));
      }
    }
  }

  /**
   * Executes cron task for webform scheduled emails.
   *
   * @command webform:scheduled-email:cron
   * @param $webform_id (optional)
   *   The webform ID you want the cron task to be executed for
   * @param $handler_id (optional)
   *   The handler ID you want the cron task to be executed for
   * @option schedule_limit
   *   The maximum number of emails to be scheduled. If set to 0 no emails will be scheduled. (Default 1000)
   * @option send_limit
   *   The maximum number of emails to be sent. If set to 0 no emails will be sent. (Default 500)
   * @aliases wfsec,webform-scheduled-email-cron
   *
   * @see webform_scheduled_email_cron_process()
   */
  public function drush_webform_scheduled_email_cron($webform_id = NULL, $handler_id = NULL, array $options = [
    'schedule_limit' => 1000,
    'send_limit' => 500,
  ]) {
    $webform = $webform_id ? Webform::load($webform_id) : NULL;
    $stats = $this->manager
      ->cron($webform, $handler_id, $options['schedule_limit'], $options['send_limit']);
    $this
      ->output()
      ->writeln(dt($stats['_message'], $stats['_context']));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
WebformScheduledEmailCommands::$manager	protected	property	The webform scheduled email manager.
WebformScheduledEmailCommands::drush_webform_scheduled_email_cron	public	function	Executes cron task for webform scheduled emails.
WebformScheduledEmailCommands::drush_webform_scheduled_email_cron_validate	public	function	@hook validate webform:scheduled-email:cron
WebformScheduledEmailCommands::__construct	public	function	Constructs a WebformScheduledEmailController object.