job_scheduler.api.php in Job Scheduler 8.3

API documentation for hooks.

File

job_scheduler.api.php

<?php

/**
 * @file
 * API documentation for hooks.
 */

/**
 * Declare job scheduling holding items that need to be run periodically.
 *
 * @return array
 *   An associative array where the key is the queue name and the value is
 *   again an associative array. Possible keys are:
 *   - 'worker callback': The name of the function to call. It will be called
 *     at schedule time.
 *   - 'queue name': The name of the queue to use to queue this task. Must
 *     contain a valid queue name, declared by hook_cron_queue_info().
 *   If queue name is given, worker callback will be ignored.
 *
 * @see hook_cron_job_scheduler_info_alter()
 * @see hook_cron_queue_info()
 * @see hook_cron_queue_info_alter()
 */
function hook_cron_job_scheduler_info() {
  $info = [];
  $info['example_reset'] = [
    'worker callback' => 'example_cache_clear_worker',
  ];
  $info['example_import'] = [
    'worker callback' => 'example_import_worker',
    'queue name' => 'example_import_queue',
  ];
  return $info;
}

/**
 * Alter cron queue information before cron runs.
 *
 * Called by drupal_cron_run() to allow modules to alter cron queue settings
 * before any jobs are processesed.
 *
 * @param array $info
 *   An array of cron schedule information.
 *
 * @see hook_cron_queue_info()
 * @see drupal_cron_run()
 */
function hook_cron_job_scheduler_info_alter(&$info) {

  // Replace the default callback 'example_cache_clear_worker'.
  $info['example_reset']['worker callback'] = 'my_custom_reset';
}

/**
 * Declare job scheduler queue information.
 *
 * @return array
 *   Information for the schedule.
 *
 * @see job_scheduler_queue_info()
 * @see hook_cron_job_scheduler_queue_info_alter()
 */
function hook_cron_job_scheduler_queue_info() {
  $info = [];
  $info['example_import_queue'] = [
    'title' => 'Job Scheduler Example',
    'time' => 60,
  ];
  return $info;
}

/**
 * Alter job scheduler queue information.
 *
 * @param array $info
 *   Information for the schedule.
 *
 * @see job_scheduler_queue_info()
 */
function hook_cron_job_scheduler_queue_info_alter(&$info) {

  // Replace the default time.
  $info['example_import_queue']['time'] = 120;
}

Functions

Name	Description
hook_cron_job_scheduler_info	Declare job scheduling holding items that need to be run periodically.
hook_cron_job_scheduler_info_alter	Alter cron queue information before cron runs.
hook_cron_job_scheduler_queue_info	Declare job scheduler queue information.
hook_cron_job_scheduler_queue_info_alter	Alter job scheduler queue information.