public function ConsentWidget::formElement in General Data Protection Regulation 3.0.x

Same name and namespace in other branches

1. 8.2 modules/gdpr_consent/src/Plugin/Field/FieldWidget/ConsentWidget.php \Drupal\gdpr_consent\Plugin\Field\FieldWidget\ConsentWidget::formElement()
2. 8 modules/gdpr_consent/src/Plugin/Field/FieldWidget/ConsentWidget.php \Drupal\gdpr_consent\Plugin\Field\FieldWidget\ConsentWidget::formElement()

Returns the form for a single field widget.

Field widget form elements should be based on the passed-in $element, which contains the base form element properties derived from the field configuration.

The BaseWidget methods will set the weight, field name and delta values for each form element. If there are multiple values for this field, the formElement() method will be called as many times as needed.

Other modules may alter the form element provided by this function using hook_field_widget_single_element_form_alter() or hook_field_widget_single_element_WIDGET_TYPE_form_alter().

The FAPI element callbacks (such as #process, #element_validate, #value_callback, etc.) used by the widget do not have access to the original $field_definition passed to the widget's constructor. Therefore, if any information is needed from that definition by those callbacks, the widget implementing this method, or a hook_field_widget[_WIDGET_TYPE]_form_alter() implementation, must extract the needed properties from the field definition and set them as ad-hoc $element['#custom'] properties, for later use by its element callbacks.

Parameters

\Drupal\Core\Field\FieldItemListInterface $items: Array of default values for this field.

int $delta: The order of this item in the array of sub-elements (0, 1, 2, etc.).

array $element: A form element array containing basic properties for the widget:

• #field_parents: The 'parents' space for the field in the form. Most widgets can simply overlook this property. This identifies the location where the field values are placed within $form_state->getValues(), and is used to access processing information for the field through the getWidgetState() and setWidgetState() methods.
• #title: The sanitized element label for the field, ready for output.
• #description: The sanitized element description for the field, ready for output.
• #required: A Boolean indicating whether the element value is required; for required multiple value fields, only the first widget's values are required.
• #delta: The order of this item in the array of sub-elements; see $delta above.

array $form: The form structure where widgets are being attached to. This might be a full form structure, or a sub-element of a larger form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form elements for a single widget for this field.

Overrides WidgetInterface::formElement

See also

hook_field_widget_single_element_form_alter()

hook_field_widget_single_element_WIDGET_TYPE_form_alter()

File

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

Class

ConsentWidget

Plugin implementation of the 'gdpr_consent_widget' widget.

Namespace

Drupal\gdpr_consent\Plugin\Field\FieldWidget

Code

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;
}