class RngCron in RNG - Events and Registrations 3.x

RNG Cron.

Hierarchy

• class \Drupal\rng\RngCron

1 string reference to 'RngCron'

rng.services.yml in ./rng.services.yml

rng.services.yml

1 service uses RngCron

rng.cron in ./rng.services.yml

Drupal\rng\RngCron

File

src/RngCron.php, line 12

Namespace

Drupal\rng

class RngCron {

  /**
   * Queue for rule scheduler.
   *
   * @var \Drupal\Core\Queue\QueueInterface
   */
  protected $ruleSchedulerQueue;

  /**
   * Storage for rule scheduler entities.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $ruleSchedulerStorage;

  /**
   * Constructs a new RngEntityModel object.
   *
   * @param \Drupal\Core\Queue\QueueFactory $queue_factory
   *   The queue service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(QueueFactory $queue_factory, EntityTypeManagerInterface $entity_type_manager) {
    $this->ruleSchedulerQueue = $queue_factory
      ->get('rng_rule_scheduler', FALSE);
    $this->ruleSchedulerStorage = $entity_type_manager
      ->getStorage('rng_rule_scheduler');
  }

  /**
   * React to Drupal `hook_cron` hooks.
   *
   * @see hook_cron();
   */
  public function hook_cron() {
    $this
      ->scheduleRules();
    $this
      ->deleteScheduleRules();
  }

  /**
   * Add scheduled rules to be executed to the queue.
   */
  protected function scheduleRules() {
    $ids = $this->ruleSchedulerStorage
      ->getQuery()
      ->condition('trigger_date', time(), '<=')
      ->condition('in_queue', 0, '=')
      ->condition('attempts', RuleSchedule::ATTEMPTS_MAX, '<=')
      ->execute();

    /** @var \Drupal\rng\Entity\RuleScheduleInterface[] $rule_schedules */
    $rule_schedules = $this->ruleSchedulerStorage
      ->loadMultiple($ids);
    foreach ($rule_schedules as $rule_schedule) {
      $data = [
        'rule_scheduler_id' => $rule_schedule
          ->id(),
      ];
      if ($this->ruleSchedulerQueue
        ->createItem($data)) {
        $rule_schedule
          ->setInQueue(TRUE)
          ->save();

        // De-activate the rule once it is queued.
        if ($component = $rule_schedule
          ->getComponent()) {
          if ($rule = $component
            ->getRule()) {
            $rule
              ->setIsActive(FALSE)
              ->save();
          }
        }
      }
    }
  }

  /**
   * Delete scheduled rules which have had too many attempts.
   */
  protected function deleteScheduleRules() {
    $ids = $this->ruleSchedulerStorage
      ->getQuery()
      ->condition('attempts', RuleSchedule::ATTEMPTS_MAX, '>')
      ->execute();

    /** @var \Drupal\rng\Entity\RuleScheduleInterface[] $rule_schedules */
    $rule_schedules = $this->ruleSchedulerStorage
      ->loadMultiple($ids);
    $this->ruleSchedulerStorage
      ->delete($rule_schedules);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RngCron::$ruleSchedulerQueue	protected	property	Queue for rule scheduler.
RngCron::$ruleSchedulerStorage	protected	property	Storage for rule scheduler entities.
RngCron::deleteScheduleRules	protected	function	Delete scheduled rules which have had too many attempts.
RngCron::hook_cron	public	function	React to Drupal `hook_cron` hooks.
RngCron::scheduleRules	protected	function	Add scheduled rules to be executed to the queue.
RngCron::__construct	public	function	Constructs a new RngEntityModel object.