ContentHubRequirementInterface.php in Acquia Content Hub 8

Namespace

Drupal\acquia_contenthub_diagnostic

File

acquia_contenthub_diagnostic/src/ContentHubRequirementInterface.php

<?php

namespace Drupal\acquia_contenthub_diagnostic;


/**
 * Provides an interface defining a Content Hub Requirement plugin.
 */
interface ContentHubRequirementInterface {

  /**
   * Returns the name of the requirement.
   *
   * @return string
   *   The name of the requirement.
   */
  public function title();

  /**
   * Returns the current value.
   *
   * @return string
   *   The current value.
   */
  public function value();

  /**
   * Returns the description of the requirement/status.
   *
   * @return string
   *   The description of the requirement/status.
   */
  public function description();

  /**
   * Returns the requirement's result/severity level.
   *
   * @return int
   *   The requirement status code:
   *     - REQUIREMENT_INFO: For info only.
   *     - REQUIREMENT_OK: The requirement is satisfied.
   *     - REQUIREMENT_WARNING: The requirement failed with a warning.
   *     - REQUIREMENT_ERROR: The requirement failed with an error.
   */
  public function severity();

}

Interfaces

Name	Description
ContentHubRequirementInterface	Provides an interface defining a Content Hub Requirement plugin.