public function TimestampDatetimeNoDefaultWidget::formElement in Scheduler 2.x

Same name and namespace in other branches

8 src/Plugin/Field/FieldWidget/TimestampDatetimeNoDefaultWidget.php \Drupal\scheduler\Plugin\Field\FieldWidget\TimestampDatetimeNoDefaultWidget::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 TimestampDatetimeWidget::formElement

File

src/Plugin/Field/FieldWidget/TimestampDatetimeNoDefaultWidget.php, line 28

Class

TimestampDatetimeNoDefaultWidget: Plugin implementation of the 'datetime timestamp' widget.

Namespace

Drupal\scheduler\Plugin\Field\FieldWidget

Code

public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
  $element = parent::formElement($items, $delta, $element, $form, $form_state);

  // The default description "Format: html-date html-time. Leave blank to use
  // the time of form submission" is inherited from TimestampDatetimeWidget,
  // but this is entirely replaced in _scheduler_entity_form_alter().
  // However this widget is generic and may be used elsewhere, so provide
  // an accurate #description here.
  $element['value']['#description'] = $this
    ->t('Leave blank for no date.');

  // Set the callback function to allow interception of the submitted user
  // input and add the default time if needed. It is too late to try this in
  // function massageFormValues as the validation has already been done.
  $element['value']['#value_callback'] = [
    $this,
    'valueCallback',
  ];

  // Hide the seconds portion of the time input element if that option is set.
  if (\Drupal::config('scheduler.settings')
    ->get('hide_seconds')) {
    $element['value']['#date_increment'] = 60;

    // Some browsers HTML5 date element implementations show the seconds on
    // pre-existing date values event though the number cannot be changed. To
    // reduce confusion set the seconds to zero so that the browsers
    // validation messages only have hours and minutes.
    $current_value = $element['value']['#default_value'];
    if (is_object($current_value)) {
      $current_value
        ->setTime($current_value
        ->format('H'), $current_value
        ->format('i'), 0);
    }
  }
  return $element;
}

You are here