public function PageCacheCheck::run in Purge 8.3

Perform the check and determine the severity level.

Diagnostic checks determine whether something you are checking for is in shape, for instance CMI settings on which your plugin depends. Any check reporting self::SEVERITY_ERROR in their run() methods, will cause purge to stop working. Any other severity level will let the purgers proceed operating but you may report any warning through getRecommendation() to be shown on Drupal's status report, purge_ui or any other diagnostic listing.


public function run() {
  if (...check..) {
    return self::SEVERITY_OK;
  }
  return self::SEVERITY_WARNING;
}

@warning As diagnostic checks can be expensive, this method is called as rarely as possible. Checks derived from DiagnosticCheckBase will only see the check getting executed when any of the getter methods are called.

Return value

int Integer, matching either of the following constants:

Throws

\Drupal\purge\Plugin\Purge\DiagnosticCheck\Exception\CheckNotImplementedCorrectly Thrown when the return value is incorrect.

Overrides DiagnosticCheckInterface::run

File

src/Plugin/Purge/DiagnosticCheck/PageCacheCheck.php, line 60

Class

PageCacheCheck: Tests if the page_cache module is installed.

Namespace

Drupal\purge\Plugin\Purge\DiagnosticCheck

Code

public function run() {
  $this->value = $this
    ->t('installed');

  // Test for the page_cache module, which is required for cache invalidation.
  if (!$this->moduleHandler
    ->moduleExists('page_cache')) {
    $this->value = '';
    $this->recommendation = $this
      ->t("Please install the page_cache module. The page cache acts as a 'second layer of defence' by keeping copies of all generated pages, which protects you from widespread performance degradation in case of emergencies.");
    return self::SEVERITY_WARNING;
  }
  return self::SEVERITY_OK;
}

You are here