Issue #1867662 by marvil07, wesleydv: Port cron_example to D8.

name: Cron example

type: module

description: 'Demonstrates hook_cron() and related features'

package: Example modules

core: 8.x

<?php

/**

 * @file

 *   Demonstrates use of the Cron API in Drupal - hook_cron().

 */

/**

 * @defgroup cron_example Example: Cron

 * @ingroup examples

 * @{

 * Example using Cron API, including hook_cron() and hook_queue_info().

 *

 * This example is part of the Examples for Developers Project

 * which you can download and experiment with at

 * http://drupal.org/project/examples

 */

/**

 * Implements hook_cron().

 *

 * hook_cron() is the traditional (pre-Drupal 7) hook for doing "background"

 * processing. It gets called every time the Drupal cron runs and must decide

 * what it will do.

 *

 * In this example, it does a watchdog() call after the time named in

 * the variable 'cron_example_next_execution' has arrived, and then it

 * resets that variable to a time in the future.

 */

function cron_example_cron() {

  $config = Drupal::config('examples.cron');

  // Default to an hourly interval. Of course, cron has to be running at least

  // hourly for this to work.

  $interval = $config->get('interval');

  $interval = !empty($interval) ? $interval : 3600;

  // We usually don't want to act every time cron runs (which could be every

  // minute) so keep a time for the next run in a variable.

  $next_execution = $config->get('next_execution');

  $next_execution = !empty($next_execution) ? $next_execution : 0;

  if (time() >= $next_execution) {

    // This is a silly example of a cron job.

    // It just makes it obvious that the job has run without

    // making any changes to your database.

    watchdog('cron_example', 'cron_example ran');

    if (!empty($GLOBALS['cron_example_show_status_message'])) {

      drupal_set_message(t('cron_example executed at %time', array('%time' => date_iso8601(time()))));

    }

    $config->set('next_execution', time() + $interval)->save();

  }

}

/**

 * Implements hook_queue_info().

 *

 * hook_queue_info() and family are new since Drupal 7, and allow any

 * process to add work to the queue to be acted on when cron runs. Queues are

 * described and worker callbacks are provided, and then only the worker

 * callback needs to be implemented.

 *

 * All the details of queue use are done by the cron_queue implementation, so

 * one doesn't need to know much about DrupalQueue().

 *

 * @see queue_example.module

 */

function cron_example_queue_info() {

  $queues['cron_example_queue_1'] = array(

    'worker callback' => 'cron_example_queue_1_worker',

    'cron' => array(

      // One second max runtime per cron run.

      'time' => 1,

    ),

  );

  $queues['cron_example_queue_2'] = array(

    'worker callback' => 'cron_example_queue_2_worker',

    'cron' => array(

      'time' => 20,

    ),

  );

  return $queues;

}

/**

 * Queue worker for Queue 1.

 *

 * @param $item

 *   Any object to be worked on.

 */

function cron_example_queue_1_worker($item) {

  cron_example_queue_report_work(1, $item);

}

/**

 * Queue worker for Queue 2.

 *

 * @param $item

 *   Any object to be worked on.

 */

function cron_example_queue_2_worker($item) {

  cron_example_queue_report_work(2, $item);

}

/**

 * Simple reporter for the workers.

 *

 * @param $worker

 *   (integer) worker number

 * @param $item

 *   (object) the $item which was stored in the cron queue.

 */

function cron_example_queue_report_work($worker, $item) {

  if (!empty($GLOBALS['cron_example_show_status_message'])) {

    drupal_set_message(t('Queue @worker worker processed item with sequence @sequence created at @time', array('@worker' => $worker, '@sequence' => $item->sequence, '@time' => date_iso8601($item->created))));

  }

  watchdog('cron_example', 'Queue @worker worker processed item with sequence @sequence created at @time', array('@worker' => $worker, '@sequence' => $item->sequence, '@time' => date_iso8601($item->created)));

}

/**

 * @} End of "defgroup cron_example".

 */

cron_example:

  pattern: 'examples/cron_example'

  defaults:

    _form: '\Drupal\cron_example\Forms\CronExampleForm'

  requirements:

    _access: 'TRUE'

<?php

/**

 * @file

 * Contains \Drupal\cron_example\Form\CronExampleForm

 */

namespace Drupal\cron_example\Forms;

use Drupal\system\SystemConfigFormBase;

/**

 * Form with examples on how to use cron.

 */

class CronExampleForm extends SystemConfigFormBase {

  /**

   * {@inheritdoc}

   */

  public function getFormID() {

    return 'cron_example';

  }

  /**

   * {@inheritdoc}

   */

  public function buildForm(array $form, array &$form_state) {

    $config = $this->configFactory->get('examples.cron');

    $form['status'] = array(

      '#type' => 'fieldset',

      '#title' => t('Cron status information'),

    );

    $form['status']['intro'] = array(

      '#type' => 'item',

      '#markup' => t('The cron example demonstrates hook_cron() and hook_queue_info() processing. If you have administrative privileges you can run cron from this page and see the results.'),

    );

    $next_execution = $config->get('next_execution');

    $next_execution = !empty($next_execution) ? $next_execution : time();

    $args = array(

      '%time' => date_iso8601($config->get('next_execution')),

      '%seconds' => $next_execution - time(),

    );

    $form['status']['last'] = array(

      '#type' => 'item',

      '#markup' => t('cron_example_cron() will next execute the first time cron runs after %time (%seconds seconds from now)', $args),

    );

    if (user_access('administer site configuration')) {

      $form['cron_run'] = array(

        '#type' => 'fieldset',

        '#title' => t('Run cron manually'),

      );

      $form['cron_run']['cron_reset'] = array(

        '#type' => 'checkbox',

        '#title' => t("Run cron_example's cron regardless of whether interval has expired."),

        '#default_value' => FALSE,

      );

      $form['cron_run']['cron_trigger'] = array(

        '#type' => 'submit',

        '#value' => t('Run cron now'),

        '#submit' => array(array($this, 'cronRun')),

      );

    }

    $form['cron_queue_setup'] = array(

      '#type' => 'fieldset',

      '#title' => t('Cron queue setup (for hook_cron_queue_info(), etc.)'),

    );

    $queue_1 = \Drupal::queue('cron_example_queue_1');

    $queue_2 = \Drupal::queue('cron_example_queue_2');

    $args = array(

      '%queue_1' => $queue_1->numberOfItems(),

      '%queue_2' => $queue_2->numberOfItems(),

    );

    $form['cron_queue_setup']['current_cron_queue_status'] = array(

      '#type' => 'item',

      '#markup' => t('There are currently %queue_1 items in queue 1 and %queue_2 items in queue 2', $args),

    );

    $form['cron_queue_setup']['num_items'] = array(

      '#type' => 'select',

      '#title' => t('Number of items to add to queue'),

      '#options' => drupal_map_assoc(array(1, 5, 10, 100, 1000)),

      '#default_value' => 5,

    );

    $form['cron_queue_setup']['queue'] = array(

      '#type' => 'radios',

      '#title' => t('Queue to add items to'),

      '#options' => array(

        'cron_example_queue_1' => t('Queue 1'),

        'cron_example_queue_2' => t('Queue 2'),

      ),

      '#default_value' => 'cron_example_queue_1',

    );

    $form['cron_queue_setup']['submit'] = array(

      '#type' => 'submit',

      '#value' => t('Add jobs to queue'),

      '#submit' => array(array($this, 'addItems')),

    );

    $form['configuration'] = array(

      '#type' => 'fieldset',

      '#title' => t('Configuration of cron_example_cron()'),

    );

    $form['configuration']['cron_example_interval'] = array(

      '#type' => 'select',

      '#title' => t('Cron interval'),

      '#description' => t('Time after which cron_example_cron will respond to a processing request.'),

      '#default_value' => $config->get('interval'),

      '#options' => array(

        60 => t('1 minute'),

        300 => t('5 minutes'),

        3600 => t('1 hour'),

        86400 => t('1 day'),

      ),

    );

    return parent::buildForm($form, $form_state);

  }

  /**

   * Allow user to directly execute cron, optionally forcing it.

   */

  public function cronRun(array &$form, array &$form_state) {

    $config = $this->configFactory->get('examples.cron');

    if (!empty($form_state['values']['cron_reset'])) {

      $config->set('next_execution', 0);

    }

    // We don't usually use globals in this way. This is used here only to

    // make it easy to tell if cron was run by this form.

    $GLOBALS['cron_example_show_status_message'] = TRUE;

    if (drupal_cron_run()) {

      drupal_set_message(t('Cron ran successfully.'));

    }

    else {

      drupal_set_message(t('Cron run failed.'), 'error');

    }

  }

  /**

   * Add the items to the queue when signaled by the form.

   */

  public function addItems(array &$form, array &$form_state) {

    $queue = $form_state['values']['queue'];

    $queue_name = $form['cron_queue_setup']['queue'][$queue]['#title'];

    $num_items = $form_state['values']['num_items'];

    $queue = \Drupal::queue($queue);

    for ($i=1; $i <= $num_items; $i++) {

      $item = new \stdClass();

      $item->created = time();

      $item->sequence = $i;

      $queue->createItem($item);

    }

    $args = array(

      '%num' => $num_items,

      '%queue' => $queue_name,

    );

    drupal_set_message(t('Added %num items to %queue', $args));

  }

  /**

   * {@inheritdoc}

   */

  public function submitForm(array &$form, array &$form_state) {

    $this->configFactory->get('examples.cron')

      ->set('interval', $form_state['values']['cron_example_interval'])

      ->save();

    parent::submitForm($form, $form_state);

  }

}

<?php

/**

 * @file

 * Test case for testing the cron example module.

 */

/**

 * @addtogroup cron_example

 * @{

 */

namespace Drupal\cron_example\Tests;

use Drupal\simpletest\WebTestBase;

/**

 * cron_example test class

 */

class CronExampleTestCase extends WebTestBase {

  public static $modules = array('cron_example');

  protected $web_user;

  public static function getInfo() {

    return array(

      'name' => 'Cron example functionality',

      'description' => 'Test the functionality of the Cron Example.',

      'group' => 'Examples',

    );

  }

  /**

   * Enable modules and create user with specific permissions.

   */

  function setUp() {

    parent::setUp();

    // Create user. Search content permission granted for the search block to

    // be shown.

    $this->web_user = $this->drupalCreateUser(array('administer site configuration'));

    $this->drupalLogin($this->web_user);

  }

  /**

   * Login user, create an example node, and test block functionality through

   * the admin and user interfaces.

   */

  function testCronExampleBasic() {

    // Pretend that cron has never been run (even though simpletest seems to

    // run it once...)

    variable_set('cron_example_next_execution', 0);

    $this->drupalGet('examples/cron_example');

    // Initial run should cause cron_example_cron() to fire.

    $post = array();

    $this->drupalPost('examples/cron_example', $post, t('Run cron now'));

    $this->assertText(t('cron_example executed at'));

    // Forcing should also cause cron_example_cron() to fire.

    $post['cron_reset'] = TRUE;

    $this->drupalPost(NULL, $post, t('Run cron now'));

    $this->assertText(t('cron_example executed at'));

    // But if followed immediately and not forced, it should not fire.

    $post['cron_reset'] = FALSE;

    $this->drupalPost(NULL, $post, t('Run cron now'));

    $this->assertNoText(t('cron_example executed at'));

    $this->assertText(t('There are currently 0 items in queue 1 and 0 items in queue 2'));

    $post = array(

      'num_items' => 5,

      'queue' => 'cron_example_queue_1',

    );

    $this->drupalPost(NULL, $post, t('Add jobs to queue'));

    $this->assertText('There are currently 5 items in queue 1 and 0 items in queue 2');

    $post = array(

      'num_items' => 100,

      'queue' => 'cron_example_queue_2',

    );

    $this->drupalPost(NULL, $post, t('Add jobs to queue'));

    $this->assertText('There are currently 5 items in queue 1 and 100 items in queue 2');

    $post = array();

    $this->drupalPost('examples/cron_example', $post, t('Run cron now'));

    $this->assertPattern('/Queue 1 worker processed item with sequence 5 /');

    $this->assertPattern('/Queue 2 worker processed item with sequence 100 /');

  }

}

/**

 * @} End of "addtogroup cron_example".

 */