class GdprFieldFilterForm in General Data Protection Regulation 8

Filter form for GDPR field list page.

@package Drupal\gdpr_fields\Form

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\gdpr_fields\Form\GdprFieldFilterForm

1 file declares its use of GdprFieldFilterForm

GDPRController.php in modules/gdpr_fields/src/Controller/GDPRController.php

File

modules/gdpr_fields/src/Form/GdprFieldFilterForm.php, line 18

Namespace

Drupal\gdpr_fields\Form

class GdprFieldFilterForm extends FormBase {

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * GdprFieldFilterForm constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $filters = self::getFilters($this
      ->getRequest());

    // @todo Add classes and styling to move filters inline.
    $form['container'] = [];
    $entities = [];
    foreach ($this->entityTypeManager
      ->getDefinitions() as $key => $definition) {

      // Exclude anything not fieldable (ie config entities)
      if ($definition
        ->entityClassImplements(FieldableEntityInterface::class)) {
        $entities[$key] = $definition
          ->getLabel();
      }
    }
    $form['container']['search'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Search'),
      '#default_value' => $filters['search'],
    ];
    $form['container']['entity_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Entity Type'),
      '#options' => $entities,
      '#multiple' => TRUE,
      '#default_value' => $filters['entity_type'],
    ];
    $form['container']['rta'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Right to access'),
      '#options' => [
        '0' => 'Not configured',
      ] + GdprField::rtaOptions(),
      '#multiple' => TRUE,
      '#default_value' => $filters['rta'],
    ];
    $form['container']['rtf'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Right to be forgotten'),
      '#options' => [
        '0' => 'Not configured',
      ] + GdprField::rtfOptions(),
      '#multiple' => TRUE,
      '#default_value' => $filters['rtf'],
    ];
    $form['container']['empty'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Filter out Entities where all fields are not configured'),
      '#default_value' => $filters['empty'],
    ];
    $form['container']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Apply'),
      '#button_type' => 'primary',
    ];
    $form['container']['reset'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Reset'),
      '#submit' => [
        [
          $this,
          'resetForm',
        ],
      ],
      '#limit_validation_errors' => [],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $arguments = [
      'search' => $form_state
        ->getValue('search'),
      'entity_type' => $form_state
        ->getValue('entity_type'),
      'rta' => $form_state
        ->getValue('rta'),
      'rtf' => $form_state
        ->getValue('rtf'),
      'empty' => $form_state
        ->getValue('empty'),
    ];
    $form_state
      ->setRedirect('gdpr_fields.fields_list', [], [
      'query' => $arguments,
    ]);
  }

  /**
   * Form submission handler to reset filters.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function resetForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('gdpr_fields.fields_list');
  }

  /**
   * Gets gdpr field filters from the request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Request.
   *
   * @return array
   *   The filters keyed by filter name.
   */
  public static function getFilters(Request $request) {
    $filters = [
      'search' => $request
        ->get('search'),
      'entity_type' => $request
        ->get('entity_type'),
      'rta' => $request
        ->get('rta'),
      'rtf' => $request
        ->get('rtf'),
      'empty' => $request
        ->get('empty'),
    ];
    if ($filters['rtf'] === NULL) {
      $filters['rtf'] = [];
    }
    if ($filters['rta'] === NULL) {
      $filters['rta'] = [];
    }
    return $filters;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
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
GdprFieldFilterForm::$entityTypeManager	protected	property	Entity type manager.
GdprFieldFilterForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
GdprFieldFilterForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
GdprFieldFilterForm::getFilters	public static	function	Gets gdpr field filters from the request.
GdprFieldFilterForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
GdprFieldFilterForm::resetForm	public	function	Form submission handler to reset filters.
GdprFieldFilterForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
GdprFieldFilterForm::__construct	public	function	GdprFieldFilterForm constructor.
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.