You are here

Home » API reference » Purge 8.3 » MaxAgeCheck.php

class MaxAgeCheck in Purge 8.3

Tests if the TTL of your site is in a good shape.

Plugin annotation


@PurgeDiagnosticCheck(
  id = "maxage",
  title = @Translation("Page cache max age"),
  description = @Translation("Tests if the TTL of your site is in a good shape."),
  dependent_queue_plugins = {},
  dependent_purger_plugins = {}
)

Hierarchy

Expanded class hierarchy of MaxAgeCheck

File

src/Plugin/Purge/DiagnosticCheck/MaxAgeCheck.php, line 19

Namespace

Drupal\purge\Plugin\Purge\DiagnosticCheck
View source 
class MaxAgeCheck extends DiagnosticCheckBase implements DiagnosticCheckInterface {

  /**
   * A config object for the system performance configuration.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * Construct a MaxAgeCheck object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   */
  public final function __construct(ConfigFactoryInterface $config_factory, array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->config = $config_factory
      ->get('system.performance');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($container
      ->get('config.factory'), $configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function run() {
    $max_age = $this->config
      ->get('cache.page.max_age');
    $this->value = $this
      ->valueTranslatable($max_age);
    if ($max_age === 0) {
      $this->recommendation = $this
        ->t("Your site instructs external caching systems not to cache anything. Not only does this make cache invalidation futile, it is also a great danger to your website as any form of traffic can bring it down quickly!");
      return self::SEVERITY_WARNING;
    }
    elseif ($max_age < 300) {
      $this->recommendation = $this
        ->t("TTL settings below 5 minutes are very dangerous, as sudden traffic increases will quickly reach your webserver(s) and bring Drupal down.");
      return self::SEVERITY_WARNING;
    }
    elseif ($max_age < 86400) {
      $this->recommendation = $this
        ->t("TTL settings under 24 hours are dangerous, as sudden traffic increases will quickly reach your webserver(s) and can make Drupal slow.");
      return self::SEVERITY_WARNING;
    }
    elseif ($max_age < 2764800) {
      $this->recommendation = $this
        ->t("TTL settings under a month are not recommended, the longer you set it, the better your site will perform!");
      return self::SEVERITY_WARNING;
    }
    elseif ($max_age < 31536000) {
      $this->recommendation = $this
        ->t("Consider increasing your TTL to over a year, the better your site will perform!");
      return self::SEVERITY_OK;
    }
    else {
      $this->recommendation = $this
        ->t("Your TTL setting is great!");
      return self::SEVERITY_OK;
    }
  }

  /**
   * Return a user-facing string that represents the given max_age value.
   *
   * @param int $max_age
   *   The max_age setting to format.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The translated value.
   */
  protected function valueTranslatable($max_age) {
    if ($max_age === 0) {
      return $this
        ->t('no caching');
    }
    elseif ($max_age === 60) {
      return $this
        ->t('1 minute');
    }
    elseif ($max_age < 3600) {
      return $this
        ->t('@num minutes', [
        '@num' => round($max_age / 60),
      ]);
    }
    elseif ($max_age === 3600) {
      return $this
        ->t('1 hour');
    }
    elseif ($max_age < 86400) {
      return $this
        ->t('@num hours', [
        '@num' => round($max_age / 3600, 1),
      ]);
    }
    elseif ($max_age === 86400) {
      return $this
        ->t('1 day');
    }
    elseif ($max_age < 604800) {
      return $this
        ->t('@num days', [
        '@num' => round($max_age / 86400, 1),
      ]);
    }
    elseif ($max_age === 604800) {
      return $this
        ->t('1 week');
    }
    elseif ($max_age < 2764800) {
      return $this
        ->t('@num weeks', [
        '@num' => round($max_age / 604800, 1),
      ]);
    }
    elseif ($max_age === 2764800) {
      return $this
        ->t('1 month');
    }
    elseif ($max_age < 31536000) {
      return $this
        ->t('@num months', [
        '@num' => round($max_age / 2764800, 1),
      ]);
    }
    elseif ($max_age === 31536000) {
      return $this
        ->t('1 year');
    }
    return $this
      ->t('more than 1 year');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DiagnosticCheckBase::$description private property The description of the check as described in the plugin's metadata.
DiagnosticCheckBase::$recommendation protected property A recommendation matching the severity level, may contain NULL.
DiagnosticCheckBase::$severity private property The severity of the outcome of this check.
DiagnosticCheckBase::$title private property The title of the check as described in the plugin's metadata.
DiagnosticCheckBase::$value protected property Optional check outcome / value (e.g. version numbers), may contain NULL.
DiagnosticCheckBase::getDescription public function Gets the description of the check. Overrides DiagnosticCheckInterface::getDescription
DiagnosticCheckBase::getRecommendation public function Get a recommendation matching the severity level, may return NULL. Overrides DiagnosticCheckInterface::getRecommendation
DiagnosticCheckBase::getRequirementsArray public function Generates a individual Drupal-like requirements array. Overrides DiagnosticCheckInterface::getRequirementsArray
DiagnosticCheckBase::getRequirementsSeverity public function Get the severity level, expressed as a status_report severity. Overrides DiagnosticCheckInterface::getRequirementsSeverity
DiagnosticCheckBase::getSeverity public function Get the severity level. Overrides DiagnosticCheckInterface::getSeverity
DiagnosticCheckBase::getSeverityString public function Get the severity level as unprefixed string. Overrides DiagnosticCheckInterface::getSeverityString
DiagnosticCheckBase::getTitle public function Gets the title of the check. Overrides DiagnosticCheckInterface::getTitle
DiagnosticCheckBase::getValue public function Get an optional value for the check output, may return NULL. Overrides DiagnosticCheckInterface::getValue
DiagnosticCheckBase::runCheck protected function Late runtime helper to assure that ::run() got called (and only once).
DiagnosticCheckInterface::SEVERITY_ERROR constant BLOCKING severity -- Error condition; purge.purgers service cannot operate.
DiagnosticCheckInterface::SEVERITY_INFO constant Non-blocking severity -- Informational message only.
DiagnosticCheckInterface::SEVERITY_OK constant Non-blocking severity -- check successfully passed.
DiagnosticCheckInterface::SEVERITY_WARNING constant Non-blocking severity -- Warning condition; proceed but flag warning.
MaxAgeCheck::$config protected property A config object for the system performance configuration.
MaxAgeCheck::create public static function Creates an instance of the plugin. Overrides DiagnosticCheckBase::create
MaxAgeCheck::run public function Perform the check and determine the severity level. Overrides DiagnosticCheckInterface::run
MaxAgeCheck::valueTranslatable protected function Return a user-facing string that represents the given max_age value.
MaxAgeCheck::__construct final public function Construct a MaxAgeCheck object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
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.