You are here

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

class ViewsCacheOutput in Site Audit 8.3

Provides the ViewsCacheOutput Check.

Plugin annotation


@SiteAuditCheck(
 id = "views_cache_output",
 name = @Translation("Rendered output caching"),
 description = @Translation("Check to see if raw rendered output is being cached."),
 report = "views"
)

Hierarchy

Expanded class hierarchy of ViewsCacheOutput

File

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

Namespace

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

  /**
   * {@inheritdoc}.
   */
  public function getResultFail() {
    return $this
      ->t('No View is caching rendered output!');
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
    return $this
      ->getResultWarn();
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
    return $this
      ->t('Every View is caching rendered output.');
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultWarn() {
    return $this
      ->t('The following Views are not caching rendered output: @views_without_output_caching', [
      '@views_without_output_caching' => implode(', ', $this->registry->views_without_output_caching),
    ]);
  }

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
    if (!in_array($this->score, [
      SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO,
      SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS,
    ])) {
      $ret_val = $this
        ->t('Rendered output should be cached for as long as possible (if the query changes, the output will be refreshed).');
      $steps = [
        $this
          ->t('Go to /admin/structure/views/'),
        $this
          ->t('Edit the View in question'),
        $this
          ->t('Select the Display'),
        $this
          ->t('Click Advanced'),
        $this
          ->t('Next to Caching, click to edit.'),
        $this
          ->t('Caching: (something other than None)'),
      ];
      $ret_val = [
        '#theme' => 'item_list',
        '#title' => $this
          ->t('Rendered output should be cached for as long as possible (if the query changes, the output will be refreshed).'),
        // '#description' => $this->t(),
        '#items' => $steps,
        '#list_type' => 'ol',
      ];
      return $ret_val;
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {
    $this->registry->output_lifespan = [];
    if (empty($this->registry->views)) {
      $this
        ->checkInvokeCalculateScore('views_count');
    }
    foreach ($this->registry->views as $view) {

      // Skip views used for administration purposes.
      if (in_array($view
        ->get('tag'), [
        'admin',
        'commerce',
      ])) {
        continue;
      }
      foreach ($view
        ->get('display') as $display_name => $display) {
        if (!isset($display['display_options']['enabled']) || $display['display_options']['enabled']) {

          // Default display OR overriding display.
          if (isset($display['display_options']['cache'])) {
            if ($display['display_options']['cache']['type'] == 'none' || $display['display_options']['cache'] == '') {
              if ($display_name == 'default') {
                $this->registry->output_lifespan[$view
                  ->get('id')]['default'] = 'none';
              }
              else {
                $this->registry->output_lifespan[$view
                  ->get('id')]['displays'][$display_name] = 'none';
              }
            }
            elseif ($display['display_options']['cache']['type'] == 'time') {
              if ($display['display_options']['cache']['options']['output_lifespan'] == 0) {
                $lifespan = $display['display_options']['cache']['options']['output_lifespan_custom'];
              }
              else {
                $lifespan = $display['display_options']['cache']['options']['output_lifespan'];
              }
              if ($lifespan < 1) {
                $lifespan = 'none';
              }
              if ($display_name == 'default') {
                $this->registry->output_lifespan[$view
                  ->get('id')]['default'] = $lifespan;
              }
              else {
                $this->registry->output_lifespan[$view
                  ->get('id')]['displays'][$display_name] = $lifespan;
              }
            }
            elseif ($display['display_options']['cache']['type'] == 'tag') {
              if ($display_name == 'default') {
                $this->registry->output_lifespan[$view
                  ->get('id')]['default'] = 'tag';
              }
              else {
                $this->registry->output_lifespan[$view
                  ->get('id')]['displays'][$display_name] = 'tag';
              }
            }
          }
          else {
            $this->registry->output_lifespan[$view
              ->get('id')]['displays'][$display_name] = 'default';
          }
        }
      }
    }
    $this->registry->views_without_output_caching = [];
    foreach ($this->registry->output_lifespan as $view_name => $view_data) {

      // Views with only master display.
      if (!isset($view_data['displays']) || count($view_data['displays']) == 0) {
        if ($view_data['default'] == 'none') {
          $this->registry->views_without_output_caching[] = $view_name;
        }
      }
      else {

        // If all the displays are default, consolidate.
        $all_default_displays = TRUE;
        foreach ($view_data['displays'] as $display_name => $lifespan) {
          if ($lifespan != 'default') {
            $all_default_displays = FALSE;
          }
        }
        if ($all_default_displays) {
          if (isset($view_data['default'])) {
            if ($view_data['default'] == 'none') {
              $this->registry->views_without_output_caching[] = $view_name;
            }
          }
        }
        else {
          $uncached_view_string = $view_name;
          $uncached_view_displays = [];
          foreach ($view_data['displays'] as $display_name => $display_data) {
            if ($display_data == 'none' || $display_data == 'default' && $view_data['default'] == 'none') {
              $uncached_view_displays[] = $display_name;
            }
          }
          if (!empty($uncached_view_displays)) {
            $uncached_view_string .= ' (' . implode(', ', $uncached_view_displays) . ')';
            $this->registry->views_without_output_caching[] = $uncached_view_string;
          }
        }
      }
    }
    if (count($this->registry->views_without_output_caching) == 0) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
    }
    if (site_audit_env_is_dev()) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO;
    }
    if (count($this->registry->views_without_output_caching) == count($this->registry->views)) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
  }

}

Members

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