You are here

Home » API reference » Site Audit 8.3 » WatchdogPhp.php

class WatchdogPhp in Site Audit 8.3

Provides the WatchdogPhp Check.

Plugin annotation


@SiteAuditCheck(
 id = "watchdog_php",
 name = @Translation("PHP messages"),
 description = @Translation("Count PHP notices, warnings and errors."),
 report = "watchdog",
 weight = 0,
)

Hierarchy

Expanded class hierarchy of WatchdogPhp

File

src/Plugin/SiteAuditCheck/WatchdogPhp.php, line 19

Namespace

Drupal\site_audit\Plugin\SiteAuditCheck
View source 
class WatchdogPhp extends SiteAuditCheckBase {

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

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
    $counts = [];
    foreach ($this->registry->php_counts as $severity => $count) {
      $counts[] = $severity . ': ' . $count;
    }
    $ret_val = implode(', ', $counts);
    $ret_val .= ' - total ' . $this->registry->percent_php . '%';
    return $ret_val;
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
    return $this
      ->t('No PHP warnings, notices or errors.');
  }

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

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
    if ($this->score == SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN) {
      return $this
        ->t('Every time Drupal logs a PHP notice, warning or error, PHP executes slower and the writing operation locks the database. By eliminating the problems, your site will be faster.');
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {
    $this->registry->php_counts = [];
    $this->registry->php_count_total = 0;
    $this->registry->percent_php = 0;
    $query = \Drupal::database()
      ->select('watchdog');
    $query
      ->addExpression('COUNT(*)', 'count');
    $query
      ->addField('watchdog', 'severity');
    $query
      ->groupBy('severity');
    $query
      ->orderBy('severity', 'ASC');
    $result = $query
      ->execute();
    $severity_levels = $this
      ->watchdog_severity_levels();
    while ($row = $result
      ->fetchObject()) {
      $row->severity = $severity_levels[$row->severity];

      // $row = watchdog_format_result($result);
      if (!isset($this->registry->php_counts[$row->severity])) {
        $this->registry->php_counts[$row->severity] = 0;
      }
      $this->registry->php_counts[$row->severity]++;
      $this->registry->php_count_total++;
    }
    $this->registry->percent_php = round($this->registry->php_count_total / $this->registry->count_entries * 100, 2);
    if ($this->registry->percent_php >= 10) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO;
  }

  /**
   * Watchdog severity levels.
   *
   * @see drush_watchdog_severity_levels()
   */
  public function watchdog_severity_levels() {
    return [
      RfcLogLevel::EMERGENCY => 'emergency',
      RfcLogLevel::ALERT => 'alert',
      RfcLogLevel::CRITICAL => 'critical',
      RfcLogLevel::ERROR => 'error',
      RfcLogLevel::WARNING => 'warning',
      RfcLogLevel::NOTICE => 'notice',
      RfcLogLevel::INFO => 'info',
      RfcLogLevel::DEBUG => 'debug',
    ];
  }

}

Members

Namesort descending 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
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.
WatchdogPhp::calculateScore public function . Overrides SiteAuditCheckBase::calculateScore
WatchdogPhp::getAction public function . Overrides SiteAuditCheckBase::getAction
WatchdogPhp::getResultFail public function . Overrides SiteAuditCheckBase::getResultFail
WatchdogPhp::getResultInfo public function . Overrides SiteAuditCheckBase::getResultInfo
WatchdogPhp::getResultPass public function . Overrides SiteAuditCheckBase::getResultPass
WatchdogPhp::getResultWarn public function . Overrides SiteAuditCheckBase::getResultWarn
WatchdogPhp::watchdog_severity_levels public function Watchdog severity levels.