You are here

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

class CronEnabled in Site Audit 8.3

Provides the CronEnabled Check.

Plugin annotation


@SiteAuditCheck(
 id = "cron_enabled",
 name = @Translation("Enabled"),
 description = @Translation("Check to see if cron is scheduled to run."),
 report = "cron"
)

Hierarchy

Expanded class hierarchy of CronEnabled

File

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

Namespace

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

  /**
   * {@inheritdoc}.
   */
  public function getResultFail() {
    return $this
      ->t('You have disabled cron, which will prevent routine system tasks from executing.');
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {

    // Manual execution.
    if ($this->registry->cron_safe_threshold === 0) {
      return $this
        ->t('Drupal Cron frequency is set to never, but has been executed within the past 24 hours (either manually or using drush cron).');
    }

    // Default.
    return $this
      ->t('Cron is set to run every @minutes minutes.', [
      '@minutes' => round($this->registry->cron_safe_threshold / 60),
    ]);
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultWarn() {
    if ($this->registry->cron_safe_threshold > 24 * 60 * 60) {
      return $this
        ->t('Drupal Cron frequency is set to mare than 24 hours.');
    }
    else {
      return $this
        ->t('Drupal Cron has not run in the past day even though it\'s frequency has been set to less than 24 hours.');
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
    if ($this->score == SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL) {
      return $this
        ->t('Please visit /admin/config/system/cron and set the cron frequency to something other than Never but less than 24 hours.');
    }
    elseif ($this->score == SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN) {
      if ($this->registry->cron_safe_threshold > 24 * 60 * 60) {
        return $this
          ->t('Please visit /admin/config/system/cron and set the cron frequency to something less than 24 hours.');
      }
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {

    // Determine when cron last ran.
    $this->registry->cron_last = \Drupal::state()
      ->get('system.cron_last');
    $this->registry->cron_safe_threshold = \Drupal::config('system.cron')
      ->get('threshold.autorun');

    // Cron hasn't run in the past day.
    if (time() - $this->registry->cron_last > 24 * 60 * 60) {
      if ($this->registry->cron_safe_threshold === 0) {
        return SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL;
      }
      else {
        return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
      }
    }
    elseif ($this->registry->cron_safe_threshold > 24 * 60 * 60) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
  }

}

Members

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