class RightToAccessDisplayTraversal in General Data Protection Regulation 8

Entity traversal for the Right to Access preview display.

@package Drupal\gdpr_tasks

Hierarchy

• class \Drupal\gdpr_fields\EntityTraversal implements EntityTraversalInterface
  • class \Drupal\gdpr_tasks\Traversal\RightToAccessDisplayTraversal

1 string reference to 'RightToAccessDisplayTraversal'

gdpr_tasks.services.yml in modules/gdpr_tasks/gdpr_tasks.services.yml

modules/gdpr_tasks/gdpr_tasks.services.yml

File

modules/gdpr_tasks/src/Traversal/RightToAccessDisplayTraversal.php, line 15

Namespace

Drupal\gdpr_tasks\Traversal

class RightToAccessDisplayTraversal extends EntityTraversal {

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  protected function processEntity(FieldableEntityInterface $entity, GdprFieldConfigEntity $config, $row_id, GdprField $parent_config = NULL) {
    $entity_type = $entity
      ->getEntityTypeId();
    $entity_definition = $entity
      ->getEntityType();
    $fields = $this->entityFieldManager
      ->getFieldDefinitions($entity_type, $entity
      ->bundle());
    $field_configs = $config
      ->getFieldsForBundle($entity
      ->bundle());
    foreach ($fields as $field_id => $field) {
      $field_config = isset($field_configs[$field_id]) ? $field_configs[$field_id] : NULL;

      // If the field is not configured, not enabled,
      // or not enabled for RTA, then skip it.
      if ($field_config === NULL || !$field_config->enabled || !in_array($field_config->rta, [
        'inc',
        'maybe',
      ])) {
        continue;
      }
      $key = "{$entity_type}.{$entity->id()}.{$field_id}";
      $field_value = $entity
        ->get($field_id)
        ->getString();
      $this->results[$key] = [
        'title' => $field
          ->getLabel(),
        'value' => $field_value,
        'entity' => $entity_definition
          ->getLabel(),
        'bundle' => $this
          ->getBundleLabel($entity),
        'notes' => $field_config->notes,
        'gdpr_rta' => $field_config->rta,
      ];
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityTraversal::$baseEntity	protected	property	The starting entity for the traversal.
EntityTraversal::$configStorage	protected	property	Entity storage for GDPR config entities.
EntityTraversal::$entities	protected	property	The processed entities.
EntityTraversal::$entityFieldManager	protected	property	Entity field manager.
EntityTraversal::$entityTypeManager	protected	property	Entity type manager.
EntityTraversal::$results	protected	property	The results of the traversal.
EntityTraversal::$reverseRelationshipFields	private	property	Reverse relationship information.
EntityTraversal::$success	protected	property	Whether or not the traversal has happened successfully.
EntityTraversal::create	public static	function	Creates an instance of the traversal for this specific entity. Overrides EntityTraversalContainerInjectionInterface::create	1
EntityTraversal::doTraversalRecursive	protected	function	Traverses the entity relationship tree.
EntityTraversal::getAllReverseRelationships	protected	function	Gets all reverse relationships configured in the system.
EntityTraversal::getBundleLabel	protected	function	Gets the entity bundle label. Useful for display traversal.
EntityTraversal::getEntities	public	function	Get the calculated actual calling points.
EntityTraversal::getResults	public	function	Get the traversal results. Overrides EntityTraversalInterface::getResults
EntityTraversal::traverse	public	function	Traverses the entity relationship tree if not done before. Overrides EntityTraversalInterface::traverse
EntityTraversal::traverseEntity	protected	function	Traverses the entity relationship tree.	1
EntityTraversal::__construct	public	function	EntityTraversal constructor.	1
RightToAccessDisplayTraversal::processEntity	protected	function	Overrides EntityTraversal::processEntity