Job.php

<?php
/*-------------------------------------------------------+
| SYSTOPIA - MORE GREETINGS EXTENSION                    |
| Copyright (C) 2017 SYSTOPIA                            |
| Author: B. Endres (endres@systopia.de)                 |
|         P. Batroff (batroff@systopia.de)               |
| http://www.systopia.de/                                |
+--------------------------------------------------------+
| This program is released as free software under the    |
| Affero GPL license. You can redistribute it and/or     |
| modify it under the terms of this license which you    |
| can read by viewing the included agpl.txt or online    |
| at www.gnu.org/licenses/agpl.html. Removal of this     |
| copyright header is strictly prohibited without        |
| written permission from the original author(s).        |
+--------------------------------------------------------*/

use Civi\Api4\Contact;

define('MOREGREETINGS_JOB_SIZE', 250);
/**
 * Runner Job to apply the current templates to all contacts
 */
class CRM_Moregreetings_Job {

  public $title     = NULL;
  protected $offset = NULL;
  protected $count  = NULL;


  protected function __construct($offset, $count) {
    $this->offset  = $offset;
    $this->count   = $count;

    // set title
    $this->title = ts("Updating moregreetings on contacts %1-%2", array(
          1 => $this->offset, 2 => $this->offset + $this->count, 'domain' => 'de.systopia.moregreetings'));
  }

  public function run($context) {
    // get contact IDs
    $id_query = CRM_Core_DAO::executeQuery("
      SELECT id AS contact_id
      FROM civicrm_contact
      WHERE is_deleted = 0
      LIMIT {$this->count}
      OFFSET {$this->offset}");
    $contact_ids = array();
    while($id_query->fetch()) {
      $contact_ids[] = $id_query->contact_id;
    }

    // determine the fields to load
    $templates = Civi::settings()->get('moregreetings_templates');
    $used_fields = CRM_Moregreetings_Renderer::getUsedContactFields($templates);

    // load contacts
    // remark: if you change these parameters, see if you also want to adjust
    //  CRM_Moregreetings_Renderer::updateMoreGreetings and CRM_Moregreetings_Renderer::updateMoreGreetingsForContacts
    $contacts = Contact::get(FALSE)
      ->setSelect($used_fields)
      ->addSelect('id')
      ->addWhere('id', 'IN', $contact_ids)
      ->execute();

    // apply
    foreach ($contacts as $contact) {
      CRM_Moregreetings_Renderer::updateMoreGreetings($contact['id'], $contact);
    }

    return TRUE;
  }

  /**
   * Use CRM_Queue_Runner to apply the templates
   * This doesn't return, but redirects to the runner
   */
  public static function launchApplicationRunner() {
    // get general contact count (not deleted)
    $contact_count = CRM_Core_DAO::singleValueQuery("SELECT COUNT(id) FROM civicrm_contact WHERE is_deleted=0");

    // create a queue
    $queue = CRM_Queue_Service::singleton()->create(array(
      'type'  => 'Sql',
      'name'  => 'moregreetings_application',
      'reset' => TRUE,
    ));

    // create the items
    for ($offset=0; $offset < $contact_count; $offset += MOREGREETINGS_JOB_SIZE) {
      $queue->createItem(new CRM_Moregreetings_Job($offset, MOREGREETINGS_JOB_SIZE));
    }

    // create a runner and launch it
    $runner = new CRM_Queue_Runner(array(
      'title'     => ts("Applying Moregreetings Templates", array('domain' => 'de.systopia.moregreetings')),
      'queue'     => $queue,
      'errorMode' => CRM_Queue_Runner::ERROR_ABORT,
      'onEndUrl'  => CRM_Utils_System::url('civicrm/admin/setting/moregreetings', "reset=1"),
    ));
    $runner->runAllViaWeb(); // does not return
  }
}