class StatusSystem in Site Audit 8.3

Provides the StatusSystem Check.

Plugin annotation


@SiteAuditCheck(
 id = "status_system",
 name = @Translation("System Status"),
 description = @Translation("Drupal's status report."),
 report = "status"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\site_audit\Plugin\SiteAuditCheckBase implements SiteAuditCheckInterface uses StringTranslationTrait
  - class \Drupal\site_audit\Plugin\SiteAuditCheck\StatusSystem

Expanded class hierarchy of StatusSystem

File

src/Plugin/SiteAuditCheck/StatusSystem.php, line 17

Namespace

Drupal\site_audit\Plugin\SiteAuditCheck

View source

class StatusSystem extends SiteAuditCheckBase {

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

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
    $items = [];
    foreach ($this->registry->requirements as $requirement) {

      // Default to REQUIREMENT_INFO if no severity is set.
      if (!isset($requirement['severity'])) {
        $requirement['severity'] = REQUIREMENT_INFO;
      }

      // Title: severity - value.
      if ($requirement['severity'] == REQUIREMENT_INFO) {
        $class = 'info';
        $severity = 'Info';
      }
      elseif ($requirement['severity'] == REQUIREMENT_OK) {
        $severity = 'Ok';
        $class = 'success';
      }
      elseif ($requirement['severity'] == REQUIREMENT_WARNING) {
        $severity = 'Warning';
        $class = 'warning';
      }
      elseif ($requirement['severity'] == REQUIREMENT_ERROR) {
        $severity = 'Error';
        $class = 'error';
      }
      $value = isset($requirement['value']) && $requirement['value'] ? $requirement['value'] : ' ';
      $item = [
        'title' => $requirement['title'],
        'severity' => $severity,
        'value' => $value,
        'class' => $class,
      ];
      $items[] = $item;
    }
    $ret_val = [
      '#theme' => 'table',
      '#header' => [
        $this
          ->t('Title'),
        $this
          ->t('Severity'),
        $this
          ->t('Value'),
      ],
      '#rows' => [],
    ];
    foreach ($items as $item) {
      $classes = [
        $item['class'],
      ];
      switch ($item['class']) {
        case 'warning':
          $classes[] = 'label-warning';
          break;
        case 'error':
          $classes[] = 'label-danger';
          break;
      }
      $ret_val['#rows'][] = [
        'class' => implode(' ', $classes),
        'data' => [
          $item['title'],
          $item['severity'],
          $item['value'],
        ],
      ];
    }
    return $ret_val;
  }

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

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {

    // See system/system.admin.inc function system_status().
    // Load .install files.
    include_once DRUPAL_ROOT . '/core/includes/install.inc';
    drupal_load_updates();

    // Check run-time requirements and status information.
    $this->registry->requirements = \Drupal::moduleHandler()
      ->invokeAll('requirements', [
      'runtime',
    ]);
    usort($this->registry->requirements, function ($a, $b) {
      if (!isset($a['weight'])) {
        if (!isset($b['weight'])) {
          return strcmp($a['title'], $b['title']);
        }
        return -$b['weight'];
      }
      return isset($b['weight']) ? $a['weight'] - $b['weight'] : $a['weight'];
    });
    $this->percentOverride = 0;
    $requirements_with_severity = [];
    foreach ($this->registry->requirements as $key => $value) {
      if (isset($value['severity'])) {
        $requirements_with_severity[$key] = $value;
      }
    }
    $score_each = 100 / count($requirements_with_severity);
    $worst_severity = REQUIREMENT_INFO;
    foreach ($this->registry->requirements as $requirement) {
      if (isset($requirement['severity'])) {
        if ($requirement['severity'] > $worst_severity) {
          $worst_severity = $requirement['severity'];
        }
        if ($requirement['severity'] == REQUIREMENT_WARNING) {
          $this->percentOverride += $score_each / 2;
        }
        elseif ($requirement['severity'] != REQUIREMENT_ERROR) {
          $this->percentOverride += $score_each;
        }
      }
    }
    $this->percentOverride = round($this->percentOverride);
    if ($this->percentOverride > 80) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
    }
    elseif ($this->percentOverride > 60) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
SiteAuditCheckBase::$abort	protected	property	Names of checks that should not run as a result of this check.
SiteAuditCheckBase::$options	protected	property	Options passed in for reports and checks.
SiteAuditCheckBase::$optOut	protected	property	User has opted out of this check in configuration.
SiteAuditCheckBase::$percentOverride	protected	property	If set, will override the Report's percentage.
SiteAuditCheckBase::$registry	protected	property	Use for passing data between checks within a report.
SiteAuditCheckBase::$score	protected	property	Quantifiable number associated with result on a scale of 0 to 2.
SiteAuditCheckBase::$static	protected	property	Are we in a static context.
SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN		constant
SiteAuditCheckBase::checkInvokeCalculateScore	protected	function	Invoke another check's calculateScore() method if it is needed.
SiteAuditCheckBase::getDescription	public	function	Get a more verbose description of what is being checked.
SiteAuditCheckBase::getId	public	function	Get the ID or machine name for the check.
SiteAuditCheckBase::getLabel	public	function	Get the label for the check that describes, high level what is happening.
SiteAuditCheckBase::getPercentOverride	public	function	Get the report percent override, if any.
SiteAuditCheckBase::getRegistry	public	function	Get the check registry.
SiteAuditCheckBase::getResult	public	function	Determine the result message based on the score.
SiteAuditCheckBase::getScore	public	function	Get a quantifiable number representing a check result; lazy initialization.
SiteAuditCheckBase::getScoreLabel	public	function	Get a human readable label for a score.
SiteAuditCheckBase::renderAction	public	function	Display action items for a user to perform.
SiteAuditCheckBase::shouldAbort	public	function	Determine whether the check failed so badly that the report must stop.
SiteAuditCheckBase::__construct	public	function	Constructor. Overrides PluginBase::__construct
StatusSystem::calculateScore	public	function	. Overrides SiteAuditCheckBase::calculateScore
StatusSystem::getAction	public	function	. Overrides SiteAuditCheckBase::getAction
StatusSystem::getResultFail	public	function	. Overrides SiteAuditCheckBase::getResultFail
StatusSystem::getResultInfo	public	function	. Overrides SiteAuditCheckBase::getResultInfo
StatusSystem::getResultPass	public	function	. Overrides SiteAuditCheckBase::getResultPass
StatusSystem::getResultWarn	public	function	. Overrides SiteAuditCheckBase::getResultWarn
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

class StatusSystem in Site Audit 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation