public function GeneralSettingsForm::buildForm in Ultimate Cron 8.2

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/GeneralSettingsForm.php, line 81

Class

GeneralSettingsForm

Form for general cron settings.

Namespace

Drupal\ultimate_cron\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('ultimate_cron.settings');

  // Setup vertical tabs.
  $form['settings_tabs'] = [
    '#type' => 'vertical_tabs',
  ];

  // @todo enable this when supported again
  $form['nodejs'] = array(
    '#type' => 'checkbox',
    '#title' => t('nodejs'),
    '#default_value' => $config
      ->get('nodejs'),
    '#description' => t('Enable nodejs integration (Live reload on jobs page. Requires the nodejs module to be installed and configured).'),
    '#fallback' => TRUE,
    '#access' => FALSE,
  );

  // Queue settings. Visual hierarchy disabled since this is currently
  // the only general settings group.
  $form['queue'] = [
    //'#type' => 'details',

    //'#title' => 'queue',

    //'#group' => 'settings_tabs',
    '#tree' => TRUE,
  ];
  $form['queue']['enabled'] = array(
    '#title' => t('Override cron queue processing'),
    '#description' => t('If enabled, queue workers are exposed as cron jobs and can be configured separately. When disabled, the standard queue processing is used. <strong>This feature is currently experimental, do not enable unless you need it.</strong>'),
    '#type' => 'checkbox',
    '#default_value' => $config
      ->get('queue.enabled'),
    '#fallback' => TRUE,
  );
  $queue_states = array(
    '#states' => array(
      'visible' => array(
        ':input[name="queue[enabled]"]' => array(
          'checked' => TRUE,
        ),
      ),
    ),
  );
  $form['queue']['timeouts'] = array(
    '#type' => 'fieldset',
    '#title' => t('Timeouts'),
  ) + $queue_states;
  $form['queue']['timeouts']['lease_time'] = array(
    '#title' => t("Queue lease time"),
    '#type' => 'number',
    '#default_value' => $config
      ->get('queue.timeouts.lease_time'),
    '#description' => t('Seconds to claim a cron queue item.'),
    '#fallback' => TRUE,
    '#required' => TRUE,
    '#min' => 0,
    '#step' => 0.01,
  );
  $form['queue']['timeouts']['time'] = array(
    '#title' => t('Time'),
    '#type' => 'number',
    '#default_value' => $config
      ->get('queue.timeouts.time'),
    '#description' => t('Time in seconds to process items during a cron run.'),
    '#fallback' => TRUE,
    '#required' => TRUE,
    '#min' => 0,
    '#step' => 0.01,
  );
  $form['queue']['delays'] = array(
    '#type' => 'fieldset',
    '#title' => t('Delays'),
  ) + $queue_states;
  $form['queue']['delays']['empty_delay'] = array(
    '#title' => t("Empty delay"),
    '#type' => 'number',
    '#default_value' => $config
      ->get('queue.delays.empty_delay'),
    '#description' => t('Seconds to delay processing of queue if queue is empty (0 = end job).'),
    '#fallback' => TRUE,
    '#required' => TRUE,
    '#min' => 0,
    '#step' => 0.01,
  );
  $form['queue']['delays']['item_delay'] = array(
    '#title' => t("Item delay"),
    '#type' => 'number',
    '#default_value' => $config
      ->get('queue.delays.item_delay'),
    '#description' => t('Seconds to wait between processing each item in a queue.'),
    '#fallback' => TRUE,
    '#required' => TRUE,
    '#min' => 0,
    '#step' => 0.01,
  );
  $throttle_states = array(
    '#states' => array(
      'visible' => array(
        ':input[name="queue[throttle][enabled]"]' => array(
          'checked' => TRUE,
        ),
      ),
    ),
  );
  $form['queue']['throttle'] = array(
    '#type' => 'fieldset',
    '#title' => t('Throttling'),
    // @todo Show when throttling is implemented.
    '#access' => FALSE,
  ) + $queue_states;
  $form['queue']['throttle']['enabled'] = array(
    '#title' => t('Throttle'),
    '#type' => 'checkbox',
    '#default_value' => $config
      ->get('queue.throttle.enabled'),
    '#description' => t('Throttle queues using multiple threads.'),
  );
  $form['queue']['throttle']['threads'] = array(
    '#title' => t('Threads'),
    '#type' => 'number',
    '#default_value' => $config
      ->get('queue.throttle.threads'),
    '#description' => t('Number of threads to use for queues.'),
    '#fallback' => TRUE,
    '#required' => TRUE,
    '#min' => 0,
  ) + $throttle_states;
  $form['queue']['throttle']['threshold'] = array(
    '#title' => t('Threshold'),
    '#type' => 'number',
    '#default_value' => $config
      ->get('queue.throttle.threshold'),
    '#description' => t('Number of items in queue required to activate the next cron job.'),
    '#fallback' => TRUE,
    '#required' => TRUE,
    '#min' => 0,
  ) + $throttle_states;
  return parent::buildForm($form, $form_state);
}