class ViewsCacheResults in Site Audit 8.3
Provides the ViewsCacheResults Check.
Plugin annotation
@SiteAuditCheck(
id = "views_cache_results",
name = @Translation("Query results caching"),
description = @Translation("Check to see if raw query results are being cached."),
report = "views"
)
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\ViewsCacheResults
- class \Drupal\site_audit\Plugin\SiteAuditCheckBase implements SiteAuditCheckInterface uses StringTranslationTrait
Expanded class hierarchy of ViewsCacheResults
File
- src/
Plugin/ SiteAuditCheck/ ViewsCacheResults.php, line 17
Namespace
Drupal\site_audit\Plugin\SiteAuditCheckView source
class ViewsCacheResults extends SiteAuditCheckBase {
/**
* {@inheritdoc}.
*/
public function getResultFail() {
return $this
->t('No View is caching query results!');
}
/**
* {@inheritdoc}.
*/
public function getResultInfo() {
return $this
->getResultWarn();
}
/**
* {@inheritdoc}.
*/
public function getResultPass() {
return $this
->t('Every View is caching query results.');
}
/**
* {@inheritdoc}.
*/
public function getResultWarn() {
return $this
->t('The following Views are not caching query results: @views_without_results_caching', [
'@views_without_results_caching' => implode(', ', $this->registry->views_without_results_caching),
]);
}
/**
* {@inheritdoc}.
*/
public function getAction() {
if (!in_array($this->score, [
SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO,
SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS,
])) {
$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)'),
];
return [
'#theme' => 'item_list',
'#title' => $this
->t('Query results should be cached for at least 1 minute or use tag caching.'),
// '#description' => $this->t(),
'#items' => $steps,
'#list_type' => 'ol',
];
}
}
/**
* {@inheritdoc}.
*/
public function calculateScore() {
$this->registry->results_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->results_lifespan[$view
->get('id')]['default'] = 'none';
}
else {
$this->registry->results_lifespan[$view
->get('id')]['displays'][$display_name] = 'none';
}
}
elseif ($display['display_options']['cache']['type'] == 'time') {
if ($display['display_options']['cache']['options']['results_lifespan'] == 0) {
$lifespan = $display['display_options']['cache']['options']['results_lifespan_custom'];
}
else {
$lifespan = $display['display_options']['cache']['options']['results_lifespan'];
}
if ($lifespan < 1) {
$lifespan = 'none';
}
if ($display_name == 'default') {
$this->registry->results_lifespan[$view
->get('id')]['default'] = $lifespan;
}
else {
$this->registry->results_lifespan[$view
->get('id')]['displays'][$display_name] = $lifespan;
}
}
elseif ($display['display_options']['cache']['type'] == 'tag') {
if ($display_name == 'default') {
$this->registry->results_lifespan[$view
->get('id')]['default'] = 'tag';
}
else {
$this->registry->results_lifespan[$view
->get('id')]['displays'][$display_name] = 'tag';
}
}
}
else {
$this->registry->results_lifespan[$view
->get('id')]['displays'][$display_name] = 'default';
}
}
}
}
$this->registry->views_without_results_caching = [];
foreach ($this->registry->results_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_results_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_results_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_results_caching[] = $uncached_view_string;
}
}
}
}
if (count($this->registry->views_without_results_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_results_caching) == count($this->registry->views)) {
return SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL;
}
return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
SiteAuditCheckBase:: |
protected | property | Names of checks that should not run as a result of this check. | |
SiteAuditCheckBase:: |
protected | property | Options passed in for reports and checks. | |
SiteAuditCheckBase:: |
protected | property | User has opted out of this check in configuration. | |
SiteAuditCheckBase:: |
protected | property | If set, will override the Report's percentage. | |
SiteAuditCheckBase:: |
protected | property | Use for passing data between checks within a report. | |
SiteAuditCheckBase:: |
protected | property | Quantifiable number associated with result on a scale of 0 to 2. | |
SiteAuditCheckBase:: |
protected | property | Are we in a static context. | |
SiteAuditCheckBase:: |
constant | |||
SiteAuditCheckBase:: |
constant | |||
SiteAuditCheckBase:: |
constant | |||
SiteAuditCheckBase:: |
constant | |||
SiteAuditCheckBase:: |
protected | function | Invoke another check's calculateScore() method if it is needed. | |
SiteAuditCheckBase:: |
public | function | Get a more verbose description of what is being checked. | |
SiteAuditCheckBase:: |
public | function | Get the ID or machine name for the check. | |
SiteAuditCheckBase:: |
public | function | Get the label for the check that describes, high level what is happening. | |
SiteAuditCheckBase:: |
public | function | Get the report percent override, if any. | |
SiteAuditCheckBase:: |
public | function | Get the check registry. | |
SiteAuditCheckBase:: |
public | function | Determine the result message based on the score. | |
SiteAuditCheckBase:: |
public | function | Get a quantifiable number representing a check result; lazy initialization. | |
SiteAuditCheckBase:: |
public | function | Get a human readable label for a score. | |
SiteAuditCheckBase:: |
public | function | Display action items for a user to perform. | |
SiteAuditCheckBase:: |
public | function | Determine whether the check failed so badly that the report must stop. | |
SiteAuditCheckBase:: |
public | function |
Constructor. Overrides PluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
ViewsCacheResults:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
ViewsCacheResults:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
ViewsCacheResults:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
ViewsCacheResults:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
ViewsCacheResults:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
ViewsCacheResults:: |
public | function |
. Overrides SiteAuditCheckBase:: |