abstract class UltimateCronScheduler in Ultimate Cron 7.2

Abstract class for Ultimate Cron schedulers.

A scheduler is responsible for telling Ultimate Cron whether a job should run or not.

Abstract methods: isScheduled($job)

• Check if the given job is scheduled for launch at this time. TRUE if it's scheduled for launch, otherwise FALSE.

isBehind($job)

• Check if the given job is behind its schedule. FALSE if not behind, otherwise the amount of time it's behind in seconds.

Hierarchy

• class \UltimateCronPlugin
  • class \UltimateCronScheduler

2 string references to 'UltimateCronScheduler'

crontab.inc in plugins/ultimate_cron/scheduler/crontab.inc

ultimate_cron_ctools_plugin_type in ./ultimate_cron.module

Implements hook_ctools_plugin_type().

File

./ultimate_cron.plugin.inc, line 842

Plugin framework for Ultimate Cron.

abstract class UltimateCronScheduler extends UltimateCronPlugin {

  /**
   * Check job schedule.
   *
   * @param UltimateCronJob $job
   *   The job to check schedule for.
   *
   * @return bool
   *   TRUE if job is scheduled to run.
   */
  public abstract function isScheduled($job);

  /**
   * Check if job is behind schedule.
   *
   * @param UltimateCronJob $job
   *   The job to check schedule for.
   *
   * @return bool
   *   TRUE if job is behind its schedule.
   */
  public abstract function isBehind($job);

}

Members

Name	Modifiers	Type	Description	Overrides
UltimateCronPlugin::$description	public	property
UltimateCronPlugin::$globalOptions	public static	property
UltimateCronPlugin::$instances	public static	property
UltimateCronPlugin::$multiple	public static	property		1
UltimateCronPlugin::$name	public	property
UltimateCronPlugin::$plugin	public	property
UltimateCronPlugin::$settings	public	property
UltimateCronPlugin::$title	public	property
UltimateCronPlugin::$weight	public	property		1
UltimateCronPlugin::build_operations_alter	public	function	Allow plugins to alter the allowed operations for a job.	2
UltimateCronPlugin::cleanForm	public	function	Clean form of empty fallback values.
UltimateCronPlugin::cronapi	public	function	A hook_cronapi() for plugins.	1
UltimateCronPlugin::cron_alter	public	function	A hook_cron_alter() for plugins.	3
UltimateCronPlugin::cron_post_invoke	public	function	A hook_cron_post_invoke() for plugins.
UltimateCronPlugin::cron_post_launch	public	function	A hook_cron_post_launch() for plugins.
UltimateCronPlugin::cron_post_run	public	function	A hook_cron_post_run() for plugins.
UltimateCronPlugin::cron_post_schedule	public	function	A hook_cron_post_schedule() for plugins.	1
UltimateCronPlugin::cron_pre_invoke	public	function	A hook_cron_pre_invoke() for plugins.
UltimateCronPlugin::cron_pre_launch	public	function	A hook_cron_pre_launch() for plugins.
UltimateCronPlugin::cron_pre_run	public	function	A hook_cron_pre_run() for plugins.
UltimateCronPlugin::cron_pre_schedule	public	function	A hook_cron_pre_schedule() for plugins.	2
UltimateCronPlugin::defaultSettings	public	function	Default settings.	7
UltimateCronPlugin::defaultSettingsForm	public static	function	Default settings form.	1
UltimateCronPlugin::drupal_array_remove_nested_value	public	function	Modified version drupal_array_get_nested_value().
UltimateCronPlugin::factory	public static	function	Singleton factoryLogEntry.
UltimateCronPlugin::fallbackalize	public	function	Process fallback form parameters.
UltimateCronPlugin::formatLabel	public	function	Format label for the plugin.	1
UltimateCronPlugin::formatLabelVerbose	public	function	Format verbose label for the plugin.	1
UltimateCronPlugin::getDefaultSettings	public	function	Get default settings.	1
UltimateCronPlugin::getGlobalOption	public static	function	Get global plugin option.
UltimateCronPlugin::getGlobalOptions	public static	function	Get all global plugin options.
UltimateCronPlugin::hook_cron_alter	final public static	function	Invoke hook_cron_alter() on plugins.
UltimateCronPlugin::hook_cron_post_invoke	final public static	function	Invoke hook_cron_post_invoke() on plugins.
UltimateCronPlugin::hook_cron_post_launch	final public static	function	Invoke hook_cron_post_launch() on plugins.
UltimateCronPlugin::hook_cron_post_run	final public static	function	Invoke hook_cron_post_run() on plugins.
UltimateCronPlugin::hook_cron_post_schedule	final public static	function	Invoke hook_cron_post_schedule() on plugins.
UltimateCronPlugin::hook_cron_pre_invoke	final public static	function	Invoke hook_cron_pre_invoke() on plugins.
UltimateCronPlugin::hook_cron_pre_launch	final public static	function	Invoke hook_cron_pre_launch() on plugins.
UltimateCronPlugin::hook_cron_pre_run	final public static	function	Invoke hook_cron_pre_run() on plugins.
UltimateCronPlugin::hook_cron_pre_schedule	final public static	function	Invoke hook_cron_pre_schedule() on plugins.
UltimateCronPlugin::isValid	public	function	Default plugin valid for all jobs.	2
UltimateCronPlugin::jobSettingsForm	public static	function	Job settings form.	1
UltimateCronPlugin::jobSettingsFormSubmit	public static	function	Job settings form submit handler.	1
UltimateCronPlugin::jobSettingsFormValidate	public static	function	Job settings form validate handler.	1
UltimateCronPlugin::setGlobalOption	public static	function	Set global plugin option.
UltimateCronPlugin::setSettings	public	function	Save settings to db.
UltimateCronPlugin::settingsForm	public	function	Settings form.	8
UltimateCronPlugin::settingsFormSubmit	public	function	Settings form submit handler.	3
UltimateCronPlugin::settingsFormValidate	public	function	Settings form validate handler.	1
UltimateCronPlugin::settingsLabel	public	function	Get label for a specific setting.	3
UltimateCronPlugin::signal	public	function	Signal page for plugins.	2
UltimateCronPlugin::unsetGlobalOption	public static	function	Remove a global plugin option.
UltimateCronPlugin::unsetGlobalOptions	public static	function	Remove all global plugin options.
UltimateCronPlugin::__construct	public	function	Constructor.	1
UltimateCronScheduler::isBehind	abstract public	function	Check if job is behind schedule.	1
UltimateCronScheduler::isScheduled	abstract public	function	Check job schedule.	1