class CronJobDiscovery in Ultimate Cron 8.2

Discovery and instantiation of default cron jobs.

Hierarchy

• class \Drupal\ultimate_cron\CronJobDiscovery

1 file declares its use of CronJobDiscovery

ultimate_cron.nagios.inc in ./ultimate_cron.nagios.inc

1 string reference to 'CronJobDiscovery'

ultimate_cron.services.yml in ./ultimate_cron.services.yml

ultimate_cron.services.yml

1 service uses CronJobDiscovery

ultimate_cron.discovery in ./ultimate_cron.services.yml

Drupal\ultimate_cron\CronJobDiscovery

File

src/CronJobDiscovery.php, line 14

Namespace

Drupal\ultimate_cron

class CronJobDiscovery {

  /**
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * @var \Drupal\Core\Queue\QueueWorkerManagerInterface
   */
  protected $queueManager;

  /**
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The module extension list service.
   *
   * @var \Drupal\Core\Extension\ModuleExtensionList
   */
  protected $moduleExtensionList;

  /**
   * CronJobDiscovery constructor.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Queue\QueueWorkerManagerInterface $queue_manager
   *   The queue manager.
   * @param \Drupal\Core\Extension\ModuleExtensionList $module_extension_list
   *   The module extension list service.
   */
  public function __construct(ModuleHandlerInterface $module_handler, QueueWorkerManagerInterface $queue_manager, ConfigFactoryInterface $config_factory, ModuleExtensionList $module_extension_list) {
    $this->moduleHandler = $module_handler;
    $this->queueManager = $queue_manager;
    $this->configFactory = $config_factory;
    $this->moduleExtensionList = $module_extension_list;
  }

  /**
   * Automatically discovers and creates default cron jobs.
   */
  public function discoverCronJobs() {

    // Create cron jobs for hook_cron() implementations.
    foreach ($this
      ->getHooks() as $id => $info) {
      $this
        ->ensureCronJobExists($info, $id);
    }
    if (!$this->configFactory
      ->get('ultimate_cron.settings')
      ->get('queue.enabled')) {
      return;
    }

    // Create cron jobs for queue plugins.
    foreach ($this->queueManager
      ->getDefinitions() as $id => $definition) {
      if (!isset($definition['cron'])) {
        continue;
      }
      $job_id = str_replace(':', '__', CronJobInterface::QUEUE_ID_PREFIX . $id);
      if (!CronJob::load($job_id)) {
        $values = [
          'title' => t('Queue: @title', [
            '@title' => $definition['title'],
          ]),
          'id' => $job_id,
          'module' => $definition['provider'],
          // Process queue jobs later by default.
          'weight' => 10,
          'callback' => 'ultimate_cron.queue_worker:queueCallback',
          'scheduler' => [
            'id' => 'simple',
            'configuration' => [
              'rules' => [
                '* * * * *',
              ],
            ],
          ],
        ];
        $job = CronJob::create($values);
        $job
          ->save();
      }
    }
  }

  /**
   * Creates a new cron job with specific values.
   *
   * @param array $info
   *   Module info.
   * @param string $id
   *   Module name.
   */
  protected function ensureCronJobExists($info, $id) {
    $job = NULL;
    if (!CronJob::load($id)) {
      $values = array(
        'title' => $this
          ->getJobTitle($id),
        'id' => $id,
        'module' => $info['module'],
        'callback' => $info['callback'],
      );
      $job = CronJob::create($values);
      $job
        ->save();
    }
  }

  /**
   * Returns the job title for a given ID.
   *
   * @param string $id
   *   The default cron job ID.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The default job title.
   */
  protected function getJobTitle($id) {
    $titles = array();
    $titles['comment_cron'] = t('Store the maximum possible comments per thread');
    $titles['dblog_cron'] = t('Remove expired log messages and flood control events');
    $titles['field_cron'] = t('Purges deleted Field API data');
    $titles['file_cron'] = t('Deletes temporary files');
    $titles['history_cron'] = t('Deletes history');
    $titles['search_cron'] = t('Updates indexable active search pages');
    $titles['system_cron'] = t('Cleanup (caches, batch, flood, temp-files, etc.)');
    $titles['update_cron'] = t('Update indexes');
    $titles['node_cron'] = t('Updates search rankings for nodes');
    $titles['aggregator_cron'] = t('Refresh feeds');
    $titles['ultimate_cron_cron'] = t('Runs internal cleanup operations');
    $titles['statistics_cron'] = t('Reset counts and clean up');
    $titles['tracker_cron'] = t('Update tracker index');
    if (isset($titles[$id])) {
      return $titles[$id];
    }
    return t('Default cron handler');
  }

  /**
   * Get all cron hooks defined.
   *
   * @return array
   *   All hook definitions available.
   */
  protected function getHooks() {
    $hooks = array();

    // Generate list of jobs provided by modules.
    $modules = array_keys($this->moduleHandler
      ->getModuleList());
    foreach ($modules as $module) {
      $hooks += $this
        ->getModuleHooks($module);
    }
    return $hooks;
  }

  /**
   * Get cron hooks declared by a module.
   *
   * @param string $module
   *   Name of module.
   *
   * @return array
   *   Hook definitions for the specified module.
   */
  protected function getModuleHooks($module) {
    $items = array();

    // Add hook_cron() if applicable.
    if ($this->moduleHandler
      ->implementsHook($module, 'cron')) {
      $info = $this->moduleExtensionList
        ->getExtensionInfo($module);
      $callback = "{$module}_cron";
      $items[$callback] = array(
        'module' => $module,
        'title' => isset($titles[$callback]) ? $titles[$callback] : 'Default cron handler',
        'configure' => empty($info['configure']) ? NULL : $info['configure'],
        'callback' => $callback,
        'tags' => array(),
        'pass job argument' => FALSE,
      );
      $items["{$module}_cron"]['tags'][] = 'core';
    }
    return $items;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CronJobDiscovery::$configFactory	protected	property
CronJobDiscovery::$moduleExtensionList	protected	property	The module extension list service.
CronJobDiscovery::$moduleHandler	protected	property
CronJobDiscovery::$queueManager	protected	property
CronJobDiscovery::discoverCronJobs	public	function	Automatically discovers and creates default cron jobs.
CronJobDiscovery::ensureCronJobExists	protected	function	Creates a new cron job with specific values.
CronJobDiscovery::getHooks	protected	function	Get all cron hooks defined.
CronJobDiscovery::getJobTitle	protected	function	Returns the job title for a given ID.
CronJobDiscovery::getModuleHooks	protected	function	Get cron hooks declared by a module.
CronJobDiscovery::__construct	public	function	CronJobDiscovery constructor.