You are here

Home » API reference » Webform Scheduled Tasks 8 » WebformSanitizeConfigForm.php

class WebformSanitizeConfigForm in Webform Scheduled Tasks 8

Webform Sanitize config form.

Hierarchy

Expanded class hierarchy of WebformSanitizeConfigForm

1 string reference to 'WebformSanitizeConfigForm'
webform_scheduled_tasks.routing.yml in ./webform_scheduled_tasks.routing.yml
webform_scheduled_tasks.routing.yml

File

src/Form/WebformSanitizeConfigForm.php, line 11

Namespace

Drupal\webform_scheduled_tasks\Form
View source 
class WebformSanitizeConfigForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   *
   * @param array $form
   *   The parameters to use to work out the value.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The parameters to use to work out the value.
   *
   * @return array
   *   The form definition.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->get('webform_scheduled_tasks.config');
    $form['description'] = [
      '#markup' => $this
        ->t('Use this form to configure Webform Scheduled Tasks.'),
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    ];
    $form['settings'] = [
      '#type' => 'details',
      '#tree' => TRUE,
      '#open' => TRUE,
      '#title' => $this
        ->t('Webform Scheduled Tasks Settings'),
    ];
    $form['settings']['description'] = [
      '#markup' => $this
        ->t('This is a scheduled job that runs every "x" minutes and is designed to sanitize a specified Webform field.'),
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    ];
    $form['settings']['field_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Field Name'),
      '#description' => $this
        ->t('Provide the Field be sanitized.'),
      '#default_value' => $config
        ->get("field_name"),
      '#required' => TRUE,
    ];
    $form['settings']['sanitized_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Sanitized Value'),
      '#description' => $this
        ->t('Provide the value to overwrite the Field with.'),
      '#default_value' => $config
        ->get("sanitized_value"),
      '#required' => TRUE,
    ];
    $form['settings']['run_interval'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Run Interval'),
      '#description' => $this
        ->t('Set the interval in minutes between runs. Default 1440 (24 hours).'),
      '#default_value' => $config
        ->get("run_interval"),
      '#required' => TRUE,
    ];
    $form['settings']['last_run'] = [
      '#markup' => $this
        ->t('Last Run: @last_run', [
        '@last_run' => $config
          ->get("last_run"),
      ]),
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    ];
    $form['settings']['manual'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save and Run Webform Sanitization'),
      '#submit' => [
        [
          $this,
          'submitForm',
        ],
        'webform_scheduled_tasks_do_actions',
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   *
   * @param array $form
   *   The parameters to use to work out the value.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The parameters to use to work out the value.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $field_name = $values['settings']['field_name'];
    $sanitized_value = $values['settings']['sanitized_value'];
    $run_interval = $values['settings']['run_interval'];
    webform_scheduled_tasks_set_config('field_name', $field_name);
    webform_scheduled_tasks_set_config('sanitized_value', $sanitized_value);
    webform_scheduled_tasks_set_config('run_interval', $run_interval);
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   *
   * @return string
   *   The string to set the value as.
   */
  protected function getEditableConfigNames() {
    return [
      'webform_scheduled_tasks.config',
    ];
  }

  /**
   * {@inheritdoc}
   *
   * @return string
   *   The string to set the value as.
   */
  public function getFormId() {
    return 'webform_scheduled_tasks_settings';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
WebformSanitizeConfigForm::buildForm public function Overrides ConfigFormBase::buildForm
WebformSanitizeConfigForm::getEditableConfigNames protected function Overrides ConfigFormBaseTrait::getEditableConfigNames
WebformSanitizeConfigForm::getFormId public function Overrides FormInterface::getFormId
WebformSanitizeConfigForm::submitForm public function Overrides ConfigFormBase::submitForm