class GdprField in General Data Protection Regulation 8.2

Metadata for a GDPR field.

Hierarchy

• class \Drupal\gdpr_fields\Entity\GdprField

8 files declare their use of GdprField

EntityTraversal.php in modules/gdpr_fields/src/EntityTraversal.php

GdprFieldFilterForm.php in modules/gdpr_fields/src/Form/GdprFieldFilterForm.php

GdprFieldSettingsForm.php in modules/gdpr_fields/src/Form/GdprFieldSettingsForm.php

gdpr_fields.module in modules/gdpr_fields/gdpr_fields.module

Module file for the GDPR Fields module.

RightToAccessDisplayTraversal.php in modules/gdpr_tasks/src/Traversal/RightToAccessDisplayTraversal.php

... See full list

File

modules/gdpr_fields/src/Entity/GdprField.php, line 11

Namespace

Drupal\gdpr_fields\Entity

class GdprField {

  /**
   * Indicates a relationship is not enabled for GDPR processing.
   */
  const RELATIONSHIP_DISABLED = 0;

  /**
   * Indicates a relationship should be followed.
   */
  const RELATIONSHIP_FOLLOW = 1;

  /**
   * Indicates this is a reverse relationship.
   *
   * Indicates that the current entity is the owner.
   */
  const RELATIONSHIP_OWNER = 2;

  /**
   * Bundle name.
   *
   * @var string
   */
  public $bundle;

  /**
   * Field name.
   *
   * @var string
   */
  public $name;

  /**
   * Whether GDPR is enabled for this field.
   *
   * @var bool
   */
  public $enabled = FALSE;

  /**
   * Right to Forget setting for this field.
   *
   * @var string
   */
  public $rtf = 'no';

  /**
   * Right to Access setting for this field.
   *
   * @var string
   */
  public $rta = 'no';

  /**
   * Anonymizer to use on this field.
   *
   * @var string
   */
  public $anonymizer = '';

  /**
   * Notes.
   *
   * @var string
   */
  public $notes = '';

  /**
   * SARS filename when handling multiple cardinality fields.
   *
   * @var string
   */
  public $sarsFilename = '';

  /**
   * Relationship status.
   *
   * 0 = Disabled
   * 1 = Follow
   * 2 = Owner/Reverse.
   *
   * @var int
   */
  public $relationship = 0;

  /**
   * Entity type.
   *
   * @var string
   */
  public $entityTypeId;

  /**
   * GdprField constructor.
   *
   * @param array $values
   *   Underlying data values for the field.
   */
  public function __construct(array $values = []) {
    $this->bundle = $values['bundle'];
    $this->name = $values['name'];
    $this->entityTypeId = $values['entity_type_id'];
    $this->rtf = array_key_exists('rtf', $values) ? $values['rtf'] : 'no';
    $this->rta = array_key_exists('rta', $values) ? $values['rta'] : 'no';
    $this->enabled = array_key_exists('enabled', $values) ? $values['enabled'] : FALSE;
    $this->anonymizer = array_key_exists('anonymizer', $values) ? $values['anonymizer'] : NULL;
    $this->notes = array_key_exists('notes', $values) ? $values['notes'] : '';
    $this->relationship = array_key_exists('relationship', $values) ? $values['relationship'] : self::RELATIONSHIP_DISABLED;
    $this->sarsFilename = array_key_exists('sars_filename', $values) ? $values['sars_filename'] : '';
  }

  /**
   * Returns an array representation of the GDPR field config.
   */
  public function toArray() {
    return [
      'bundle' => $this->bundle,
      'name' => $this->name,
      'entity_type_id' => $this->entityTypeId,
      'rtf' => $this->rtf,
      'rta' => $this->rta,
      'enabled' => $this->enabled,
      'anonymizer' => $this->anonymizer,
      'notes' => $this->notes,
      'relationship' => $this->relationship,
      'sars_filename' => $this->sarsFilename,
    ];
  }

  /**
   * Gets the RTF description.
   *
   * @return string
   *   The description.
   */
  public function rtfDescription() {
    switch ($this->rtf) {
      case 'anonymize':
        return 'Anonymize';
      case 'remove':
        return 'Remove';
      case 'maybe':
        return 'Maybe';
      case 'no':
        return 'Not Included';
      default:
        return 'Not Configured';
    }
  }

  /**
   * Gets the RTA description.
   *
   * @return string
   *   The description.
   */
  public function rtaDescription() {
    switch ($this->rta) {
      case 'inc':
        return 'Included';
      case 'maybe':
        return 'Maybe';
      case 'no':
        return 'Not Included';
      default:
        return 'Not Configured';
    }
  }

  /**
   * Indicates that this is a reverse relationship.
   *
   * Indicates that the current entity is the owner of the relationship, and
   * traversal should take place from this side, rather than from the root
   * entity.
   *
   * @return bool
   *   True if owner, otherwise false.
   */
  public function isOwner() {
    return $this->relationship === self::RELATIONSHIP_OWNER;
  }

  /**
   * Indicates if the relationship should be followed.
   *
   * @return bool
   *   True if it should be followed, otherwise false.
   */
  public function followRelationship() {
    return $this->relationship === self::RELATIONSHIP_FOLLOW;
  }

  /**
   * Whether to recurse to entities included in this property.
   */
  public function includeRelatedEntities() {

    // If not explicitly a GDPR field, don't recurse.
    if (!$this->enabled) {
      return FALSE;
    }

    // If the field is an owner, don't recurse.
    if ($this
      ->isOwner()) {
      return FALSE;
    }

    // Only follow the relationship if it's been explicitly enabled.
    if ($this
      ->followRelationship()) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Sets whether this is a GDPR field.
   *
   * @param bool $enabled
   *   Enabled/disabled.
   *
   * @return $this
   */
  public function setEnabled($enabled) {
    $this->enabled = $enabled;
    return $this;
  }

  /**
   * Sets the RTA setting.
   *
   * @param string $rta
   *   RTA.
   *
   * @return $this
   */
  public function setRta($rta) {
    $this->rta = $rta;
    return $this;
  }

  /**
   * Sets the RTF setting.
   *
   * @param string $rtf
   *   RTF setting.
   *
   * @return $this
   */
  public function setRtf($rtf) {
    $this->rtf = $rtf;
    return $this;
  }

  /**
   * Sets the anonymizer ID.
   *
   * @param string $anonymizer
   *   Anonymizer ID.
   *
   * @return $this
   */
  public function setAnonymizer($anonymizer) {
    $this->anonymizer = $anonymizer;
    return $this;
  }

  /**
   * Sets field notes.
   *
   * @param string $notes
   *   Notes.
   *
   * @return $this
   */
  public function setNotes($notes) {
    $this->notes = $notes;
    return $this;
  }

  /**
   * Sets SAR filename.
   *
   * @param string $filename
   *   Filename.
   *
   * @return $this
   */
  public function setSarsFilename($filename) {
    $this->sarsFilename = $filename;
    return $this;
  }

  /**
   * Sets the relationship.
   *
   * @param int $relationship
   *   Relationship setting.
   *
   * @return $this
   */
  public function setRelationship($relationship) {
    $this->relationship = $relationship;
    return $this;
  }

  /**
   * Get the options array for right to access field.
   *
   * @return array
   *   Right to access field options array.
   */
  public static function rtaOptions() {
    return [
      'inc' => 'Included',
      'maybe' => 'Maybe included',
      'no' => 'Not included',
    ];
  }

  /**
   * Get the options array for right to be forgotten field.
   *
   * @return array
   *   Right to be forgotten field options array.
   */
  public static function rtfOptions() {
    return [
      'anonymize' => 'Anonymize',
      'remove' => 'Remove',
      'maybe' => 'Maybe included',
      'no' => 'Not included',
    ];
  }

  /**
   * Check whether a property can be removed.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The property info.
   * @param string $error_message
   *   A variable to fill with an error message.
   *
   * @return bool
   *   TRUE if the property can be removed, FALSE if not.
   */
  public function propertyCanBeRemoved(FieldDefinitionInterface $field_definition, &$error_message = NULL) {
    if ($field_definition
      ->isComputed()) {
      $error_message = new TranslatableMarkup('Unable to remove computed field %field.', [
        '%field' => $field_definition
          ->getName(),
      ]);
      return FALSE;
    }
    if ($field_definition
      ->isRequired()) {
      $error_message = new TranslatableMarkup('Unable to remove required field %field.', [
        '%field' => $field_definition
          ->getName(),
      ]);
      return FALSE;
    }
    if ($field_definition
      ->isReadOnly()) {
      $error_message = new TranslatableMarkup('Unable to remove readonly field %field.', [
        '%field' => $field_definition
          ->getName(),
      ]);
      return FALSE;
    }

    // @todo Find something less generic than `EntityTypeInterface::getKeys()`.
    $entity_keys = [
      'id',
      'uuid',
      'revision',
      'bundle',
      'label',
      'langcode',
      'default_langcode',
      'revision_translation_affected',
    ];
    if (in_array($field_definition
      ->getName(), $entity_keys)) {
      $error_message = new TranslatableMarkup('Unable to remove entity key %field.', [
        '%field' => $field_definition
          ->getName(),
      ]);
      return FALSE;
    }
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GdprField::$anonymizer	public	property	Anonymizer to use on this field.
GdprField::$bundle	public	property	Bundle name.
GdprField::$enabled	public	property	Whether GDPR is enabled for this field.
GdprField::$entityTypeId	public	property	Entity type.
GdprField::$name	public	property	Field name.
GdprField::$notes	public	property	Notes.
GdprField::$relationship	public	property	Relationship status.
GdprField::$rta	public	property	Right to Access setting for this field.
GdprField::$rtf	public	property	Right to Forget setting for this field.
GdprField::$sarsFilename	public	property	SARS filename when handling multiple cardinality fields.
GdprField::followRelationship	public	function	Indicates if the relationship should be followed.
GdprField::includeRelatedEntities	public	function	Whether to recurse to entities included in this property.
GdprField::isOwner	public	function	Indicates that this is a reverse relationship.
GdprField::propertyCanBeRemoved	public	function	Check whether a property can be removed.
GdprField::RELATIONSHIP_DISABLED		constant	Indicates a relationship is not enabled for GDPR processing.
GdprField::RELATIONSHIP_FOLLOW		constant	Indicates a relationship should be followed.
GdprField::RELATIONSHIP_OWNER		constant	Indicates this is a reverse relationship.
GdprField::rtaDescription	public	function	Gets the RTA description.
GdprField::rtaOptions	public static	function	Get the options array for right to access field.
GdprField::rtfDescription	public	function	Gets the RTF description.
GdprField::rtfOptions	public static	function	Get the options array for right to be forgotten field.
GdprField::setAnonymizer	public	function	Sets the anonymizer ID.
GdprField::setEnabled	public	function	Sets whether this is a GDPR field.
GdprField::setNotes	public	function	Sets field notes.
GdprField::setRelationship	public	function	Sets the relationship.
GdprField::setRta	public	function	Sets the RTA setting.
GdprField::setRtf	public	function	Sets the RTF setting.
GdprField::setSarsFilename	public	function	Sets SAR filename.
GdprField::toArray	public	function	Returns an array representation of the GDPR field config.
GdprField::__construct	public	function	GdprField constructor.