class SiteAuditCheckBlockCacheReport in Site Audit 7

Class SiteAuditCheckBlockCacheReport.

Hierarchy

• class \SiteAuditCheckAbstract
  • class \SiteAuditCheckBlockCacheReport

File

Check/Block/CacheReport.php, line 10

Contains \SiteAudit\Check\Block\CacheReport.

class SiteAuditCheckBlockCacheReport extends SiteAuditCheckAbstract {

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

  /**
   * Implements \SiteAudit\Check\Abstract\getDescription().
   */
  public function getDescription() {
    return dt('Individual block cache settings.');
  }

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

  /**
   * Implements \SiteAudit\Check\Abstract\getResultInfo().
   */
  public function getResultInfo() {
    if (drush_get_option('html')) {
      $ret_val = '<table class="table table-condensed">';
      $ret_val .= '<thead><tr><th>' . dt('Module') . '</th><th>' . dt('Block') . '</th><th>' . dt('State') . '</th></tr></thead>';
      $ret_val .= '<tbody>';
      foreach ($this->registry['blocks'] as $block) {
        $ret_val .= '<tr>';
        $ret_val .= '<td>' . $block['module'] . '</td>';
        $ret_val .= '<td>' . $block['info'] . '</td>';
        $ret_val .= '<td>' . $block['state'] . '</td>';
        $ret_val .= '</tr>';
      }
      $ret_val .= '</tbody>';
      $ret_val .= '</table>';
    }
    else {
      $ret_val = dt('Module - Info: State') . PHP_EOL;
      if (!drush_get_option('json')) {
        $ret_val .= str_repeat(' ', 4);
      }
      $ret_val .= '--------------------';
      foreach ($this->registry['blocks'] as $block) {
        $ret_val .= PHP_EOL;
        if (!drush_get_option('json')) {
          $ret_val .= str_repeat(' ', 4);
        }
        $ret_val .= "{$block['module']} - {$block['info']}: {$block['state']}";
      }
    }
    return $ret_val;
  }

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

  /**
   * Implements \SiteAudit\Check\Abstract\getResultWarn().
   */
  public function getResultWarn() {
    return dt('There are no enabled blocks. You should disable the Block module or enable some blocks.');
  }

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

  /**
   * Implements \SiteAudit\Check\Abstract\calculateScore().
   */
  public function calculateScore() {
    $blocks = _block_rehash($this->registry['theme_default']);

    // Only check enabled blocks.
    foreach ($blocks as $bid => $block) {
      if ($block['region'] == -1) {
        unset($blocks[$bid]);
      }
    }

    // Make sure there are blocks to check.
    if (empty($blocks)) {
      $this->abort = TRUE;
      return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_WARN;
    }

    // Human readable order.
    usort($blocks, function ($a, $b) {
      return strcmp($a['module'] . $a['delta'], $b['module'] . $b['delta']);
    });
    $this->registry['blocks'] = array();
    foreach ($blocks as $block) {
      $this->registry['blocks'][] = array(
        'module' => $block['module'],
        'info' => $block['info'],
        'state' => $this
          ->getCacheStateLabel($block['cache']),
      );
    }
    return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO;
  }

  /**
   * Render a block cache state.
   *
   * @param int $state
   *   Drupal block caching state.
   *
   * @return string
   *   Human readable label.
   */
  public function getCacheStateLabel($state) {
    $label = dt('Unknown');
    switch ($state) {
      case DRUPAL_NO_CACHE:
        $label = dt('None');
        break;
      case DRUPAL_CACHE_CUSTOM:
        $label = dt('Custom');
        break;
      case DRUPAL_CACHE_PER_ROLE:
        $label = dt('Role');
        break;
      case DRUPAL_CACHE_PER_USER:
        $label = dt('User');
        break;
      case DRUPAL_CACHE_PER_PAGE:
        $label = dt('Page');
        break;
      case DRUPAL_CACHE_GLOBAL:
        $label = dt('Global');
        break;
    }
    return $label;
  }

}

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.
SiteAuditCheckBlockCacheReport::calculateScore	public	function	Implements \SiteAudit\Check\Abstract\calculateScore(). Overrides SiteAuditCheckAbstract::calculateScore
SiteAuditCheckBlockCacheReport::getAction	public	function	Implements \SiteAudit\Check\Abstract\getAction(). Overrides SiteAuditCheckAbstract::getAction
SiteAuditCheckBlockCacheReport::getCacheStateLabel	public	function	Render a block cache state.
SiteAuditCheckBlockCacheReport::getDescription	public	function	Implements \SiteAudit\Check\Abstract\getDescription(). Overrides SiteAuditCheckAbstract::getDescription
SiteAuditCheckBlockCacheReport::getLabel	public	function	Implements \SiteAudit\Check\Abstract\getLabel(). Overrides SiteAuditCheckAbstract::getLabel
SiteAuditCheckBlockCacheReport::getResultFail	public	function	Implements \SiteAudit\Check\Abstract\getResultFail(). Overrides SiteAuditCheckAbstract::getResultFail
SiteAuditCheckBlockCacheReport::getResultInfo	public	function	Implements \SiteAudit\Check\Abstract\getResultInfo(). Overrides SiteAuditCheckAbstract::getResultInfo
SiteAuditCheckBlockCacheReport::getResultPass	public	function	Implements \SiteAudit\Check\Abstract\getResultPass(). Overrides SiteAuditCheckAbstract::getResultPass
SiteAuditCheckBlockCacheReport::getResultWarn	public	function	Implements \SiteAudit\Check\Abstract\getResultWarn(). Overrides SiteAuditCheckAbstract::getResultWarn