class SiteAuditCheckExtensionsUnrecommended in Site Audit 8.2

Class SiteAuditCheckExtensionsUnrecommended.

Hierarchy

• class \SiteAuditCheckAbstract
  • class \SiteAuditCheckExtensionsUnrecommended

File

Check/Extensions/Unrecommended.php, line 10

Contains \SiteAudit\Check\Extensions\Unrecommended.

class SiteAuditCheckExtensionsUnrecommended extends SiteAuditCheckAbstract {

  /**
   * Implements \SiteAudit\Check\Abstract\getLabel().
   */
  public function getLabel() {
    return dt('Not recommended');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getDescription().
   */
  public function getDescription() {
    return dt('Check for unrecommended modules.');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultFail().
   */
  public function getResultFail() {
    $ret_val = dt('The following unrecommended modules(s) currently exist in your codebase: @list', array(
      '@list' => implode(', ', array_keys($this->registry['extensions_unrec'])),
    ));
    if (drush_get_option('detail')) {
      if (drush_get_option('html')) {
        $ret_val .= '<br/>';
        $ret_val .= '<table class="table table-condensed">';
        $ret_val .= '<thead><tr><th>' . dt('Name') . '</th><th>' . dt('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 (!drush_get_option('json')) {
            $ret_val .= str_repeat(' ', 6);
          }
          $ret_val .= '- ' . $row[0] . ': ' . $row[1];
        }
      }
    }
    return $ret_val;
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultInfo().
   */
  public function getResultInfo() {
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultPass().
   */
  public function getResultPass() {
    return dt('No unrecommended extensions were detected; no action required.');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultWarn().
   */
  public function getResultWarn() {
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getAction().
   */
  public function getAction() {
    if ($this
      ->getScore() != SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_PASS) {
      return dt('Disable and completely remove unrecommended modules from your codebase for increased performance, stability and security in the any environment.');
    }
  }

  /**
   * Implements \SiteAudit\Check\Abstract\calculateScore().
   */
  public function calculateScore() {
    $this->registry['extensions_unrec'] = array();
    $extension_info = $this->registry['extensions'];
    uasort($extension_info, '_drush_pm_sort_extensions');
    $unrecommended_extensions = $this
      ->getExtensions();
    foreach ($extension_info as $extension) {
      $row = array();
      $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 SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_FAIL;
    }
    return SiteAuditCheckAbstract::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 = array(
      'bad_judgement' => dt('Joke module, framework for anarchy.'),
      'php' => dt('Executable code should never be stored in the database.'),
    );
    if (drush_get_option('vendor') == 'pantheon') {

      // Unsupported or redundant.
      $pantheon_unrecommended_modules = array(
        'memcache' => dt('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' => dt('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
SiteAuditCheckAbstract::$abort	protected	property	Indicate that no other checks should be run after this check.
SiteAuditCheckAbstract::$customCode	private static	property	Use for checking whether custom code paths have been validated.
SiteAuditCheckAbstract::$optOut	protected	property	User has opted out of this check in configuration.
SiteAuditCheckAbstract::$percentOverride	protected	property	If set, will override the Report's percentage.
SiteAuditCheckAbstract::$registry	protected	property	Use for passing data between checks within a report.
SiteAuditCheckAbstract::$score	protected	property	Quantifiable number associated with result on a scale of 0 to 2.
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_FAIL		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_PASS		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_WARN		constant
SiteAuditCheckAbstract::getCustomCodePaths	public	function	Returns an array containing custom code paths or AUDIT_CHECK_SCORE_INFO.
SiteAuditCheckAbstract::getExecPath	public	function	Returns the path of the executable.
SiteAuditCheckAbstract::getOptions	public	function	Returns the values of the valid options for a command.
SiteAuditCheckAbstract::getPercentOverride	public	function	Get the report percent override, if any.
SiteAuditCheckAbstract::getRegistry	public	function	Get the check registry.
SiteAuditCheckAbstract::getRelativePath	public	function	Gives path relative to DRUPAL_ROOT of the path is inside Drupal.
SiteAuditCheckAbstract::getResult	public	function	Determine the result message based on the score.
SiteAuditCheckAbstract::getScore	public	function	Get a quantifiable number representing a check result; lazy initialization.
SiteAuditCheckAbstract::getScoreCssClass	public	function	Get the CSS class associated with a score.
SiteAuditCheckAbstract::getScoreDrushLevel	public	function	Get the Drush message level associated with a score.
SiteAuditCheckAbstract::getScoreLabel	public	function	Get a human readable label for a score.
SiteAuditCheckAbstract::logXmlError	public	function	Logs error if unable to parse XML output.
SiteAuditCheckAbstract::renderAction	public	function	Display action items for a user to perform.
SiteAuditCheckAbstract::shouldAbort	public	function	Determine whether the check failed so badly that the report must stop.
SiteAuditCheckAbstract::__construct	public	function	Constructor.
SiteAuditCheckExtensionsUnrecommended::calculateScore	public	function	Implements \SiteAudit\Check\Abstract\calculateScore(). Overrides SiteAuditCheckAbstract::calculateScore
SiteAuditCheckExtensionsUnrecommended::getAction	public	function	Implements \SiteAudit\Check\Abstract\getAction(). Overrides SiteAuditCheckAbstract::getAction
SiteAuditCheckExtensionsUnrecommended::getDescription	public	function	Implements \SiteAudit\Check\Abstract\getDescription(). Overrides SiteAuditCheckAbstract::getDescription
SiteAuditCheckExtensionsUnrecommended::getExtensions	public	function	Get a list of unrecommended extension names and reasons.
SiteAuditCheckExtensionsUnrecommended::getLabel	public	function	Implements \SiteAudit\Check\Abstract\getLabel(). Overrides SiteAuditCheckAbstract::getLabel
SiteAuditCheckExtensionsUnrecommended::getResultFail	public	function	Implements \SiteAudit\Check\Abstract\getResultFail(). Overrides SiteAuditCheckAbstract::getResultFail
SiteAuditCheckExtensionsUnrecommended::getResultInfo	public	function	Implements \SiteAudit\Check\Abstract\getResultInfo(). Overrides SiteAuditCheckAbstract::getResultInfo
SiteAuditCheckExtensionsUnrecommended::getResultPass	public	function	Implements \SiteAudit\Check\Abstract\getResultPass(). Overrides SiteAuditCheckAbstract::getResultPass
SiteAuditCheckExtensionsUnrecommended::getResultWarn	public	function	Implements \SiteAudit\Check\Abstract\getResultWarn(). Overrides SiteAuditCheckAbstract::getResultWarn