public function SchedulerCronForm::buildForm in Scheduler 2.x

Same name and namespace in other branches

1. 8 src/Form/SchedulerCronForm.php \Drupal\scheduler\Form\SchedulerCronForm::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/SchedulerCronForm.php, line 76

Class

SchedulerCronForm

Scheduler Lightweight Cron form.

Namespace

Drupal\scheduler\Form

Code

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);
}