interface SchedulerInterface in Ultimate Cron 8.2

Defines a scheduler method.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\ultimate_cron\Scheduler\SchedulerInterface

1 file declares its use of SchedulerInterface

SchedulerBase.php in src/Plugin/ultimate_cron/Scheduler/SchedulerBase.php

File

src/Scheduler/SchedulerInterface.php, line 14

Namespace

Drupal\ultimate_cron\Scheduler

interface SchedulerInterface extends PluginInspectionInterface, ConfigurableInterface, DependentPluginInterface, PluginFormInterface {

  /**
   * Returns the default configuration.
   *
   * @return mixed
   */
  public function defaultConfiguration();

  /**
   * Label for schedule.
   *
   * @param \Drupal\ultimate_cron\Entity\CronJob $job
   *   The job whose label should be formatted.
   */
  public function formatLabel(CronJob $job);

  /**
   * Label for schedule.
   *
   * @param \Drupal\ultimate_cron\Entity\CronJob $job
   *   The job whose label should be formatted.
   */
  public function formatLabelVerbose(CronJob $job);

  /**
   * Check job schedule.
   *
   * @param \Drupal\ultimate_cron\Entity\CronJob $job
   *   The job to check schedule for.
   *
   * @return bool
   *   TRUE if job is scheduled to run.
   */
  public function isScheduled(CronJob $job);

  /**
   * Check if job is behind schedule.
   *
   * @param \Drupal\ultimate_cron\Entity\CronJob $job
   *   The job to check schedule for.
   *
   * @return bool|int
   *   FALSE if job is behind its schedule or number of seconds behind.
   */
  public function isBehind(CronJob $job);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
SchedulerInterface::defaultConfiguration	public	function	Returns the default configuration. Overrides ConfigurableInterface::defaultConfiguration
SchedulerInterface::formatLabel	public	function	Label for schedule.	1
SchedulerInterface::formatLabelVerbose	public	function	Label for schedule.	1
SchedulerInterface::isBehind	public	function	Check if job is behind schedule.	1
SchedulerInterface::isScheduled	public	function	Check job schedule.	1