class ExtensionsUnrecommended in Site Audit 8.3

Provides the ExtensionsUnrecommended Check.

Plugin annotation


@SiteAuditCheck(
 id = "extensions_unrecommended",
 name = @Translation("Not recommended"),
 description = @Translation("Check for unrecommended modules."),
 report = "extensions"
)

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\ExtensionsUnrecommended

Expanded class hierarchy of ExtensionsUnrecommended

File

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

Namespace

Drupal\site_audit\Plugin\SiteAuditCheck

View source

class ExtensionsUnrecommended extends SiteAuditCheckBase {

  /**
   * {@inheritdoc}.
   */
  public function getResultFail() {
    $ret_val = $this
      ->t('The following unrecommended modules(s) currently exist in your codebase: @list', [
      '@list' => implode(', ', array_keys($this->registry->extensions_unrec)),
    ]);

    // If ($this->options['detail']) {.
    if (TRUE) {

      // If ($this->options['html']) {.
      if (TRUE) {
        $ret_val .= '<br/>';
        $ret_val .= '<table class="table table-condensed">';
        $ret_val .= '<thead><tr><th>' . $this
          ->t('Name') . '</th><th>' . $this
          ->t('Reason') . '</th></thead>';
        $ret_val .= '<tbody>';
        foreach ($this->registry->extensions_unrec as $row) {
          $ret_val .= '<tr><td>' . implode('</td><td>', $row) . '</td></tr>';
        }
        $ret_val .= '</tbody>';
        $ret_val .= '</table>';
      }
      else {
        foreach ($this->registry->extensions_unrec as $row) {
          $ret_val .= PHP_EOL;
          if (!$this->options['json']) {
            $ret_val .= str_repeat(' ', 6);
          }
          $ret_val .= '- ' . $row[0] . ': ' . $row[1];
        }
      }
    }
    return $ret_val;
  }

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

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
    return $this
      ->t('No unrecommended extensions were detected; no action required.', []);
  }

  /**
   * {@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
      ->getScore() != SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS) {
      return $this
        ->t('Disable and completely remove unrecommended modules from your codebase for increased performance, stability and security in the any environment.');
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {
    $this->registry->extensions_unrec = [];
    if (!isset($this->registry->extensions)) {
      $this
        ->checkInvokeCalculateScore('extensions_count');
    }
    $extension_info = $this->registry->extensions;

    // uasort($extension_info, '_drush_pm_sort_extensions');.
    $unrecommended_extensions = $this
      ->getExtensions();
    foreach ($extension_info as $extension) {
      $row = [];
      $machine_name = $extension
        ->getName();

      // Not in the list of known unrecommended modules.
      if (!array_key_exists($machine_name, $unrecommended_extensions)) {
        continue;
      }

      // Name.
      $row[] = $extension->label;

      // Reason.
      $row[] = $unrecommended_extensions[$machine_name];
      $this->registry->extensions_unrec[$machine_name] = $row;
    }
    if (!empty($this->registry->extensions_unrec)) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
  }

  /**
   * Get a list of unrecommended extension names and reasons.
   *
   * @return array
   *   Keyed by module machine name, value is explanation.
   */
  public function getExtensions() {
    $unrecommended_modules = [
      'bad_judgement' => $this
        ->t('Joke module, framework for anarchy.'),
      'php' => $this
        ->t('Executable code should never be stored in the database.'),
    ];

    // If ($this->options['vendor'] == 'pantheon') { TODO.
    if (FALSE) {

      // Unsupported or redundant.
      $pantheon_unrecommended_modules = [
        'memcache' => $this
          ->t('Pantheon does not provide memcache; instead, redis is provided as a service to all customers; see http://helpdesk.getpantheon.com/customer/portal/articles/401317'),
        'memcache_storage' => $this
          ->t('Pantheon does not provide memcache; instead, redis is provided as a service to all customers; see http://helpdesk.getpantheon.com/customer/portal/articles/401317'),
      ];
      $unrecommended_modules = array_merge($unrecommended_modules, $pantheon_unrecommended_modules);
    }
    return $unrecommended_modules;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExtensionsUnrecommended::calculateScore	public	function	. Overrides SiteAuditCheckBase::calculateScore
ExtensionsUnrecommended::getAction	public	function	. Overrides SiteAuditCheckBase::getAction
ExtensionsUnrecommended::getExtensions	public	function	Get a list of unrecommended extension names and reasons.
ExtensionsUnrecommended::getResultFail	public	function	. Overrides SiteAuditCheckBase::getResultFail
ExtensionsUnrecommended::getResultInfo	public	function	. Overrides SiteAuditCheckBase::getResultInfo
ExtensionsUnrecommended::getResultPass	public	function	. Overrides SiteAuditCheckBase::getResultPass
ExtensionsUnrecommended::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.

You are here

class ExtensionsUnrecommended in Site Audit 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation