class Date in Webform 6.x
Same name and namespace in other branches
- 8.5 src/Plugin/WebformElement/Date.php \Drupal\webform\Plugin\WebformElement\Date
Provides a 'date' element.
Plugin annotation
@WebformElement(
id = "date",
api = "https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Render!Element!Date.php/class/Date",
label = @Translation("Date"),
description = @Translation("Provides a form element for date selection."),
category = @Translation("Date/time elements"),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\webform\Plugin\WebformElementBase implements TrustedCallbackInterface, WebformElementInterface uses MessengerTrait, StringTranslationTrait, WebformCompositeFormElementTrait, WebformEntityStorageTrait, WebformEntityInjectionTrait
Expanded class hierarchy of Date
5 string references to 'Date'
- hook_webform_element_input_masks in ./
webform.api.php - Return information about input masks for text based webform elements.
- TextBase::getInputMasks in src/
Plugin/ WebformElement/ TextBase.php - Get input masks.
- WebformDevelSchema::getElement in modules/
webform_devel/ src/ WebformDevelSchema.php - Get webform element schema.
- WebformExampleCustomFormSettingsForm::buildForm in modules/
webform_example_custom_form/ src/ Form/ WebformExampleCustomFormSettingsForm.php - Form constructor.
- WebformSubmissionLogController::overview in modules/
webform_submission_log/ src/ Controller/ WebformSubmissionLogController.php - Displays a listing of webform submission log messages.
File
- src/
Plugin/ WebformElement/ Date.php, line 20
Namespace
Drupal\webform\Plugin\WebformElementView source
class Date extends DateBase {
/**
* {@inheritdoc}
*/
protected function defineDefaultProperties() {
$date_format = '';
// Date formats cannot be loaded during install or update.
if (!defined('MAINTENANCE_MODE')) {
/** @var \Drupal\Core\Datetime\DateFormatInterface $date_format_entity */
if ($date_format_entity = DateFormat::load('html_date')) {
$date_format = $date_format_entity
->getPattern();
}
}
$properties = [
// Date settings.
'date_date_format' => $date_format,
'placeholder' => '',
'step' => '',
'size' => '',
] + parent::defineDefaultProperties();
if ($this
->datePickerExists()) {
$properties += [
'datepicker' => FALSE,
'datepicker_button' => FALSE,
];
}
return $properties;
}
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
// Unset unsupported date format for date elements that are not using a
// datepicker.
if (empty($element['#datepicker'])) {
unset($element['#date_date_format']);
}
// Set default date format to HTML date.
if (!isset($element['#date_date_format'])) {
$element['#date_date_format'] = $this
->getDefaultProperty('date_date_format');
}
// Set placeholder attribute.
if (!empty($element['#placeholder'])) {
$element['#attributes']['placeholder'] = $element['#placeholder'];
}
// Prepare element after date format has been updated.
parent::prepare($element, $webform_submission);
// Set the (input) type attribute to 'date'.
// @see \Drupal\Core\Render\Element\Date::getInfo
$element['#attributes']['type'] = 'date';
// Convert date element into textfield with date picker.
if ($this
->datePickerExists() && !empty($element['#datepicker'])) {
$element['#attributes']['type'] = 'text';
// Must manually set 'data-drupal-date-format' to trigger date picker.
// @see \Drupal\Core\Render\Element\Date::processDate
$element['#attributes']['data-drupal-date-format'] = [
$element['#date_date_format'],
];
}
}
/**
* {@inheritdoc}
*/
public function setDefaultValue(array &$element) {
parent::setDefaultValue($element);
// Format date picker default value.
if ($this
->datePickerExists() && !empty($element['#datepicker'])) {
if (isset($element['#default_value'])) {
if ($this
->hasMultipleValues($element)) {
foreach ($element['#default_value'] as $index => $default_value) {
$element['#default_value'][$index] = static::formatDate($element['#date_date_format'], strtotime($default_value));
}
}
else {
$element['#default_value'] = static::formatDate($element['#date_date_format'], strtotime($element['#default_value']));
}
}
}
}
/**
* {@inheritdoc}
*/
public function getItemFormat(array $element) {
$format = parent::getItemFormat($element);
// Drupal's default date fallback includes the time so we need to fallback
// to the specified or default date only format.
if ($format === 'fallback') {
$format = isset($element['#date_date_format']) ? $element['#date_date_format'] : $this
->getDefaultProperty('date_date_format');
}
return $format;
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
if (!$this
->datePickerExists()) {
return $form;
}
if ($this
->datePickerExists()) {
$form['date']['datepicker'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use date picker'),
'#description' => $this
->t('If checked, the HTML5 date element will be replaced with a <a href="https://jqueryui.com/datepicker/">jQuery UI datepicker</a>'),
'#return_value' => TRUE,
];
$form['date']['datepicker_button'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Show date picker button'),
'#description' => $this
->t('If checked, date picker will include a calendar button'),
'#return_value' => TRUE,
'#states' => [
'visible' => [
':input[name="properties[datepicker]"]' => [
'checked' => TRUE,
],
],
],
];
$date_format = DateFormat::load('html_date')
->getPattern();
$form['date']['date_date_format'] = [
'#type' => 'webform_select_other',
'#title' => $this
->t('Date format'),
'#options' => [
$date_format => $this
->t('HTML date - @format (@date)', [
'@format' => $date_format,
'@date' => static::formatDate($date_format),
]),
'l, F j, Y' => $this
->t('Long date - @format (@date)', [
'@format' => 'l, F j, Y',
'@date' => static::formatDate('l, F j, Y'),
]),
'D, m/d/Y' => $this
->t('Medium date - @format (@date)', [
'@format' => 'D, m/d/Y',
'@date' => static::formatDate('D, m/d/Y'),
]),
'm/d/Y' => $this
->t('Short date - @format (@date)', [
'@format' => 'm/d/Y',
'@date' => static::formatDate('m/d/Y'),
]),
],
'#description' => $this
->t("Date format is only applicable for browsers that do not have support for the HTML5 date element. Browsers that support the HTML5 date element will display the date using the user's preferred format."),
'#other__option_label' => $this
->t('Custom…'),
'#other__placeholder' => $this
->t('Custom date format…'),
'#other__description' => $this
->t('Enter date format using <a href="http://php.net/manual/en/function.date.php">Date Input Format</a>.'),
'#states' => [
'visible' => [
':input[name="properties[datepicker]"]' => [
'checked' => TRUE,
],
],
],
];
// Show placeholder for the datepicker only.
$form['form']['placeholder']['#states'] = [
'visible' => [
':input[name="properties[datepicker]"]' => [
'checked' => TRUE,
],
],
];
}
$form['date']['date_container']['step'] = [
'#type' => 'number',
'#title' => $this
->t('Step'),
'#description' => $this
->t('Specifies the legal number intervals.'),
'#min' => 1,
'#size' => 4,
'#states' => [
'invisible' => [
':input[name="properties[datepicker]"]' => [
'checked' => TRUE,
],
],
],
];
return $form;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Date:: |
protected | function |
Define an element's default properties. Overrides DateBase:: |
|
Date:: |
public | function |
Gets the actual configuration webform array to be built. Overrides DateBase:: |
|
Date:: |
public | function |
Get element's single value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementBase:: |
|
Date:: |
public | function |
Prepare an element to be rendered within a webform. Overrides DateBase:: |
|
Date:: |
public | function |
Set an element's default value using saved data. Overrides DateBase:: |
|
DateBase:: |
protected | property | The date formatter service. | |
DateBase:: |
public static | function | After build handler for date elements. | 1 |
DateBase:: |
public | function |
Build an element's export row. Overrides WebformElementBase:: |
|
DateBase:: |
public static | function |
Creates an instance of the plugin. Overrides WebformElementBase:: |
|
DateBase:: |
protected | function | Determine if the the jQuery UI date picker is supported. | |
DateBase:: |
protected static | function | Specifies the start and end year to use as a date range. | |
DateBase:: |
protected static | function | Format custom date. | |
DateBase:: |
protected | function |
Format an element's value as text. Overrides WebformElementBase:: |
|
DateBase:: |
protected | function | Get the type of date/time element. | |
DateBase:: |
public | function |
Get an element's default single value format name. Overrides WebformElementBase:: |
|
DateBase:: |
public | function |
Get an element's available single value formats. Overrides WebformElementBase:: |
|
DateBase:: |
public | function |
Get test values for an element. Overrides WebformElementBase:: |
|
DateBase:: |
protected | function | Parse GNU Date Input Format. | |
DateBase:: |
protected | function |
Prepare an element's validation callbacks. Overrides WebformElementBase:: |
|
DateBase:: |
public static | function | Webform element pre validation handler for Date elements. | |
DateBase:: |
protected | function | Set GNU date input format error. | |
DateBase:: |
public | function |
Form validation handler. Overrides WebformElementBase:: |
1 |
DateBase:: |
public static | function | Webform element validation handler for date elements. | |
DateBase:: |
protected | function | Validate GNU date input format. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. | ||
WebformCompositeFormElementTrait:: |
public static | function | Adds form element theming to an element if its title or description is set. | 1 |
WebformElementBase:: |
protected | property | The configuration factory. | |
WebformElementBase:: |
protected | property | The current user. | |
WebformElementBase:: |
protected | property | An associative array of an element's default properties names and values. | |
WebformElementBase:: |
protected | property | A element info manager. | |
WebformElementBase:: |
protected | property | The webform element manager. | |
WebformElementBase:: |
protected | property |
The entity type manager. Overrides WebformEntityStorageTrait:: |
|
WebformElementBase:: |
protected | property | The webform libraries manager. | |
WebformElementBase:: |
protected | property | A logger instance. | |
WebformElementBase:: |
protected | property | The module handler. | |
WebformElementBase:: |
protected | property | The token manager. | |
WebformElementBase:: |
protected | property | An indexed array of an element's translated properties. | |
WebformElementBase:: |
public | function |
Alter an element's associated form. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Build an element as text or HTML. | 4 |
WebformElementBase:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
3 |
WebformElementBase:: |
protected | function | Build configuration form tabs. | 1 |
WebformElementBase:: |
public | function |
Build an element's export header. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Get an element's export options webform. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Build an element as HTML element. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Build an element as text element. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Checks an access rule against a user account's roles and id. | |
WebformElementBase:: |
public | function |
Check element access (rules). Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Define default base properties used by all elements. | 4 |
WebformElementBase:: |
protected | function | Define default multiple properties used by most elements. | 1 |
WebformElementBase:: |
protected | function | Define an element's translatable properties. | 17 |
WebformElementBase:: |
public | function |
Display element disabled warning. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Finalize an element to be rendered within a webform. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Format an element's value as HTML or plain text. | 2 |
WebformElementBase:: |
protected | function | Format an element's item using custom HTML or plain text. | 2 |
WebformElementBase:: |
protected | function | Format an element's items using custom HTML or plain text. | |
WebformElementBase:: |
public | function |
Format an element's value as HTML. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
protected | function | Format an element's value as HTML. | 19 |
WebformElementBase:: |
protected | function | Format an element's items as HTML. | 2 |
WebformElementBase:: |
public | function |
Format an element's table column value. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Format an element's value as plain text. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
protected | function | Format an element's items as text. | 2 |
WebformElementBase:: |
public | function |
Get an element's admin label (#admin_title, #title or #webform_key). Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an associative array of element properties from configuration webform. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
protected | function | Get configuration property value. | 1 |
WebformElementBase:: |
public | function |
Gets the element's default key. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Get default properties. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's default property value. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Get a render element's default property. | |
WebformElementBase:: |
public | function |
Get an element's property value. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Get an element's (sub)inputs selectors as options. | 9 |
WebformElementBase:: |
public | function |
Get an element's (sub)input selector value. Overrides WebformElementInterface:: |
5 |
WebformElementBase:: |
public | function |
Get an element's selectors as options. Overrides WebformElementInterface:: |
11 |
WebformElementBase:: |
public | function |
Get an element's selectors source values. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
public | function |
Get an element's supported states as options. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Get an element's default export options. Overrides WebformElementInterface:: |
5 |
WebformElementBase:: |
public | function |
Get the Webform element's form element class definition. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Get form--inline container which is used for side-by-side element layout. | |
WebformElementBase:: |
public | function |
Retrieves the default properties for the defined element type. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's default multiple value format name. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Get element's multiple value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's available multiple value formats. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Get an element's key/name. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's label (#title or #webform_key). Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get configuration form's off-canvas width. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Get link to element's API documentation. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get the URL for the element's API documentation. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Gets the category of the plugin instance. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Gets the description of the plugin instance. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Gets the label of the plugin instance. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
public | function |
Get an element's submission raw value. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get related element types. Overrides WebformElementInterface:: |
6 |
WebformElementBase:: |
public | function |
Get element's table column(s) settings. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Get translatable properties. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Gets the type name (aka id) of the plugin instance with the 'webform_' prefix. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's submission value. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Determine if the element has a composite field wrapper. | |
WebformElementBase:: |
public | function |
Determine if the element is or includes a managed_file upload element. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Checks if the element value has multiple values. Overrides WebformElementInterface:: |
6 |
WebformElementBase:: |
public | function |
Checks if the element uses the 'webform_multiple' element. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
public | function |
Determine if the element supports a specified property. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Determine if an element's has a submission value. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Checks if the element has a wrapper. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public static | function | Webform element #after_build callback. | |
WebformElementBase:: |
public | function |
Initialize an element to be displayed, rendered, or exported. Overrides WebformElementInterface:: |
8 |
WebformElementBase:: |
public | function |
Checks if the element is a composite element. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Checks if the element is a container that can contain elements. Overrides WebformElementInterface:: |
9 |
WebformElementBase:: |
public | function |
Checks if the element is disabled. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Checks if an empty element is excluded. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Checks if the element is enabled. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Checks if the element is excluded via webform.settings. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Checks if the element is hidden. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Checks if the element carries a value. Overrides WebformElementInterface:: |
11 |
WebformElementBase:: |
public | function |
Checks if the element value could contain multiple lines. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Checks if the element is a root element. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
public | function |
Acts on a webform submission element after it is created. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Delete any additional value associated with an element. Overrides WebformElementInterface:: |
5 |
WebformElementBase:: |
public | function |
Acts on loaded webform submission. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Acts on a saved webform submission element before the insert or update hook is invoked. Overrides WebformElementInterface:: |
5 |
WebformElementBase:: |
public | function |
Changes the values of an entity before it is created. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function | 1 | |
WebformElementBase:: |
protected | function | Prefix an element's export header. | |
WebformElementBase:: |
protected | function | Replace Core's composite #pre_render with Webform's composite #pre_render. | |
WebformElementBase:: |
protected | function | Prepare an element's pre render callbacks. | 3 |
WebformElementBase:: |
protected | function | Set multiple element wrapper. | 1 |
WebformElementBase:: |
protected | function | Set an elements #states and flexbox wrapper. | 1 |
WebformElementBase:: |
public static | function | Fix flexbox wrapper. | |
WebformElementBase:: |
public static | function | Fix state wrapper. | |
WebformElementBase:: |
public | function |
Acts on a webform submission element before the presave hook is invoked. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Generate a renderable preview of the element. Overrides WebformElementInterface:: |
37 |
WebformElementBase:: |
public | function |
Replace tokens for all element properties. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Set an element's configuration webform element default value. | 2 |
WebformElementBase:: |
protected | function | Set configuration webform default values recursively. | |
WebformElementBase:: |
protected | function | Set element's default callback. | |
WebformElementBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
|
WebformElementBase:: |
public | function |
Checks if the element supports multiple values. Overrides WebformElementInterface:: |
8 |
WebformElementBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
1 |
WebformElementBase:: |
public static | function | Form API callback. Validate element #minlength value. | |
WebformElementBase:: |
public static | function | Form API callback. Validate element #multiple > 1 value. | |
WebformElementBase:: |
public static | function | Form API callback. Validate element #unique value. | |
WebformElementBase:: |
public static | function | Form API callback. Validate element #unique multiple values. | |
WebformEntityInjectionTrait:: |
protected | property | The webform. | 1 |
WebformEntityInjectionTrait:: |
protected | property | The webform submission. | 1 |
WebformEntityInjectionTrait:: |
public | function | Get the webform that this handler is attached to. | |
WebformEntityInjectionTrait:: |
public | function | Set webform and webform submission entity. | |
WebformEntityInjectionTrait:: |
public | function | Reset webform and webform submission entity. | |
WebformEntityInjectionTrait:: |
public | function | ||
WebformEntityInjectionTrait:: |
public | function | Set the webform that this is handler is attached to. | |
WebformEntityInjectionTrait:: |
public | function | Get the webform submission that this handler is handling. | |
WebformEntityStorageTrait:: |
protected | property | An associate array of entity type storage aliases. | |
WebformEntityStorageTrait:: |
protected | function | Retrieves the entity storage. | |
WebformEntityStorageTrait:: |
protected | function | Retrieves the webform submission storage. | |
WebformEntityStorageTrait:: |
protected | function | Retrieves the webform storage. | |
WebformEntityStorageTrait:: |
public | function | Implements the magic __get() method. |