class SmartDateWidgetBase in Smart Date 8.2
Same name and namespace in other branches
- 8 src/Plugin/Field/FieldWidget/SmartDateWidgetBase.php \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
- 3.x src/Plugin/Field/FieldWidget/SmartDateWidgetBase.php \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
- 3.0.x src/Plugin/Field/FieldWidget/SmartDateWidgetBase.php \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
- 3.1.x src/Plugin/Field/FieldWidget/SmartDateWidgetBase.php \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
- 3.2.x src/Plugin/Field/FieldWidget/SmartDateWidgetBase.php \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
- 3.3.x src/Plugin/Field/FieldWidget/SmartDateWidgetBase.php \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
- 3.4.x src/Plugin/Field/FieldWidget/SmartDateWidgetBase.php \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
Base class for the 'smartdate_*' widgets.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase
- class \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
- class \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SmartDateWidgetBase
1 file declares its use of SmartDateWidgetBase
- SmartDateOverrideForm.php in modules/
smart_date_recur/ src/ Form/ SmartDateOverrideForm.php
File
- src/
Plugin/ Field/ FieldWidget/ SmartDateWidgetBase.php, line 22
Namespace
Drupal\smart_date\Plugin\Field\FieldWidgetView source
class SmartDateWidgetBase extends DateTimeWidgetBase {
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element = parent::formElement($items, $delta, $element, $form, $form_state);
$field_def = $this->fieldDefinition;
if ($field_def instanceof FieldConfigInterface) {
$allow_recurring = $field_def
->getThirdPartySetting('smart_date_recur', 'allow_recurring');
}
elseif ($field_def instanceof BaseFieldDefinition) {
// TODO: Document that for custom entities, you must enable recurring
// functionality by adding ->setSetting('allow_recurring', TRUE)
// to your field definition.
$allow_recurring = $field_def
->getSetting('allow_recurring');
}
else {
// Not sure what other method we can provide to define this.
$allow_recurring = FALSE;
}
// TODO: more elegant way to handle hiding recurring instances?
if ($allow_recurring && $items[$delta]->rrule) {
$rrule = SmartDateRule::load($items[$delta]->rrule);
if ($rrule && isset($form['#rules_processed'][$items[$delta]->rrule])) {
// Not the first instance, so skip this delta.
$element['#access'] = FALSE;
return $element;
}
else {
// Keep track of this rule as having been processed.
$form['#rules_processed'][$items[$delta]->rrule] = $items[$delta]->rrule;
$items[$delta]->value = (int) $rrule->start
->getString();
$items[$delta]->end_value = (int) $rrule->end
->getString();
$items[$delta]->duration = ($items[$delta]->end_value - $items[$delta]->value) / 60;
}
}
$form['#attached']['library'][] = 'smart_date/smart_date';
$defaults = $this->fieldDefinition
->getDefaultValueLiteral()[0];
$timezone = NULL;
if (!empty($items[$delta]->timezone)) {
$timezone = new \DateTimezone($items[$delta]->timezone);
}
$temp_tz = date_default_timezone_get();
$values['start'] = isset($items[$delta]->value) ? DrupalDateTime::createFromTimestamp($items[$delta]->value, $timezone) : '';
$values['end'] = isset($items[$delta]->end_value) ? DrupalDateTime::createFromTimestamp($items[$delta]->end_value, $timezone) : '';
$values['duration'] = isset($items[$delta]->duration) ? $items[$delta]->duration : $defaults['default_duration'];
$values['timezone'] = isset($items[$delta]->timezone) ? $items[$delta]->timezone : '';
$this
->createWidget($element, $values, $defaults);
if ($allow_recurring && function_exists('smart_date_recur_widget_extra_fields')) {
smart_date_recur_widget_extra_fields($element, $items[$delta], $this
->getSetting('modal'));
}
return $element;
}
/**
* Helper method to create SmartDate element.
*/
public static function createWidget(&$element, $values, ?array $defaults) {
// If an empty set of defaults provided, create our own.
if (empty($defaults)) {
$defaults = [
'default_duration_increments' => "30\n60|1 hour\n90\n120|2 hours\ncustom",
'default_duration' => '60',
];
}
// Wrap all of the select elements with a fieldset.
$element['#theme_wrappers'][] = 'fieldset';
$element['#element_validate'][] = [
static::class,
'validateStartEnd',
];
$element['value']['#title'] = t('Start');
$element['value']['#date_year_range'] = '1902:2037';
// Ensure values always display relative to the site.
$element['value']['#default_value'] = self::remapDatetime($values['start']);
$element['end_value'] = [
'#title' => t('End'),
// Ensure values always display relative to the site.
'#default_value' => self::remapDatetime($values['end']),
] + $element['value'];
$element['value']['#attributes']['class'] = [
'time-start',
];
$element['end_value']['#attributes']['class'] = [
'time-end',
];
// Parse the allowed duration increments and create labels if not provided.
$increments = SmartDateListItemBase::parseValues($defaults['default_duration_increments']);
foreach ($increments as $key => $label) {
if (strcmp($key, $label) !== 0) {
// Label provided, so no extra logic required.
continue;
}
if (is_numeric($key)) {
// Anything but whole minutes will create errors with the time field.
$num = (int) $key;
$increments[$key] = t('@count minutes', [
'@count' => $num,
]);
}
elseif ($key == 'custom') {
$increments[$key] = t('Custom');
}
else {
// Note sure what else we would encounter, so escape it.
$increments[$key] = t('@key (unrecognized format)', [
'@key' => $key,
]);
}
}
$default_duration = $values['duration'];
if (!array_key_exists($default_duration, $increments)) {
if (array_key_exists('custom', $increments)) {
$default_duration = 'custom';
}
else {
// TODO: throw some kind of error/warning if invalid duration?
$default_duration = '';
}
}
$element['duration'] = [
'#title' => t('Duration'),
'#type' => 'select',
'#options' => $increments,
'#default_value' => $default_duration,
'#attributes' => [
'data-default' => $defaults['default_duration'],
'class' => [
'field-duration',
],
],
];
// No true input, so preserve an existing value otherwise use site default.
$default_tz = isset($values['timezone']) ? $values['timezone'] : NULL;
$element['timezone'] = [
'#type' => 'hidden',
'#title' => t('Time zone'),
'#default_value' => $default_tz,
];
}
/**
* {@inheritdoc}
*/
public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
// The widget form element type has transformed the value to a
// DrupalDateTime object at this point. We need to convert it back to the
// storage timestamp.
foreach ($values as &$item) {
$timezone = NULL;
if (!empty($item['timezone'])) {
$timezone = new \DateTimezone($item['timezone']);
}
if (!empty($item['value']) && $item['value'] instanceof DrupalDateTime) {
/** @var \Drupal\Core\Datetime\DrupalDateTime $start_time */
$start_time = $item['value'];
// Adjust the date for storage.
$item['value'] = $this
->smartGetTimestamp($item['value'], $timezone);
}
if (!empty($item['end_value']) && $item['end_value'] instanceof DrupalDateTime) {
/** @var \Drupal\Core\Datetime\DrupalDateTime $end_time */
$end_time = $item['end_value'];
// Adjust the date for storage.
$item['end_value'] = $this
->smartGetTimestamp($item['end_value'], $timezone);
}
if ($item['duration'] == 'custom') {
// If using a custom duration, calculate based on start and end times.
if (isset($start_time) && isset($end_time) && $start_time instanceof DrupalDateTime && $end_time instanceof DrupalDateTime) {
$item['duration'] = (int) ($item['end_value'] - $item['value']) / 60;
}
}
}
if (!$form_state
->isValidationComplete()) {
// Make sure we only process once, after validation.
return $values;
}
// Skip any additional processing if the field doesn't allow recurring.
$field_def = $this->fieldDefinition;
if ($field_def instanceof FieldConfigInterface) {
$allow_recurring = $field_def
->getThirdPartySetting('smart_date_recur', 'allow_recurring');
}
elseif ($field_def instanceof BaseFieldDefinition) {
// TODO: Document that for custom entities, you must enable recurring
// functionality by adding ->setSetting('allow_recurring', TRUE)
// to your field definition.
$allow_recurring = $field_def
->getSetting('allow_recurring');
}
else {
// Not sure what other method we can provide to define this.
$allow_recurring = FALSE;
}
if ($allow_recurring && function_exists('smart_date_recur_widget_extra_fields')) {
// Provide extra parameters to be stored with the recurrence rule.
$month_limit = $field_def
->getThirdPartySetting('smart_date_recur', 'month_limit');
if ($form_state
->getFormObject() instanceof EntityFormInterface) {
$entity = $form_state
->getformObject()
->getEntity();
$entity_type = $entity
->getEntityTypeId();
$bundle = $entity
->bundle();
}
$field_name = $field_def
->getName();
smart_date_recur_generate_rows($values, $entity_type, $bundle, $field_name, $month_limit);
}
return $values;
}
/**
* Conditionally convert a DrupalDateTime object to a timestamp.
*
* @param \Drupal\Core\Datetime\DrupalDateTime $time
* The time to be converted.
* @param DateTimezone|null $timezone
* An optional timezone to use for conversion.
*/
private function smartGetTimestamp(DrupalDateTime $time, $timezone = NULL) {
// Map the date to be relative to a provided timezone, if supplied.
if ($timezone) {
$time = $this
->remapDatetime($time, $timezone);
}
return $time
->getTimestamp();
}
/**
* Conditionally convert a DrupalDateTime object to a timestamp.
*
* @param \Drupal\Core\Datetime\DrupalDateTime|null $time
* The time to be converted.
* @param DateTimezone|null $timezone
* An optional timezone to use for conversion.
*/
public static function remapDatetime($time, $timezone = NULL) {
if (empty($time)) {
return '';
}
$time = new DrupalDateTime($time
->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT), $timezone);
return $time;
}
/**
* Ensure that the start date <= the end date via #element_validate callback.
*
* @param array $element
* An associative array containing the properties and children of the
* generic form element.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
* The complete form structure.
*/
public static function validateStartEnd(array &$element, FormStateInterface $form_state, array &$complete_form) {
$start_time = $element['value']['#value']['object'];
$end_time = $element['end_value']['#value']['object'];
if ($start_time instanceof DrupalDateTime && $end_time instanceof DrupalDateTime) {
if ($start_time
->getTimestamp() !== $end_time
->getTimestamp()) {
$interval = $start_time
->diff($end_time);
if ($interval->invert === 1) {
$form_state
->setError($element, t('The @title end date cannot be before the start date', [
'@title' => $element['#title'],
]));
}
}
}
}
/**
* Special handling to create form elements for multiple values.
*
* Handles generic features for multiple fields:
* - number of widgets
* - AHAH-'add more' button
* - table display and drag-n-drop value reordering.
*/
protected function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) {
$field_name = $this->fieldDefinition
->getName();
$cardinality = $this->fieldDefinition
->getFieldStorageDefinition()
->getCardinality();
$parents = $form['#parents'];
// Determine the number of widgets to display.
switch ($cardinality) {
case FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED:
$field_state = static::getWidgetState($parents, $field_name, $form_state);
$max = $field_state['items_count'];
$is_multiple = TRUE;
break;
default:
$max = $cardinality - 1;
$is_multiple = $cardinality > 1;
break;
}
$title = $this->fieldDefinition
->getLabel();
$description = FieldFilteredMarkup::create(\Drupal::token()
->replace($this->fieldDefinition
->getDescription()));
$elements = [];
for ($delta = 0; $delta <= $max; $delta++) {
// Add a new empty item if it doesn't exist yet at this delta.
if (!isset($items[$delta])) {
$items
->appendItem();
}
// For multiple fields, title and description are handled by the wrapping
// table.
if ($is_multiple) {
$element = [
'#title' => $this
->t('@title (value @number)', [
'@title' => $title,
'@number' => $delta + 1,
]),
'#title_display' => 'invisible',
'#description' => '',
];
}
else {
$element = [
'#title' => $title,
'#title_display' => 'before',
'#description' => $description,
];
}
$element = $this
->formSingleElement($items, $delta, $element, $form, $form_state);
if ($element && (!isset($element['#access']) || $element['#access'] !== FALSE)) {
// Input field for the delta (drag-n-drop reordering).
if ($is_multiple) {
// We name the element '_weight' to avoid clashing with elements
// defined by widget.
$element['_weight'] = [
'#type' => 'weight',
'#title' => $this
->t('Weight for row @number', [
'@number' => $delta + 1,
]),
'#title_display' => 'invisible',
// Note: this 'delta' is the FAPI #type 'weight' element's property.
'#delta' => $max,
'#default_value' => $items[$delta]->_weight ?: $delta,
'#weight' => 100,
];
}
$elements[$delta] = $element;
}
}
if ($elements) {
$elements += [
'#theme' => 'field_multiple_value_form',
'#field_name' => $field_name,
'#cardinality' => $cardinality,
'#cardinality_multiple' => $this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple(),
'#required' => $this->fieldDefinition
->isRequired(),
'#title' => $title,
'#description' => $description,
'#max_delta' => $max,
];
// Add 'add more' button, if not working with a programmed form.
if ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED && !$form_state
->isProgrammed()) {
$id_prefix = implode('-', array_merge($parents, [
$field_name,
]));
$wrapper_id = Html::getUniqueId($id_prefix . '-add-more-wrapper');
$elements['#prefix'] = '<div id="' . $wrapper_id . '">';
$elements['#suffix'] = '</div>';
$elements['add_more'] = [
'#type' => 'submit',
'#name' => strtr($id_prefix, '-', '_') . '_add_more',
'#value' => t('Add another item'),
'#attributes' => [
'class' => [
'field-add-more-submit',
],
],
'#limit_validation_errors' => [
array_merge($parents, [
$field_name,
]),
],
'#submit' => [
[
get_class($this),
'addMoreSubmit',
],
],
'#ajax' => [
'callback' => [
get_class($this),
'addMoreAjax',
],
'wrapper' => $wrapper_id,
'effect' => 'fade',
],
];
}
}
return $elements;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AllowedTagsXssTrait:: |
public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | |
AllowedTagsXssTrait:: |
public | function | Returns a human-readable list of allowed tags for display in help texts. | |
AllowedTagsXssTrait:: |
public | function | Filters an HTML string to prevent XSS vulnerabilities. | |
DateTimeWidgetBase:: |
protected | function | Creates a date object for use as a default value. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsInterface:: |
42 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
SmartDateWidgetBase:: |
public static | function | Helper method to create SmartDate element. | |
SmartDateWidgetBase:: |
public | function |
Returns the form for a single field widget. Overrides DateTimeWidgetBase:: |
2 |
SmartDateWidgetBase:: |
protected | function |
Special handling to create form elements for multiple values. Overrides WidgetBase:: |
|
SmartDateWidgetBase:: |
public | function |
Massages the form values into the format expected for field values. Overrides DateTimeWidgetBase:: |
|
SmartDateWidgetBase:: |
public static | function | Conditionally convert a DrupalDateTime object to a timestamp. | |
SmartDateWidgetBase:: |
private | function | Conditionally convert a DrupalDateTime object to a timestamp. | |
SmartDateWidgetBase:: |
public static | function | Ensure that the start date <= the end date via #element_validate callback. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
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. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | Ajax callback for the "Add another item" button. | |
WidgetBase:: |
public static | function | Submission handler for the "Add another item" button. | |
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
5 |
WidgetBase:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface:: |
8 |
WidgetBase:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Creates a form element for a field. Overrides WidgetBaseInterface:: |
3 |
WidgetBase:: |
protected | function | Generates the form element for a single copy of the widget. | |
WidgetBase:: |
protected | function | Returns the value of a field setting. | |
WidgetBase:: |
protected | function | Returns the array of field settings. | |
WidgetBase:: |
protected | function | Returns the filtered field description. | |
WidgetBase:: |
public static | function |
Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
protected static | function | Returns the location of processing information within $form_state. | |
WidgetBase:: |
protected | function | Returns whether the widget handles multiple values. | |
WidgetBase:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetInterface:: |
4 |
WidgetBase:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public | function |
Returns a form to configure settings for the widget. Overrides WidgetInterface:: |
16 |
WidgetBase:: |
public | function |
Returns a short summary for the current widget settings. Overrides WidgetInterface:: |
15 |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
public | function |
Constructs a WidgetBase object. Overrides PluginBase:: |
5 |