Constructs a \Drupal\Component\Plugin\PluginBase object.

Gets the plugin_id of the plugin instance.

Gets the base_plugin_id of the plugin instance.

Gets the derivative_id of the plugin instance.

Gets the definition of the plugin implementation.

Determines if the plugin is configurable.

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Formats a string containing a count of items.

Returns the number of plurals supported by a given language.

Gets the string translation service.

Sets the string translation service to use.

{@inheritdoc}

{@inheritdoc}

Sets the messenger.

Gets the messenger.

Sets a form element's class attribute.

Adds 'required' and 'error' classes as needed.

Adds members of this group as actual elements for rendering.

Form element processing handler for the #ajax form property.

This method is useful for non-input elements that can be used in and outside the context of a form.

Adds Ajax information about an element to communicate with JavaScript.

If #ajax is set on an element, this additional JavaScript is added to the page header to attach the Ajax behaviors. See ajax.js for more information.

Arranges elements into groups.

This method is useful for non-input elements that can be used in and outside the context of a form.

Determines how user input is mapped to an element's #value property.

process callback for #pattern form element property.

element_validate callback for #pattern form element property.

Adds autocomplete functionality to elements.

This sets up autocomplete functionality for elements with an

autocomplete_route_name property, using the #autocomplete_route_parameters

property if present.

For example, suppose your autocomplete route name is 'mymodule.autocomplete' and its path is '/mymodule/autocomplete/{a}/{b}'. In a form array, you would create a text field with properties:

Specifies the start and end year to use as a date range.

Handles a string like -3:+3 or 2001:2010 to describe a dynamic range of minimum and maximum years to use in a date selector.

Centers the range around the current year, if any, but expands it far enough so it will pick up the year value in the field in case the value in the field is outside the initial range.

Returns the most relevant title of a datetime element.

Since datetime form elements often consist of combined date and time fields the element title might not be located on the element itself but on the parent container element.

Performs a callback.

If the callback is trusted the callback will occur. Trusted callbacks must be methods of a class that implements \Drupal\Core\Security\TrustedCallbackInterface or $extra_trusted_interface or be an anonymous function. If the callback is not trusted then whether or not the callback is called and what type of error is thrown depends on $error_type. To provide time for dependent code to use trusted callbacks use TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION and then at a later date change this to TrustedCallbackInterface::THROW_EXCEPTION.

Returns the element properties for this element.

Expands a datetime element type into date and/or time elements.

All form elements are designed to have sane defaults so any or all can be omitted. Both the date and time components are configurable so they can be output as HTML5 datetime elements or not, as desired.

Examples of possible configurations include: HTML5 date and time:

date_date_element = 'date';

#date_time_element = 'time';

HTML5 datetime:

date_date_element = 'datetime';

#date_time_element = 'none';

HTML5 time only:

date_date_element = 'none';

#date_time_element = 'time'

Non-HTML5:

date_date_element = 'text';

#date_time_element = 'text';

Required settings:

• default_value: A DrupalDateTime object, adjusted to the proper local

  timezone. Converting a date stored in the database from UTC to the local zone and converting it back to UTC before storing it is not handled here. This element accepts a date as the default value, and then converts the user input strings back into a new date object on submission. No timezone adjustment is performed. Optional properties include:

• date_date_format: A date format string that describes the format that

  should be displayed to the end user for the date. When using HTML5 elements the format MUST use the appropriate HTML5 format for that element, no other format will work. See the DateFormatterInterface::format() function for a list of the possible formats and HTML5 standards for the HTML5 requirements. Defaults to the right HTML5 format for the chosen element if an HTML5 element is used, otherwise defaults to DateFormat::load('html_date')->getPattern().

• date_date_element: The date element. Options are:

  • datetime: Use the HTML5 datetime element type.
  • datetime-local: Use the HTML5 datetime-local element type.
  • date: Use the HTML5 date element type.
  • text: No HTML5 element, use a normal text field.
  • none: Do not display a date element.

• date_date_callbacks: Array of optional callbacks for the date element.

• date_time_element: The time element. Options are:

  • time: Use an HTML5 time element type.
  • text: No HTML5 element, use a normal text field.
  • none: Do not display a time element.

• date_time_format: A date format string that describes the format that

  should be displayed to the end user for the time. When using HTML5 elements the format MUST use the appropriate HTML5 format for that element, no other format will work. See the DateFormatterInterface::format() function for a list of the possible formats and HTML5 standards for the HTML5 requirements. Defaults to the right HTML5 format for the chosen element if an HTML5 element is used, otherwise defaults to DateFormat::load('html_time')->getPattern().

• date_time_callbacks: An array of optional callbacks for the time

  element. Can be used to add a jQuery timepicker or an 'All day' checkbox.

• date_year_range: A description of the range of years to allow, like

  '1900:2050', '-3:+3' or '2000:+3', where the first value describes the earliest year and the second the latest year in the range. A year in either position means that specific year. A +/- value describes a dynamic value that is that many years earlier or later than the current year at the time the form is displayed. Used in HTML5 min/max date settings. Defaults to '1900:2050'.

• date_increment: The interval (step) to use when incrementing or

  decrementing time, in seconds. For example, if this value is set to 30, time increases (or decreases) in steps of 30 seconds (00:00:00, 00:00:30, 00:01:00, and so on.) If this value is a multiple of 60, the "seconds"-component will not be shown in the input. Used for HTML5 step values. Defaults to 1 to show every second.

• date_timezone: The Time Zone Identifier (TZID) to use when displaying

  or interpreting dates, i.e: 'Asia/Kolkata'. Defaults to the value returned by date_default_timezone_get().

Example usage:

Validation callback for a datetime element.

If the date is valid, the date object created from the user input is set in the form for use by the caller. The work of compiling the user input back into a date object is handled by the value callback, so we can use it here. We also have the raw input available for validation testing.

Creates an example for a date format.

This is centralized for a consistent method of creating these examples.

Retrieves the right format for an HTML5 date element.

The format is important because these elements will not work with any other format.

Retrieves the right format for an HTML5 time element.

The format is important because these elements will not work with any other format.