class DataPolicy in Data Policy 8

Same name in this branch

8 src/Controller/DataPolicy.php \Drupal\data_policy\Controller\DataPolicy
8 src/Entity/DataPolicy.php \Drupal\data_policy\Entity\DataPolicy

Class DataPolicy.

Returns responses for Data policy routes.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\data_policy\Controller\DataPolicy implements ContainerInjectionInterface

Expanded class hierarchy of DataPolicy

File

src/Controller/DataPolicy.php, line 25

Namespace

Drupal\data_policy\Controller

View source

class DataPolicy extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The entity repository service.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * The date formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\Renderer
   */
  protected $renderer;

  /**
   * The Data Policy consent manager.
   *
   * @var \Drupal\data_policy\DataPolicyConsentManagerInterface
   */
  protected $dataPolicyConsentManager;

  /**
   * The currently active request object.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * DataPolicy constructor.
   *
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   The entity repository service.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\data_policy\DataPolicyConsentManagerInterface $data_policy_consent_manager
   *   The Data Policy consent manager.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   */
  public function __construct(EntityRepositoryInterface $entity_repository, DateFormatterInterface $date_formatter, RendererInterface $renderer, DataPolicyConsentManagerInterface $data_policy_consent_manager, Request $request) {
    $this->entityRepository = $entity_repository;
    $this->dateFormatter = $date_formatter;
    $this->renderer = $renderer;
    $this->dataPolicyConsentManager = $data_policy_consent_manager;
    $this->request = $request;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity.repository'), $container
      ->get('date.formatter'), $container
      ->get('renderer'), $container
      ->get('data_policy.manager'), $container
      ->get('request_stack')
      ->getCurrentRequest());
  }

  /**
   * Show description of data policy.
   *
   * @return array
   *   The data policy description text.
   */
  public function entityOverviewPage() {
    $entity_id = $this->request
      ->get('id');
    if (!empty($entity_id)) {
      $entity = $this
        ->entityTypeManager()
        ->getStorage('data_policy')
        ->load($entity_id);

      // Get translation for the current language.
      $entity = $this->entityRepository
        ->getTranslationFromContext($entity);
      $description = $entity
        ->get('field_description')
        ->view([
        'label' => 'hidden',
      ]);
      return [
        '#theme' => 'data_policy_data_policy',
        '#content' => $description,
      ];
    }
    $entity_ids = $this->dataPolicyConsentManager
      ->getEntityIdsFromConsentText();
    $links = [];
    foreach ($entity_ids as $entity_id) {

      /** @var \Drupal\data_policy\Entity\DataPolicyInterface $entity */
      $entity = $this
        ->entityTypeManager()
        ->getStorage('data_policy')
        ->load($entity_id);

      // Get translation for the current language.
      $entity = $this->entityRepository
        ->getTranslationFromContext($entity);
      $links[] = Link::createFromRoute($entity
        ->getName(), 'entity.data_policy.revision', [
        'entity_id' => $entity
          ->id(),
        'data_policy_revision' => $entity
          ->getRevisionId(),
      ]);
    }
    return [
      '#title' => $this
        ->t('Active revisions'),
      '#theme' => 'item_list',
      '#items' => $links,
    ];
  }

  /**
   * Check if data policy is created.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   The access result.
   */
  public function entityOverviewAccess() {
    if ($this->dataPolicyConsentManager
      ->isDataPolicy()) {
      return AccessResult::allowed();
    }
    return AccessResult::forbidden();
  }

  /**
   * Displays a Data policy revision.
   *
   * @param int $data_policy_revision
   *   The Data policy  revision ID.
   *
   * @return array
   *   An array suitable for drupal_render().
   */
  public function revisionOverviewPage($data_policy_revision) {
    $data_policy = $this
      ->entityTypeManager()
      ->getStorage('data_policy')
      ->loadRevision($data_policy_revision);
    return $this
      ->entityTypeManager()
      ->getViewBuilder('data_policy')
      ->view($data_policy);
  }

  /**
   * Page title callback for a Data policy revision.
   *
   * @param int $data_policy_revision
   *   The Data policy  revision ID.
   *
   * @return string
   *   The page title.
   */
  public function revisionOverviewTitle($data_policy_revision) {
    $data_policy = $this
      ->entityTypeManager()
      ->getStorage('data_policy')
      ->loadRevision($data_policy_revision);
    return $this
      ->t('Data policy revision from %date', [
      '%date' => $this->dateFormatter
        ->format($data_policy
        ->getRevisionCreationTime()),
    ]);
  }

  /**
   * Generates an overview table of older revisions of a Data policy.
   *
   * @return array
   *   An array as expected by drupal_render().
   */
  public function revisionsOverviewPage($entity_id = NULL) {
    $build = [
      'data_policy_revisions_table' => [
        '#theme' => 'table',
        '#header' => [
          $this
            ->t('Revision'),
          $this
            ->t('Operations'),
        ],
        '#rows' => [],
        '#empty' => $this
          ->t('List is empty.'),
      ],
    ];
    if (!$entity_id) {
      return $build;
    }

    /** @var \Drupal\data_policy\DataPolicyStorageInterface $data_policy_storage */
    $data_policy_storage = $this
      ->entityTypeManager()
      ->getStorage('data_policy');

    /** @var \Drupal\data_policy\Entity\DataPolicyInterface $data_policy */
    $data_policy = $data_policy_storage
      ->load($entity_id);
    $account = $this
      ->currentUser();
    $langcode = $data_policy
      ->language()
      ->getId();
    $languages = $data_policy
      ->getTranslationLanguages();
    $has_translations = count($languages) > 1;
    $revert_permission = $account
      ->hasPermission('revert all data policy revisions') || $account
      ->hasPermission('administer data policy entities');
    $delete_permission = $account
      ->hasPermission('delete all data policy revisions') || $account
      ->hasPermission('administer data policy entities');
    $vids = $data_policy_storage
      ->revisionIds($data_policy);
    foreach (array_reverse($vids) as $vid) {

      /** @var \Drupal\data_policy\Entity\DataPolicyInterface $revision */
      $revision = $data_policy_storage
        ->loadRevision($vid);

      // Only show revisions that are affected by the language that is being
      // displayed.
      if (!$revision
        ->hasTranslation($langcode) && $revision
        ->getTranslation($langcode)
        ->isRevisionTranslationAffected()) {
        continue;
      }
      $username = [
        '#theme' => 'username',
        '#account' => $revision
          ->getRevisionUser(),
      ];

      // Use revision link to link to revisions that are not active.
      $date = $this->dateFormatter
        ->format($revision
        ->getRevisionCreationTime(), 'short');
      $row = [];
      $column = [
        'data' => [
          '#theme' => 'data_policy_data_policy_revision',
          '#date' => $date,
          '#username' => $this->renderer
            ->renderPlain($username),
          '#current' => $revision
            ->isDefaultRevision(),
          '#message' => [
            '#markup' => Unicode::truncate($revision
              ->getRevisionLogMessage(), 80, TRUE, TRUE),
            '#allowed_tags' => Xss::getHtmlTagList(),
          ],
        ],
      ];
      $row[] = $column;
      $links = [];
      $links['view'] = [
        'title' => $this
          ->t('View'),
        'url' => Url::fromRoute('entity.data_policy.revision', [
          'data_policy' => $data_policy
            ->id(),
          'data_policy_revision' => $vid,
          'entity_id' => $entity_id,
        ]),
      ];
      if ($this
        ->revisionEditAccess($vid)
        ->isAllowed()) {
        $links['edit'] = [
          'title' => $this
            ->t('Edit'),
          'url' => Url::fromRoute('entity.data_policy.revision_edit', [
            'data_policy' => $data_policy
              ->id(),
            'data_policy_revision' => $vid,
            'entity_id' => $entity_id,
          ]),
        ];
      }
      if (!$revision
        ->isDefaultRevision()) {
        if ($revert_permission) {
          $links['revert'] = [
            'title' => $this
              ->t('Revert'),
            'url' => $has_translations ? Url::fromRoute('entity.data_policy.translation_revert', [
              'data_policy' => $data_policy
                ->id(),
              'data_policy_revision' => $vid,
              'langcode' => $langcode,
            ]) : Url::fromRoute('entity.data_policy.revision_revert', [
              'data_policy' => $data_policy
                ->id(),
              'data_policy_revision' => $vid,
              'entity_id' => $entity_id,
            ]),
          ];
        }
        if ($delete_permission) {
          $links['delete'] = [
            'title' => $this
              ->t('Delete'),
            'url' => Url::fromRoute('entity.data_policy.revision_delete', [
              'data_policy' => $data_policy
                ->id(),
              'data_policy_revision' => $vid,
              'entity_id' => $entity_id,
            ]),
          ];
        }
      }
      $row[] = [
        'data' => [
          '#type' => 'operations',
          '#links' => $links,
        ],
      ];
      if ($revision
        ->isDefaultRevision()) {
        foreach ($row as &$current) {
          $current['class'] = [
            'revision-current',
          ];
        }
      }
      $build['data_policy_revisions_table']['#rows'][] = $row;
    }
    return $build;
  }

  /**
   * Check access to agreement page.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   Allow to open page when a user was not give consent on a current version
   *   of data policy.
   */
  public function agreementAccess() {
    if ($this->dataPolicyConsentManager
      ->needConsent()) {
      return AccessResult::allowed();
    }
    return AccessResult::forbidden();
  }

  /**
   * Check access to revision edit page.
   *
   * @param int $data_policy_revision
   *   The data policy revision ID.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   Allow editing revision if it never been active.
   */
  public function revisionEditAccess($data_policy_revision) {
    if ($this
      ->currentUser()
      ->hasPermission('administer data policy entities') || $this
      ->currentUser()
      ->hasPermission('edit data policy')) {
      $ids = $this->dataPolicyConsentManager
        ->getConfig('revision_ids');
      if (!isset($ids[$data_policy_revision])) {
        return AccessResult::allowed();
      }
    }
    return AccessResult::forbidden();
  }

}

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.
DataPolicy::$dataPolicyConsentManager	protected	property	The Data Policy consent manager.
DataPolicy::$dateFormatter	protected	property	The date formatter.
DataPolicy::$entityRepository	protected	property	The entity repository service.
DataPolicy::$renderer	protected	property	The renderer.
DataPolicy::$request	protected	property	The currently active request object.
DataPolicy::agreementAccess	public	function	Check access to agreement page.
DataPolicy::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
DataPolicy::entityOverviewAccess	public	function	Check if data policy is created.
DataPolicy::entityOverviewPage	public	function	Show description of data policy.
DataPolicy::revisionEditAccess	public	function	Check access to revision edit page.
DataPolicy::revisionOverviewPage	public	function	Displays a Data policy revision.
DataPolicy::revisionOverviewTitle	public	function	Page title callback for a Data policy revision.
DataPolicy::revisionsOverviewPage	public	function	Generates an overview table of older revisions of a Data policy.
DataPolicy::__construct	public	function	DataPolicy 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.

You are here

class DataPolicy in Data Policy 8

Hierarchy

File

Namespace

Members

API Navigation