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 date element into an array of individual elements.

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_part_order: Array of date parts indicating the parts and order

  that should be used in the selector, optionally including 'ampm' for 12 hour time. Default is array('year', 'month', 'day', 'hour', 'minute').

• date_text_parts: Array of date parts that should be presented as

  text fields instead of drop-down selectors. Default is an empty array.

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

• 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. Defaults to '1900:2050'.

• date_increment: The increment to use for minutes and seconds, i.e.

  '15' would show only :00, :15, :30 and :45. Defaults to 1 to show every minute.

• 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 datelist 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.

Checks the input array for empty values.

Input array keys are checked against values in the parts array. Elements not in the parts array are ignored. Returns an array representing elements from the input array that have no value. If no empty values are found, returned array is empty.

Rounds minutes and seconds to nearest requested value.