summaryrefslogtreecommitdiffstatshomepage
path: root/core/lib/Drupal/Core/CronInterface.php
blob: f638e628285d944592075a21e70f613a0141949f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<?php

namespace Drupal\Core;

/**
 * An interface for running cron tasks.
 *
 * @see https://www.drupal.org/docs/administering-a-drupal-site/cron-automated-tasks
 */
interface CronInterface {

  /**
   * Executes a cron run.
   *
   * Do not call this function from a test. Use $this->cronRun() instead.
   *
   * @return bool
   *   TRUE upon success, FALSE otherwise.
   */
  public function run();

}