interface ProdCheckInterface in Production check & Production monitor 8

Defines an interface for prod checks

Hierarchy

• interface \Drupal\prod_check\Plugin\ProdCheckInterface

5 files declare their use of ProdCheckInterface

Internal.php in src/Plugin/ProdCheckProcessor/Internal.php

ProdCheckBase.php in src/Plugin/ProdCheck/ProdCheckBase.php

ProdCheckProcessorBase.php in src/Plugin/ProdCheckProcessor/ProdCheckProcessorBase.php

Rest.php in modules/prod_check_rest/src/Plugin/ProdCheckProcessor/Rest.php

XmlRpc.php in modules/prod_check_xmlrpc/src/Plugin/ProdCheckProcessor/XmlRpc.php

File

src/Plugin/ProdCheckInterface.php, line 8

Namespace

Drupal\prod_check\Plugin

interface ProdCheckInterface {

  /**
   * Initializes the check plugin.
   */
  public function init();

  /**
   * Returns the title of the plugin.
   *
   * @return
   *   The title
   */
  public function title();

  /**
   * Returns the title of the check
   *
   * @return
   *   The category
   */
  public function category();

  /**
   * Returns the extra data of the check.
   *
   * @return
   *   The category
   */
  public function data();

  /**
   * Calculates the state for the check.
   *
   * @return
   *   TRUE if the check passed
   *   FALSE otherwise
   */
  public function state();

  /**
   * Defines the severity of the check.
   *
   * @return
   *   The severity
   */
  public function severity();

  /**
   * Returns the success messages for the check.
   *
   * @return
   *   An associative array containing the following keys
   *     - value: the value of the check
   *     - description: the description of the check
   */
  public function successMessages();

  /**
   * Returns the fail messages for the check
   *
   * @return
   *   An associative array containing the following keys
   *     - value: the value of the check
   *     - description: the description of the check
   */
  public function failMessages();

}

Members

Name	Modifiers	Type	Description	Overrides
ProdCheckInterface::category	public	function	Returns the title of the check	1
ProdCheckInterface::data	public	function	Returns the extra data of the check.	1
ProdCheckInterface::failMessages	public	function	Returns the fail messages for the check	12
ProdCheckInterface::init	public	function	Initializes the check plugin.	1
ProdCheckInterface::severity	public	function	Defines the severity of the check.	1
ProdCheckInterface::state	public	function	Calculates the state for the check.	12
ProdCheckInterface::successMessages	public	function	Returns the success messages for the check.	12
ProdCheckInterface::title	public	function	Returns the title of the plugin.	1