You are here

class RemovalSettingsForm in General Data Protection Regulation 8

Same name and namespace in other branches
  1. 8.2 modules/gdpr_tasks/src/Form/RemovalSettingsForm.php \Drupal\gdpr_tasks\Form\RemovalSettingsForm
  2. 3.0.x modules/gdpr_tasks/src/Form/RemovalSettingsForm.php \Drupal\gdpr_tasks\Form\RemovalSettingsForm

Settings form for GDPR Removal task.

@package Drupal\gdpr_tasks\Form

Hierarchy

Expanded class hierarchy of RemovalSettingsForm

1 file declares its use of RemovalSettingsForm
Anonymizer.php in modules/gdpr_tasks/src/Anonymizer.php
1 string reference to 'RemovalSettingsForm'
gdpr_tasks.routing.yml in modules/gdpr_tasks/gdpr_tasks.routing.yml
modules/gdpr_tasks/gdpr_tasks.routing.yml

File

modules/gdpr_tasks/src/Form/RemovalSettingsForm.php, line 13

Namespace

Drupal\gdpr_tasks\Form
View source
class RemovalSettingsForm extends ConfigFormBase {
  const CONFIG_KEY = 'gdpr_tasks.settings';
  const EXPORT_DIRECTORY = 'export_directory';

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      self::CONFIG_KEY,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'gdpr_tasks_removal_settings_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['directory'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Export Directory'),
      '#description' => $this
        ->t('Specifies the path to the directory where Right to be Forgotten tasks are exported after being processed'),
      '#required' => TRUE,
      '#default_value' => $this
        ->config(self::CONFIG_KEY)
        ->get(self::EXPORT_DIRECTORY),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if ($form_state
      ->hasValue('directory')) {
      $directory = $form_state
        ->getValue('directory');
      if (empty($directory)) {
        $form_state
          ->setErrorByName('directory', $this
          ->t('The directory is required.'));
        return;
      }
      if (!\file_prepare_directory($directory)) {
        $form_state
          ->setErrorByName('directory', $this
          ->t("The directory does not exist or it's not writable."));
        return;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config(self::CONFIG_KEY)
      ->set(self::EXPORT_DIRECTORY, $form_state
      ->getValue('directory'))
      ->save();
    $this
      ->messenger()
      ->addStatus('Changes saved.');
  }

}

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.
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.
RemovalSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
RemovalSettingsForm::CONFIG_KEY constant
RemovalSettingsForm::EXPORT_DIRECTORY constant
RemovalSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RemovalSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RemovalSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
RemovalSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.