You are here

Home » API reference » Scheduler 8 » SchedulerCronForm.php

class SchedulerCronForm in Scheduler 8

Same name and namespace in other branches
  1. 2.x src/Form/SchedulerCronForm.php \Drupal\scheduler\Form\SchedulerCronForm

Scheduler Lightweight Cron form.

Hierarchy

Expanded class hierarchy of SchedulerCronForm

1 string reference to 'SchedulerCronForm'
scheduler.routing.yml in ./scheduler.routing.yml
scheduler.routing.yml

File

src/Form/SchedulerCronForm.php, line 16

Namespace

Drupal\scheduler\Form
View source 
class SchedulerCronForm extends ConfigFormBase {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The scheduler manager service.
   *
   * @var \Drupal\scheduler\SchedulerManager
   */
  protected $schedulerManager;

  /**
   * Creates a SchedulerCronForm instance.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @var \Drupal\scheduler\SchedulerManager $scheduler_manager
   *   The scheduler manager service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $module_handler, SchedulerManager $scheduler_manager) {
    parent::__construct($config_factory);
    $this->moduleHandler = $module_handler;
    $this->schedulerManager = $scheduler_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('module_handler'), $container
      ->get('scheduler.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'scheduler_cron_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'scheduler.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('scheduler.settings');
    $form['cron_settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Lightweight cron settings'),
    ];
    $form['cron_settings']['lightweight_log'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Log every activation and completion message.'),
      '#default_value' => $config
        ->get('log'),
      '#description' => $this
        ->t('When this option is checked, Scheduler will write an entry to the log every time the lightweight cron process is started and completed. This is useful during set up and testing, but can result in a large number of log entries. Any actions performed during the lightweight cron run will always be logged regardless of this setting.'),
    ];
    $form['cron_settings']['lightweight_access_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Lightweight cron access key'),
      '#default_value' => $config
        ->get('lightweight_cron_access_key'),
      '#required' => TRUE,
      '#size' => 25,
      '#description' => $this
        ->t("Similar to Drupal's cron key this acts as a security token to prevent unauthorised calls to scheduler/cron. The key should be passed as scheduler/cron/{access key}"),
    ];

    // Add a submit handler function for the key generation.
    $form['cron_settings']['create_key'][] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Generate new random key'),
      '#submit' => [
        '::generateRandomKey',
      ],
      // No validation at all is required in the equivocate case, so
      // we include this here to make it skip the form-level validator.
      '#validate' => [],
    ];

    // Add a submit handler function for the form.
    $form['buttons']['submit_cron'][] = [
      '#type' => 'submit',
      '#prefix' => $this
        ->t("You can test Scheduler's lightweight cron process interactively"),
      '#value' => $this
        ->t("Run Scheduler's lightweight cron now"),
      '#submit' => [
        '::runLightweightCron',
      ],
      // No validation at all is required in the equivocate case, so
      // we include this here to make it skip the form-level validator.
      '#validate' => [],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('scheduler.settings');
    $config
      ->set('log', $form_state
      ->getValue('lightweight_log'));
    $config
      ->set('lightweight_cron_access_key', $form_state
      ->getValue('lightweight_access_key'));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Form submission handler for the random key generation.
   *
   * This only fires when the 'Generate new random key' button is clicked.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function generateRandomKey(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('scheduler.settings');
    $config
      ->set('lightweight_cron_access_key', substr(md5(rand()), 0, 20));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Form submission handler to run the lightweight cron.
   *
   * This only fires when "Run Scheduler's lightweight cron now" is clicked.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function runLightweightCron(array &$form, FormStateInterface $form_state) {
    $this->schedulerManager
      ->runLightweightCron([
      'admin_form' => TRUE,
    ]);
    if ($this->moduleHandler
      ->moduleExists('dblog')) {
      $url = Url::fromRoute('dblog.overview')
        ->toString();
      $message = $this
        ->t('Lightweight cron run completed. See the <a href="@url">log</a> for details.', [
        '@url' => $url,
      ]);
    }
    else {

      // If the Database Logging module is not enabled the route to the log
      // overview does not exist. Show a simple status message.
      $message = $this
        ->t('Lightweight cron run completed.');
    }
    $this
      ->messenger()
      ->addMessage($message);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SchedulerCronForm::$moduleHandler protected property The module handler service.
SchedulerCronForm::$schedulerManager protected property The scheduler manager service.
SchedulerCronForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SchedulerCronForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SchedulerCronForm::generateRandomKey public function Form submission handler for the random key generation.
SchedulerCronForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SchedulerCronForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SchedulerCronForm::runLightweightCron public function Form submission handler to run the lightweight cron.
SchedulerCronForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SchedulerCronForm::__construct public function Creates a SchedulerCronForm instance. Overrides ConfigFormBase::__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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.