class ConsentWidget in General Data Protection Regulation 8

Same name and namespace in other branches

8.2 modules/gdpr_consent/src/Plugin/Field/FieldWidget/ConsentWidget.php \Drupal\gdpr_consent\Plugin\Field\FieldWidget\ConsentWidget
3.0.x modules/gdpr_consent/src/Plugin/Field/FieldWidget/ConsentWidget.php \Drupal\gdpr_consent\Plugin\Field\FieldWidget\ConsentWidget

Plugin implementation of the 'gdpr_consent_widget' widget.

Provides the ability to attach a consent agreement to a form.

Plugin annotation


@FieldWidget(
  id = "gdpr_consent_widget",
  label = @Translation("GDPR Consent"),
  description = @Translation("GDPR Consent"),
  field_types = {
    "gdpr_user_consent",
  },
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\gdpr_consent\Plugin\Field\FieldWidget\ConsentWidget implements ContainerFactoryPluginInterface

Expanded class hierarchy of ConsentWidget

File

modules/gdpr_consent/src/Plugin/Field/FieldWidget/ConsentWidget.php, line 29

Namespace

Drupal\gdpr_consent\Plugin\Field\FieldWidget

View source

class ConsentWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * The GDPR Consent Resolver manager.
   *
   * @var \Drupal\gdpr_consent\ConsentUserResolver\ConsentUserResolverPluginManager
   */
  protected $gdprConsentResolverManager;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('plugin.manager.gdpr_consent_resolver'), $container
      ->get('current_user'));
  }

  /**
   * Constructs a ConsentWidget instance.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\gdpr_consent\ConsentUserResolver\ConsentUserResolverPluginManager $gdprConsentResolverManager
   *   The GDPR Consent Resolver manager.
   * @param \Drupal\Core\Session\AccountInterface $currentUser
   *   The current user.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, ConsentUserResolverPluginManager $gdprConsentResolverManager, AccountInterface $currentUser) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->gdprConsentResolverManager = $gdprConsentResolverManager;
    $this->currentUser = $currentUser;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    if (array_key_exists(0, $form['#parents']) && $form['#parents'][0] == 'default_value_input') {

      // Don't show as part of the 'Default Value' form when configuring field.
      return [];
    }
    $canEditAnyonesConsent = $this->currentUser
      ->hasPermission('grant gdpr any consent');
    $canEditOwnConsent = $this->currentUser
      ->hasPermission('grant gdpr own consent');

    // Consenting user and current user may not be the same.
    // For example, a staff member editing consent on behalf of a user who
    // calls the office.
    $consentingUser = $this
      ->getConsentingUser($items);
    $agreementId = $items
      ->getFieldDefinition()
      ->getSetting('target_id');
    if ($agreementId === '') {

      // Don't display if an agreement hasn't
      // been configured for this field yet.
      return [];
    }

    // The current user is anonymous on the register page.
    if (!$this->currentUser
      ->isAnonymous()) {
      if (!$canEditAnyonesConsent && $consentingUser
        ->id() !== $this->currentUser
        ->id()) {

        // Abort if the current user does not have permission
        // to edit other user's consent and we're editing another user.
        return [];
      }
      if (!$canEditOwnConsent && $consentingUser
        ->id() === $this->currentUser
        ->id()) {

        // Abort if the current user cannot edit their own consent.
        return [];
      }
    }
    $agreement = ConsentAgreement::load($agreementId);
    if (NULL === $agreement) {
      return [];
    }
    $item = $items[$delta];
    $element['target_id'] = [
      '#type' => 'hidden',
      '#default_value' => $agreementId,
    ];
    $element['target_revision_id'] = [
      '#type' => 'hidden',
      '#default_value' => isset($item->target_revision_id) ? $item->target_revision_id : $agreement
        ->getRevisionId(),
    ];
    $element['agreed'] = [
      '#type' => 'checkbox',
      '#title' => $agreement
        ->get('description')->value,
      '#description' => $agreement
        ->get('long_description')->value,
      '#required' => $items
        ->getFieldDefinition()
        ->isRequired(),
      '#default_value' => isset($item->agreed) && (bool) $item->agreed === TRUE,
      '#attributes' => [
        'class' => [
          'gdpr_consent_agreement',
        ],
      ],
      '#attached' => [
        'library' => [
          'gdpr_consent/gdpr_consent_display',
        ],
      ],
    ];

    // If we only require implicit agreement,
    // hide the checkbox and set it to true.
    if (!$agreement
      ->requiresExplicitAcceptance()) {
      $element['agreed']['#title'] = '';
      $element['agreed']['#type'] = 'item';

      // Just render an empty span that the javascript can hook onto.
      $element['agreed']['#markup'] = '<span class="gdpr_consent_implicit">' . $agreement
        ->get('description')->value . '</span>';
      $element['agreed']['#default_value'] = TRUE;
    }

    // Only show the notes field if the user has permission.
    if ($canEditAnyonesConsent) {
      $element['notes'] = [
        '#type' => 'textarea',
        '#title' => 'GDPR Consent Notes',
        '#required' => FALSE,
        '#default_value' => isset($item->notes) ? $item->notes : '',
      ];
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    foreach ($values as &$value) {
      if (!isset($value['user_id_accepted'])) {
        $value['user_id_accepted'] = $this->currentUser
          ->id();
      }
      if (!isset($value['date'])) {
        $value['date'] = \date('Y-m-d H:i:s');
      }
    }
    unset($value);
    return $values;
  }

  /**
   * Gets the user who the consent will be stored against.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   The field.
   *
   * @return \Drupal\user\Entity\User
   *   The user
   *
   * @throws \Exception
   */
  private function getConsentingUser(FieldItemListInterface $items) {
    $definition = $items
      ->getFieldDefinition();
    $resolver = $this->gdprConsentResolverManager
      ->getForEntityType($definition
      ->getTargetEntityTypeId(), $definition
      ->getTargetBundle());
    return $resolver
      ->resolve($items
      ->getEntity());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
ConsentWidget::$currentUser	protected	property	The current user.
ConsentWidget::$gdprConsentResolverManager	protected	property	The GDPR Consent Resolver manager.
ConsentWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
ConsentWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
ConsentWidget::getConsentingUser	private	function	Gets the user who the consent will be stored against.
ConsentWidget::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
ConsentWidget::__construct	public	function	Constructs a ConsentWidget instance. Overrides WidgetBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings	42
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm	16
WidgetBase::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary	15
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState

You are here

class ConsentWidget in General Data Protection Regulation 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation