interface ReadinessCheckerManagerInterface in Automatic Updates 8

Readiness checker manager interface.

Hierarchy

• interface \Drupal\automatic_updates\ReadinessChecker\ReadinessCheckerManagerInterface

4 files declare their use of ReadinessCheckerManagerInterface

automatic_updates.install in ./automatic_updates.install

Automatic updates install file.

automatic_updates.module in ./automatic_updates.module

Contains automatic_updates.module..

InPlaceUpdate.php in src/Services/InPlaceUpdate.php

ReadinessCheckerController.php in src/Controller/ReadinessCheckerController.php

File

src/ReadinessChecker/ReadinessCheckerManagerInterface.php, line 8

Namespace

Drupal\automatic_updates\ReadinessChecker

interface ReadinessCheckerManagerInterface {

  /**
   * Error category.
   */
  const ERROR = 'error';

  /**
   * Warning category.
   */
  const WARNING = 'warning';

  /**
   * Last checked ago warning (in seconds).
   */
  const LAST_CHECKED_WARNING = 3600 * 24;

  /**
   * Appends a checker to the checker chain.
   *
   * @param \Drupal\automatic_updates\ReadinessChecker\ReadinessCheckerInterface $checker
   *   The checker interface to be appended to the checker chain.
   * @param string $category
   *   (optional) The category of check.
   * @param int $priority
   *   (optional) The priority of the checker being added.
   *
   * @return $this
   */
  public function addChecker(ReadinessCheckerInterface $checker, $category = 'warning', $priority = 0);

  /**
   * Run checks.
   *
   * @param string $category
   *   The category of check.
   *
   * @return array
   *   An array of translatable strings.
   */
  public function run($category);

  /**
   * Get results of most recent run.
   *
   * @param string $category
   *   The category of check.
   *
   * @return array
   *   An array of translatable strings.
   */
  public function getResults($category);

  /**
   * Get timestamp of most recent run.
   *
   * @return int
   *   A unix timestamp of most recent completed run.
   */
  public function timestamp();

  /**
   * Determine if readiness checks is enabled.
   *
   * @return bool
   *   TRUE if enabled, otherwise FALSE.
   */
  public function isEnabled();

  /**
   * Get the categories of checkers.
   *
   * @return array
   *   The categories of checkers.
   */
  public function getCategories();

}

Members

Name	Modifiers	Type	Description	Overrides
ReadinessCheckerManagerInterface::addChecker	public	function	Appends a checker to the checker chain.	1
ReadinessCheckerManagerInterface::ERROR		constant	Error category.
ReadinessCheckerManagerInterface::getCategories	public	function	Get the categories of checkers.	1
ReadinessCheckerManagerInterface::getResults	public	function	Get results of most recent run.	1
ReadinessCheckerManagerInterface::isEnabled	public	function	Determine if readiness checks is enabled.	1
ReadinessCheckerManagerInterface::LAST_CHECKED_WARNING		constant	Last checked ago warning (in seconds).
ReadinessCheckerManagerInterface::run	public	function	Run checks.	1
ReadinessCheckerManagerInterface::timestamp	public	function	Get timestamp of most recent run.	1
ReadinessCheckerManagerInterface::WARNING		constant	Warning category.