You are here

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

class ExtensionsCount in Site Audit 8.3

Provides the ExtensionsCount Check.

Plugin annotation


@SiteAuditCheck(
 id = "extensions_count",
 name = @Translation("Count"),
 description = @Translation("Count the number of enabled extensions (modules and themes) in a site."),
 report = "extensions"
)

Hierarchy

Expanded class hierarchy of ExtensionsCount

File

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

Namespace

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

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

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

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
    return $this
      ->t('There are @extension_count extensions enabled.', [
      '@extension_count' => $this->registry->extension_count,
    ]);
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultWarn() {
    return $this
      ->t('There are @extension_count extensions enabled; that\'s higher than the average.', [
      '@extension_count' => $this->registry->extension_count,
    ]);
  }

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
    if ($this->score != SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS) {
      $ret_val = $this
        ->t('Consider the following options:') . PHP_EOL;
      $options = [];
      $options[] = $this
        ->t('Disable unneeded or unnecessary extensions.');
      $options[] = $this
        ->t('Consolidate functionality if possible, or custom develop a solution specific to your needs.');
      $options[] = $this
        ->t('Avoid using modules that serve only one small purpose that is not mission critical.');

      // If ($this->options['html']) {.
      if (TRUE) {
        $ret_val .= '<ul>';
        foreach ($options as $option) {
          $ret_val .= '<li>' . $option . '</li>';
        }
        $ret_val .= '</ul>';
      }
      else {
        foreach ($options as $option) {
          if (!$this->options['json']) {
            $ret_val .= str_repeat(' ', 6);
          }
          $ret_val .= '- ' . $option . PHP_EOL;
        }
        if (!$this->options['json']) {
          $ret_val .= str_repeat(' ', 6);
        }
      }
      $ret_val .= $this
        ->t('A lightweight site is a fast and happy site!');
      return $ret_val;
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {
    if (!isset($this->registry->extensions) || empty($this->registry->extensions)) {
      $moduleHandler = \Drupal::service('module_handler');
      $this->registry->extensions = $moduleHandler
        ->getModuleList();
    }
    $this->registry->extension_count = count($this->registry->extensions);
    if ($this->registry->extension_count >= 150) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ExtensionsCount::calculateScore public function . Overrides SiteAuditCheckBase::calculateScore
ExtensionsCount::getAction public function . Overrides SiteAuditCheckBase::getAction
ExtensionsCount::getResultFail public function . Overrides SiteAuditCheckBase::getResultFail
ExtensionsCount::getResultInfo public function . Overrides SiteAuditCheckBase::getResultInfo
ExtensionsCount::getResultPass public function . Overrides SiteAuditCheckBase::getResultPass
ExtensionsCount::getResultWarn public function . Overrides SiteAuditCheckBase::getResultWarn
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.