You are here

Home » API reference » General Data Protection Regulation 3.0.x » UserConsentItem.php

class UserConsentItem in General Data Protection Regulation 3.0.x

Same name and namespace in other branches
  1. 8.2 modules/gdpr_consent/src/Plugin/Field/FieldType/UserConsentItem.php \Drupal\gdpr_consent\Plugin\Field\FieldType\UserConsentItem
  2. 8 modules/gdpr_consent/src/Plugin/Field/FieldType/UserConsentItem.php \Drupal\gdpr_consent\Plugin\Field\FieldType\UserConsentItem

Plugin implementation of the 'gdpr_user_consent' field type.

Plugin annotation


@FieldType(
  id = "gdpr_user_consent",
  label = @Translation("GDPR Consent"),
  description = @Translation("Stores user consent for a particular agreement"),
  category = @Translation("GDPR"),
  default_widget = "gdpr_consent_widget",
  default_formatter = "gdpr_consent_formatter"
)

Hierarchy

Expanded class hierarchy of UserConsentItem

File

modules/gdpr_consent/src/Plugin/Field/FieldType/UserConsentItem.php, line 25

Namespace

Drupal\gdpr_consent\Plugin\Field\FieldType
View source 
class UserConsentItem extends FieldItemBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return [
      'target_id' => '',
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['target_id'] = DataReferenceTargetDefinition::create('integer')
      ->setLabel('Target agreement ID')
      ->setSetting('unsigned', TRUE)
      ->setRequired(TRUE);
    $properties['target_revision_id'] = DataDefinition::create('integer')
      ->setLabel('Revision ID');
    $properties['agreed'] = DataDefinition::create('boolean')
      ->setLabel('Agreed');
    $properties['date'] = DataDefinition::create('datetime_iso8601')
      ->setLabel('Date stored');
    $properties['user_id'] = DataReferenceTargetDefinition::create('integer')
      ->setLabel('User ID');
    $properties['user_id_accepted'] = DataReferenceTargetDefinition::create('integer')
      ->setLabel('User ID Accepted');
    $properties['notes'] = DataReferenceTargetDefinition::create('string')
      ->setLabel('Notes');
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function postSave($update) {
    $definition = $this
      ->getFieldDefinition();

    /** @var \Drupal\gdpr_consent\ConsentUserResolver\ConsentUserResolverPluginManager $plugin_manager */
    $plugin_manager = \Drupal::service('plugin.manager.gdpr_consent_resolver');
    $resolver = $plugin_manager
      ->getForEntityType($definition
      ->getTargetEntityTypeId(), $definition
      ->getTargetBundle());
    $user = $resolver
      ->resolve($this
      ->getEntity());
    if ($user != NULL) {
      $this
        ->set('user_id', $user
        ->id());
    }
    $should_log = FALSE;
    if (!$update) {

      // Always log on a create.
      $should_log = TRUE;
    }
    else {
      $field_name = $this
        ->getFieldDefinition()
        ->getName();
      $original_value = $this
        ->getEntity()->original->{$field_name}->agreed;
      if ($original_value != $this->agreed) {
        $should_log = TRUE;
      }
    }
    if ($should_log) {
      $msg = Message::create([
        'template' => 'consent_agreement_accepted',
      ]);
      $msg
        ->set('user', $this->user_id);
      $msg
        ->set('user_accepted', $this->user_id_accepted);
      $msg
        ->set('agreement', [
        'target_id' => $this->target_id,
        'target_revision_id' => $this->target_revision_id,
      ]);
      $msg
        ->set('notes', $this->notes);
      $msg
        ->set('agreed', $this->agreed);
      $msg
        ->save();
    }
    if ($user != NULL) {
      return TRUE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $agreement_ids = \Drupal::entityQuery('gdpr_consent_agreement')
      ->condition('status', 1)
      ->sort('title')
      ->execute();
    $agreements = ConsentAgreement::loadMultiple($agreement_ids);
    $element = [];
    $element['target_id'] = [
      '#type' => 'select',
      '#title' => 'Agreement',
      '#required' => TRUE,
      '#options' => [
        '' => 'Please select',
      ] + $agreements,
      '#default_value' => $this
        ->getSetting('target_id'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    $schema = [
      'indexes' => [
        'target_id' => [
          'target_id',
        ],
      ],
    ];
    $schema['columns']['target_id'] = [
      'description' => 'The ID of the target entity.',
      'type' => 'int',
      'unsigned' => TRUE,
    ];
    $schema['columns']['target_revision_id'] = [
      'description' => 'The Revision ID of the target entity.',
      'type' => 'int',
    ];
    $schema['columns']['agreed'] = [
      'description' => 'Whether the user has agreed.',
      'type' => 'int',
      'size' => 'tiny',
      'default' => 0,
    ];
    $schema['columns']['user_id'] = [
      'description' => 'ID of the user who has accepted.',
      'type' => 'int',
    ];
    $schema['columns']['date'] = [
      'description' => 'Time that the user agreed.',
      'type' => 'varchar',
      'length' => 20,
    ];
    $schema['columns']['user_id_accepted'] = [
      'description' => 'ID of the user who recorded the acceptance',
      'type' => 'int',
    ];
    $schema['columns']['notes'] = [
      'description' => 'Additional notes on the acceptance',
      'type' => 'varchar',
      'length' => '255',
    ];
    return $schema;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FieldItemBase::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies 1
FieldItemBase::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings 10
FieldItemBase::delete public function Defines custom delete behavior for field values. Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemInterface::generateSampleValue 18
FieldItemBase::getEntity public function Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting protected function Returns the value of a field setting.
FieldItemBase::getSettings protected function Returns the array of field settings.
FieldItemBase::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval 1
FieldItemBase::preSave public function Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave 7
FieldItemBase::setValue public function Sets the data value. Overrides Map::setValue 4
FieldItemBase::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm 8
FieldItemBase::storageSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue protected function Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct public function Constructs a TypedData object given its definition and context. Overrides TypedData::__construct 1
FieldItemBase::__get public function Magic method: Gets a property value. Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Magic method: Sets a property value. Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Magic method: Unsets a property. Overrides FieldItemInterface::__unset
Map::$definition protected property The data definition. Overrides TypedData::$definition
Map::$properties protected property The array of properties.
Map::$values protected property An array of values for the contained properties.
Map::applyDefaultValue public function Applies the default value. Overrides TypedData::applyDefaultValue 4
Map::get public function Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator public function
Map::getProperties public function Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString public function Returns a string representation of the data. Overrides TypedData::getString
Map::getValue public function Gets the data value. Overrides TypedData::getValue 1
Map::isEmpty public function Determines whether the data structure is empty. Overrides ComplexDataInterface::isEmpty 17
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 4
Map::set public function Sets a property value. Overrides ComplexDataInterface::set
Map::toArray public function Returns an array of all property values. Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints public function Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints 9
TypedData::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent public function Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2
UserConsentItem::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
UserConsentItem::fieldSettingsForm public function Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm
UserConsentItem::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemBase::postSave
UserConsentItem::propertyDefinitions public static function Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
UserConsentItem::schema public static function Returns the schema for the field. Overrides FieldItemInterface::schema