You are here

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

class BackgroundBatchSettingsForm in Background Process 8

Default controller for the background_batch module.

Hierarchy

Expanded class hierarchy of BackgroundBatchSettingsForm

1 string reference to 'BackgroundBatchSettingsForm'
background_batch.routing.yml in background_batch/background_batch.routing.yml
background_batch/background_batch.routing.yml

File

background_batch/src/Form/BackgroundBatchSettingsForm.php, line 12

Namespace

Drupal\background_batch\Form
View source 
class BackgroundBatchSettingsForm extends ConfigFormBase {

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

  /**
   * Implements When Submit Form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('background_batch.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 From Config Files.
   */
  protected function getEditableConfigNames() {
    return [
      'background_batch.settings',
    ];
  }

  /**
   * Implements to Build the Batch Form.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = [];
    $form['background_batch_delay'] = [
      '#type' => 'textfield',
      '#default_value' => \Drupal::config('background_batch.settings')
        ->get('background_batch_delay'),
      '#title' => 'Delay',
      '#description' => $this
        ->t('Time in microseconds for progress refresh'),
    ];
    $form['background_batch_process_lifespan'] = [
      '#type' => 'textfield',
      '#default_value' => \Drupal::config('background_batch.settings')
        ->get('background_batch_process_lifespan'),
      '#title' => 'Process lifespan',
      '#description' => $this
        ->t('Time in milliseconds for progress lifespan'),
    ];
    $form['background_batch_show_eta'] = [
      '#type' => 'checkbox',
      '#default_value' => \Drupal::config('background_batch.settings')
        ->get('background_batch_show_eta'),
      '#title' => 'Show ETA of batch process',
      '#description' => $this
        ->t('Whether ETA (estimated time of arrival) information should be shown'),
    ];
    return parent::buildForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BackgroundBatchSettingsForm::buildForm public function Implements to Build the Batch Form. Overrides ConfigFormBase::buildForm
BackgroundBatchSettingsForm::getEditableConfigNames protected function Implements to Get Editable Config Names From Config Files. Overrides ConfigFormBaseTrait::getEditableConfigNames
BackgroundBatchSettingsForm::getFormId public function Implements to Get Form ID. Overrides FormInterface::getFormId
BackgroundBatchSettingsForm::submitForm public function Implements When 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.