class GDPRController in General Data Protection Regulation 8

Returns responses for Views UI routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\gdpr_tasks\Controller\GDPRController

File

modules/gdpr_tasks/src/Controller/GDPRController.php, line 19

Namespace

Drupal\gdpr_tasks\Controller

class GDPRController extends ControllerBase {

  /**
   * The task manager service.
   *
   * @var \Drupal\gdpr_tasks\TaskManager
   */
  protected $taskManager;

  /**
   * The gdpr_tasks_process_gdpr_sar queue.
   *
   * @var \Drupal\Core\Queue\QueueInterface
   */
  protected $queue;

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

  /**
   * Constructs a new GDPRController.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   The current user service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   * @param \Drupal\gdpr_tasks\TaskManager $task_manager
   *   The task manager service.
   * @param \Drupal\Core\Queue\QueueFactory $queue
   *   Queue factory.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, AccountProxyInterface $current_user, MessengerInterface $messenger, TaskManager $task_manager, QueueFactory $queue) {
    $this->entityTypeManager = $entity_type_manager;
    $this->currentUser = $current_user;
    $this->messenger = $messenger;
    $this->taskManager = $task_manager;
    $this->queue = $queue
      ->get('gdpr_tasks_process_gdpr_sar');
  }

  /**
   * Placeholder for a GDPR Dashboard.
   *
   * @return array
   *   Renderable Drupal markup.
   */
  public function summaryPage() {
    return [
      '#markup' => $this
        ->t('Summary'),
    ];
  }

  /**
   * Request a GDPR Task.
   *
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The user for whom the request is being made.
   * @param string $gdpr_task_type
   *   Type of task to be created.
   *
   * @return array|\Symfony\Component\HttpFoundation\RedirectResponse
   *   Either the task request form or a redirect response to requests page.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function requestPage(AccountInterface $user, $gdpr_task_type) {
    $tasks = $this->taskManager
      ->getUserTasks($user, $gdpr_task_type);
    $pending = FALSE;
    $statuses = [
      'requested',
      'processed',
      'reviewing',
    ];
    foreach ($tasks as $task) {
      if (in_array($task->status
        ->getString(), $statuses, TRUE)) {
        $pending = TRUE;
      }
    }
    if ($pending) {
      $this->messenger
        ->addWarning('You already have a pending task.');
    }
    else {

      // If the current user is making a request for themselves, just create it.
      // However, if we're a member of staff making a request on behalf
      // of someone else, we need to collect further details
      // so render a form to get the notes.
      if ($this
        ->currentUser()
        ->id() !== $user
        ->id()) {
        return [
          'form' => $this
            ->formBuilder()
            ->getForm(CreateGdprRequestOnBehalfOfUserForm::class),
        ];
      }
      $values = [
        'type' => $gdpr_task_type,
        'user_id' => $user
          ->id(),
      ];
      $newTask = $this->entityTypeManager
        ->getStorage('gdpr_task')
        ->create($values);
      try {
        $newTask
          ->save();
        $this->messenger
          ->addStatus($this
          ->t('Your request has been logged.'));
        if ($gdpr_task_type === 'gdpr_sar') {
          $this->queue
            ->createQueue();
          $this->queue
            ->createItem($newTask
            ->id());
        }
      } catch (EntityStorageException $exception) {
        $this->messenger
          ->addError($this
          ->t('There was an error while logging your request.'));
        $this->loggerFactory
          ->get('gdpr_tasks')
          ->error($this
          ->t('Error while trying to create a(n) "@taskType" GDPR task for user "@userName (@userId)."', [
          '@taskType' => $gdpr_task_type,
          '@userName' => $user
            ->getDisplayName(),
          '@userId' => $user
            ->id(),
        ]));
      }
    }
    return $this
      ->redirect('view.gdpr_tasks_my_data_requests.page_1', [
      'user' => $user
        ->id(),
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
GDPRController::$queue	protected	property	The gdpr_tasks_process_gdpr_sar queue.
GDPRController::$taskManager	protected	property	The task manager service.
GDPRController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
GDPRController::requestPage	public	function	Request a GDPR Task.
GDPRController::summaryPage	public	function	Placeholder for a GDPR Dashboard.
GDPRController::__construct	public	function	Constructs a new GDPRController.
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.