You are here

Home » API reference » Background Process 8 » BackgroundProcessSettingsForm.php

class BackgroundProcessSettingsForm in Background Process 8

Default controller for the background_process module.

Hierarchy

Expanded class hierarchy of BackgroundProcessSettingsForm

1 string reference to 'BackgroundProcessSettingsForm'
background_process.routing.yml in ./background_process.routing.yml
background_process.routing.yml

File

src/Form/BackgroundProcessSettingsForm.php, line 12

Namespace

Drupal\background_process\Form
View source 
class BackgroundProcessSettingsForm extends ConfigFormBase {

  /**
   * Implements to Get Form ID.
   */
  public function getFormId() {
    return 'background_process_settings_form';
  }

  /**
   * Implements to Submit Form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('background_process.settings');
    foreach (Element::children($form) as $variable) {
      $config
        ->set($variable, $form_state
        ->getValue($form[$variable]['#parents']));
    }
    $config
      ->save();
    if (method_exists($this, '_submitForm')) {
      $this
        ->_submitForm($form, $form_state);
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * Implements to Get Editable Config Names.
   */
  protected function getEditableConfigNames() {
    return [
      'background_process.settings',
    ];
  }

  /**
   * Implements to Build Form.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = [];
    $form['background_process_service_timeout'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Service timeout'),
      '#description' => $this
        ->t('Timeout for service call in seconds (0 = disabled)'),
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_service_timeout'),
    ];
    $form['background_process_connection_timeout'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Connection timeout'),
      '#description' => $this
        ->t('Timeout for connection in seconds'),
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_connection_timeout'),
    ];
    $form['background_process_stream_timeout'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Stream timeout'),
      '#description' => $this
        ->t('Timeout for stream in seconds'),
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_stream_timeout'),
    ];
    $form['background_process_redispatch_threshold'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Redispatch threshold (for locked processes)'),
      '#description' => $this
        ->t('Seconds to wait before redispatching processes that never started.'),
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_redispatch_threshold'),
    ];
    $form['background_process_cleanup_age'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cleanup age (for locked processes)'),
      '#description' => $this
        ->t('Seconds to wait before unlocking processes that never started.'),
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_cleanup_age'),
    ];
    $form['background_process_cleanup_age_running'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cleanup age (for running processes)'),
      '#description' => $this
        ->t('Unlock processes that has been running for more than X seconds.'),
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_cleanup_age_running'),
    ];
    $form['background_process_cleanup_age_queue'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cleanup age for queued jobs'),
      '#description' => $this
        ->t('Unlock queued processes that have been more than X seconds to start.'),
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_cleanup_age_queue'),
    ];
    $options = background_process_get_service_hosts();
    global $base_url;
    foreach ($options as $key => &$value) {
      $new = empty($value['description']) ? $key : $value['description'];
      $base_url = empty($value['base_url']) ? $base_url : $value['base_url'];
      $http_host = empty($value['http_host']) ? parse_url($base_url, PHP_URL_HOST) : $value['http_host'];
      $new .= ' (' . $base_url . ' - ' . $http_host . ')';
      $value = $new;
    }
    if (!$value) {
      $value = $base_url;
    }
    $form['background_process_default_service_host'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default service host'),
      '#description' => $this
        ->t('The default service host to use'),
      '#options' => [
        $value,
      ],
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_default_service_host'),
    ];
    $form['background_process_ssl_verification'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('SSL verification'),
      '#description' => $this
        ->t("Don't turn this off on production environments, as it will raise security issues"),
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_ssl_verification'),
    ];
    $methods = \Drupal::moduleHandler()
      ->invokeAll('service_group');
    $options = background_process_get_service_groups();
    foreach ($options as $key => &$value) {
      $value = (empty($value['description']) ? $key : $value['description']) . ' (' . implode(',', $value['hosts']) . ') : ' . $methods['methods'][$value['method']];
    }
    $form['background_process_default_service_group'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default service group'),
      '#description' => $this
        ->t('The default service group to use.'),
      '#options' => $options,
      '#default_value' => \Drupal::config('background_process.settings')
        ->get('background_process_default_service_group'),
    ];
    $form = parent::buildForm($form, $form_state);

    // Add determine button and make sure all the buttons are shown last.
    $form['buttons']['#weight'] = 1000;
    $form['buttons']['determine'] = [
      '#value' => $this
        ->t("Determine default service host"),
      '#description' => $this
        ->t('Tries to determine the default service host.'),
      '#type' => 'submit',
      '#submit' => [
        'background_process_settings_form_determine_submit',
      ],
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BackgroundProcessSettingsForm::buildForm public function Implements to Build Form. Overrides ConfigFormBase::buildForm
BackgroundProcessSettingsForm::getEditableConfigNames protected function Implements to Get Editable Config Names. Overrides ConfigFormBaseTrait::getEditableConfigNames
BackgroundProcessSettingsForm::getFormId public function Implements to Get Form ID. Overrides FormInterface::getFormId
BackgroundProcessSettingsForm::submitForm public function Implements to Submit Form. Overrides ConfigFormBase::submitForm
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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.
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.