class SiteAuditCheckExtensionsSecurity in Site Audit 7

Class SiteAuditCheckExtensionsSecurity.

Hierarchy

• class \SiteAuditCheckAbstract
  • class \SiteAuditCheckExtensionsSecurity

File

Check/Extensions/Security.php, line 10

Contains \SiteAudit\Check\Extensions\Security.

class SiteAuditCheckExtensionsSecurity extends SiteAuditCheckAbstract {

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

  /**
   * Implements \SiteAudit\Check\Abstract\getDescription().
   */
  public function getDescription() {
    return dt('Determine what projects should be updated due to security concerns.');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultFail().
   */
  public function getResultFail() {
    $ret_val = 'The following project(s) have security releases available:';
    if (drush_get_option('html')) {
      $ret_val = '<p>' . $ret_val . '</p>';
      $ret_val .= '<table class="table table-condensed">';
      $ret_val .= '<thead><tr><th>' . dt('Name') . '</th><th>' . dt('Existing') . '</th><th>' . dt('Candidate') . '</th></thead>';
      $ret_val .= '<tbody>';
      foreach ($this->registry['projects_security'] as $short_info) {
        $ret_val .= '<tr>';
        $ret_val .= '<td>' . $short_info['label'] . '</td>';
        $ret_val .= '<td>' . $short_info['existing_version'] . '</td>';
        $ret_val .= '<td>' . $short_info['candidate_version'] . '</td>';
        $ret_val .= '</tr>';
      }
      $ret_val .= '</tbody>';
      $ret_val .= '</table>';
    }
    else {
      foreach ($this->registry['projects_security'] as $short_info) {
        $ret_val .= PHP_EOL;
        if (!drush_get_option('json')) {
          $ret_val .= str_repeat(' ', 6);
        }
        $ret_val .= "- {$short_info['label']}: {$short_info['existing_version']} to {$short_info['candidate_version']}";
      }
    }
    return $ret_val;
  }

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

  /**
   * Implements \SiteAudit\Check\Abstract\getResultPass().
   */
  public function getResultPass() {
    return dt('No projects have security releases.');
  }

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

  /**
   * Implements \SiteAudit\Check\Abstract\getAction().
   */
  public function getAction() {
    return dt('As a top priority, back up your site, review each project change, ensure compatibility, then update affected project(s).');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\calculateScore().
   */
  public function calculateScore() {
    if (!empty($this->registry['projects_security'])) {
      return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_FAIL;
    }
    return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_PASS;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SiteAuditCheckAbstract::$abort	protected	property	Indicate that no other checks should be run after this check.
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::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::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.
SiteAuditCheckExtensionsSecurity::calculateScore	public	function	Implements \SiteAudit\Check\Abstract\calculateScore(). Overrides SiteAuditCheckAbstract::calculateScore
SiteAuditCheckExtensionsSecurity::getAction	public	function	Implements \SiteAudit\Check\Abstract\getAction(). Overrides SiteAuditCheckAbstract::getAction
SiteAuditCheckExtensionsSecurity::getDescription	public	function	Implements \SiteAudit\Check\Abstract\getDescription(). Overrides SiteAuditCheckAbstract::getDescription
SiteAuditCheckExtensionsSecurity::getLabel	public	function	Implements \SiteAudit\Check\Abstract\getLabel(). Overrides SiteAuditCheckAbstract::getLabel
SiteAuditCheckExtensionsSecurity::getResultFail	public	function	Implements \SiteAudit\Check\Abstract\getResultFail(). Overrides SiteAuditCheckAbstract::getResultFail
SiteAuditCheckExtensionsSecurity::getResultInfo	public	function	Implements \SiteAudit\Check\Abstract\getResultInfo(). Overrides SiteAuditCheckAbstract::getResultInfo
SiteAuditCheckExtensionsSecurity::getResultPass	public	function	Implements \SiteAudit\Check\Abstract\getResultPass(). Overrides SiteAuditCheckAbstract::getResultPass
SiteAuditCheckExtensionsSecurity::getResultWarn	public	function	Implements \SiteAudit\Check\Abstract\getResultWarn(). Overrides SiteAuditCheckAbstract::getResultWarn