abstract class ContentHubRequirementBase in Acquia Content Hub 8

Defines a base implementation that Content Hub Requirements will extend.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\acquia_contenthub_diagnostic\ContentHubRequirementBase implements ContentHubRequirementInterface, ContainerFactoryPluginInterface

Expanded class hierarchy of ContentHubRequirementBase

8 files declare their use of ContentHubRequirementBase

ContribModuleVersionRequirement.php in acquia_contenthub_diagnostic/src/Plugin/ContentHubRequirement/ContribModuleVersionRequirement.php
CoreVersionRequirement.php in acquia_contenthub_diagnostic/src/Plugin/ContentHubRequirement/CoreVersionRequirement.php
DiagnosticsInstalledWarning.php in acquia_contenthub_diagnostic/src/Plugin/ContentHubRequirement/DiagnosticsInstalledWarning.php
EndpointAccessibilityRequirement.php in acquia_contenthub_diagnostic/src/Plugin/ContentHubRequirement/EndpointAccessibilityRequirement.php
HashSaltRequirement.php in acquia_contenthub_diagnostic/src/Plugin/ContentHubRequirement/HashSaltRequirement.php

... See full list

File

acquia_contenthub_diagnostic/src/ContentHubRequirementBase.php, line 13

Namespace

Drupal\acquia_contenthub_diagnostic

View source

abstract class ContentHubRequirementBase extends PluginBase implements ContentHubRequirementInterface, ContainerFactoryPluginInterface {

  /**
   * The current value.
   *
   * @var string|\Drupal\Core\StringTranslation\TranslatableMarkup
   */
  protected $value;

  /**
   * The description of the requirement/status.
   *
   * @var string|\Drupal\Core\StringTranslation\TranslatableMarkup
   */
  protected $description;

  /**
   * The requirement's result/severity level.
   *
   * @var int
   */
  protected $severity;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a new ContentHubRequirementBase.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $module_handler;
    try {
      $this->severity = $this
        ->verify();
    } catch (\Exception $e) {
      $this
        ->setValue($this
        ->t("An exception occurred."));
      $this
        ->setDescription($this
        ->t('Error: @error', [
        '@error' => $e
          ->getMessage(),
      ]));
      $this->severity = REQUIREMENT_ERROR;
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
    $module_handler = $container
      ->get('module_handler');
    return new static($configuration, $plugin_id, $plugin_definition, $module_handler);
  }

  /**
   * Verifies the requirement.
   *
   * @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 abstract function verify();

  /**
   * {@inheritdoc}
   */
  public function title() {
    return $this->pluginDefinition['title'];
  }

  /**
   * {@inheritdoc}
   */
  public function value() {
    return $this->value;
  }

  /**
   * {@inheritdoc}
   */
  public function description() {
    return $this->description;
  }

  /**
   * {@inheritdoc}
   */
  public function severity() {
    return $this->severity;
  }

  /**
   * Sets the current value.
   *
   * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $value
   *   The current value.
   */
  protected function setValue($value) {
    $this->value = $value;
  }

  /**
   * Sets the description of the requirement/status.
   *
   * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
   *   The description of the requirement/status.
   */
  protected function setDescription($description) {
    $this->description = $description;
  }

  /**
   * Get the domain to run the tests on.
   */
  protected function getDomain() {
    global $base_url;
    $domain = $_SERVER['SERVER_NAME'] ?: parse_url($base_url, PHP_URL_HOST);
    if (empty($domain)) {
      $error = "Your site's domain could not be determined.";
      if (PHP_SAPI === 'cli') {
        $error .= ' ' . 'Use a valid Drush site alias or visit the Status report in a browser.';
      }
      throw new \Exception($error);
    }
    return 'https://' . $domain;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentHubRequirementBase::$description	protected	property	The description of the requirement/status.	1
ContentHubRequirementBase::$moduleHandler	protected	property	The module handler.
ContentHubRequirementBase::$severity	protected	property	The requirement's result/severity level.
ContentHubRequirementBase::$value	protected	property	The current value.
ContentHubRequirementBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ContentHubRequirementBase::description	public	function	Returns the description of the requirement/status. Overrides ContentHubRequirementInterface::description	1
ContentHubRequirementBase::getDomain	protected	function	Get the domain to run the tests on.
ContentHubRequirementBase::setDescription	protected	function	Sets the description of the requirement/status.
ContentHubRequirementBase::setValue	protected	function	Sets the current value.
ContentHubRequirementBase::severity	public	function	Returns the requirement's result/severity level. Overrides ContentHubRequirementInterface::severity
ContentHubRequirementBase::title	public	function	Returns the name of the requirement. Overrides ContentHubRequirementInterface::title
ContentHubRequirementBase::value	public	function	Returns the current value. Overrides ContentHubRequirementInterface::value
ContentHubRequirementBase::verify	abstract public	function	Verifies the requirement.	8
ContentHubRequirementBase::__construct	public	function	Constructs a new ContentHubRequirementBase. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

abstract class ContentHubRequirementBase in Acquia Content Hub 8

Hierarchy

File

Namespace

Members

API Navigation