public function DateRecurBasicWidget::formElement in Recurring Dates Field 3.x

Same name and namespace in other branches

8.2 src/Plugin/Field/FieldWidget/DateRecurBasicWidget.php \Drupal\date_recur\Plugin\Field\FieldWidget\DateRecurBasicWidget::formElement()
3.0.x src/Plugin/Field/FieldWidget/DateRecurBasicWidget.php \Drupal\date_recur\Plugin\Field\FieldWidget\DateRecurBasicWidget::formElement()
3.1.x src/Plugin/Field/FieldWidget/DateRecurBasicWidget.php \Drupal\date_recur\Plugin\Field\FieldWidget\DateRecurBasicWidget::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 DateRangeDefaultWidget::formElement

File

src/Plugin/Field/FieldWidget/DateRecurBasicWidget.php, line 35

Class

DateRecurBasicWidget: Basic RRULE widget.

Namespace

Drupal\date_recur\Plugin\Field\FieldWidget

Code

public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) : array {
  $element = parent::formElement($items, $delta, $element, $form, $form_state);
  $element['#theme'] = 'date_recur_basic_widget';
  $element['#element_validate'][] = [
    $this,
    'validateRrule',
  ];

  // ::createDefaultValue isnt given enough context about the field item, so
  // override its functions here.
  $element['value']['#default_value'] = $element['end_value']['#default_value'] = NULL;
  $element['value']['#date_timezone'] = $element['end_value']['#date_timezone'] = NULL;
  $this
    ->createDateRecurDefaultValue($element, $items[$delta]);

  // Move fields into a first occurrence container as 'End date' can be
  // confused with 'End date' RRULE concept.
  $element['first_occurrence'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('First occurrence'),
    // Needs a weight otherwise children do not show up within single
    // cardinality widgets.
    '#weight' => 0,
  ];
  $firstOccurrenceParents = array_merge($element['#field_parents'], [
    $this->fieldDefinition
      ->getName(),
    $delta,
    'first_occurrence',
  ]);
  $element['value']['#title'] = $this
    ->t('Start');
  $element['end_value']['#title'] = $this
    ->t('End');
  $element['end_value']['#description'] = $this
    ->t('Leave end empty to copy start date; the occurrence will therefore not have any duration.');

  // The end date is never required. Start date is copied over if end date is
  // empty.
  $element['end_value']['#required'] = FALSE;
  $element['value']['#group'] = $element['end_value']['#group'] = implode('][', $firstOccurrenceParents);

  // Add custom value callbacks to correctly form a date from time zone field.
  $element['value']['#value_callback'] = $element['end_value']['#value_callback'] = [
    $this,
    'dateValueCallback',
  ];

  // Saved values (should) always have a time zone.
  $timeZone = $items[$delta]->timezone ?? NULL;
  $zones = $this
    ->getTimeZoneOptions();
  $element['timezone'] = [
    '#type' => 'select',
    '#title' => t('Time zone'),
    '#default_value' => $timeZone,
    '#options' => $zones,
  ];
  $element['rrule'] = [
    '#type' => 'textarea',
    '#default_value' => $items[$delta]->rrule ?? NULL,
    '#title' => $this
      ->t('Repeat rule'),
    '#description' => $this
      ->t('Repeat rule in <a href=":link">iCalendar Recurrence Rule</a> (RRULE) format.', [
      ':link' => 'https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html',
    ]),
  ];
  return $element;
}

You are here