public function CredentialCheck::run in Fastly 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

modules/fastlypurger/src/Plugin/Purge/DiagnosticCheck/CredentialCheck.php, line 73

Class

CredentialCheck: Checks if valid Api credentials have been entered for Fastly.

Namespace

Drupal\fastlypurger\Plugin\Purge\DiagnosticCheck

Code

public function run() {

  // This runs on every page - probably want to avoid a web service call here.
  //
  // $valid_purge_credentials = (!empty($this->config->get('api_key')))
  // ? $this->state->validatePurgeCredentials($this->config->get('api_key'))
  // : FALSE;
  //
  // $this->state->setPurgeCredentialsState($valid_purge_credentials);
  $purge_credentials_state = $this->state
    ->getPurgeCredentialsState();
  if (!$purge_credentials_state) {
    $this->recommendation = $this
      ->t("Invalid Api credentials. Make sure the token you are trying has at least global:read, purge_select, and purge_all scopes.");
    return SELF::SEVERITY_ERROR;
  }
  $this->recommendation = $this
    ->t('Valid Api credentials detected.');
  return SELF::SEVERITY_OK;
}

You are here