class DateTimeDayItem in Date time day 8
Plugin implementation of the 'datetimeday' field type.
Plugin annotation
@FieldType(
id = "datetimeday",
label = @Translation("Date time day"),
description = @Translation("Create and store date time day field."),
default_widget = "datetimeday_default",
default_formatter = "datetimeday_default",
list_class = "\Drupal\date_time_day\Plugin\Field\FieldType\DateTimeDayFieldItemList"
)
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\datetime\Plugin\Field\FieldType\DateTimeItem implements DateTimeItemInterface
- class \Drupal\date_time_day\Plugin\Field\FieldType\DateTimeDayItem
- class \Drupal\datetime\Plugin\Field\FieldType\DateTimeItem implements DateTimeItemInterface
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
Expanded class hierarchy of DateTimeDayItem
7 files declare their use of DateTimeDayItem
- DateTimeDayComputed.php in src/
DateTimeDayComputed.php - DateTimeDayDefaultWidget.php in src/
Plugin/ Field/ FieldWidget/ DateTimeDayDefaultWidget.php - DateTimeDayFieldTest.php in tests/
src/ Functional/ DateTimeDayFieldTest.php - DateTimeDayItemTest.php in tests/
src/ Kernel/ DateTimeDayItemTest.php - DateTimeDaySecondsWidget.php in src/
Plugin/ Field/ FieldWidget/ DateTimeDaySecondsWidget.php
File
- src/
Plugin/ Field/ FieldType/ DateTimeDayItem.php, line 25
Namespace
Drupal\date_time_day\Plugin\Field\FieldTypeView source
class DateTimeDayItem extends DateTimeItem {
/**
* Values for the 'time_type' setting: store only a time, time & seconds.
*/
const DATEDAY_TIME_DEFAULT_TYPE_FORMAT = 'time';
const DATE_TIME_DAY_H_I_FORMAT_STORAGE_FORMAT = 'H:i';
const DATEDAY_TIME_TYPE_SECONDS_FORMAT = 'time_seconds';
const DATE_TIME_DAY_H_I_S_FORMAT_STORAGE_FORMAT = 'H:i:s';
/**
* {@inheritdoc}
*/
public static function defaultStorageSettings() {
return [
'datetime_type' => DateTimeItem::DATETIME_TYPE_DATE,
'time_type' => static::DATEDAY_TIME_DEFAULT_TYPE_FORMAT,
] + parent::defaultStorageSettings();
}
/**
* {@inheritdoc}
*/
public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
$properties = parent::propertyDefinitions($field_definition);
/** @var \Drupal\Core\TypedData\DataDefinition $date */
$date = $properties['date'];
$date
->setClass(DateDayComputed::class);
$properties['start_time_value'] = DataDefinition::create('string')
->setLabel(t('Start time value'))
->setRequired(TRUE);
$properties['start_time'] = DataDefinition::create('any')
->setLabel(t('Computed start time'))
->setDescription(t('The computed start DateTime object.'))
->setComputed(TRUE)
->setClass(DateTimeDayComputed::class)
->setSetting('date source', 'start_time_value');
$properties['end_time_value'] = DataDefinition::create('string')
->setLabel(t('End time value'))
->setRequired(TRUE);
$properties['end_time'] = DataDefinition::create('any')
->setLabel(t('Computed end time'))
->setDescription(t('The computed end DateTime object.'))
->setComputed(TRUE)
->setClass(DateTimeDayComputed::class)
->setSetting('date source', 'end_time_value');
return $properties;
}
/**
* {@inheritdoc}
*/
public static function schema(FieldStorageDefinitionInterface $field_definition) {
$schema = parent::schema($field_definition);
$schema['columns']['start_time_value'] = [
'description' => 'The start time value.',
] + $schema['columns']['value'];
$schema['columns']['end_time_value'] = [
'description' => 'The end time value.',
] + $schema['columns']['value'];
$schema['indexes']['start_time_value'] = [
'start_time_value',
];
$schema['indexes']['end_time_value'] = [
'end_time_value',
];
return $schema;
}
/**
* {@inheritdoc}
*/
public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
$element = parent::storageSettingsForm($form, $form_state, $has_data);
$element['time_type'] = [
'#type' => 'select',
'#title' => $this
->t('Day type'),
'#description' => $this
->t('Choose the type of time to create for the start and end time.'),
'#default_value' => $this
->getSetting('time_type'),
'#options' => [
static::DATEDAY_TIME_DEFAULT_TYPE_FORMAT => $this
->t('Start, end time of day'),
static::DATEDAY_TIME_TYPE_SECONDS_FORMAT => $this
->t('Start, end time of day with seconds'),
],
'#disabled' => $has_data,
];
return $element;
}
/**
* {@inheritdoc}
*/
public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
$values = parent::generateSampleValue($field_definition);
$timestamp = microtime() - mt_rand(0, 86400 * 365);
$start = $timestamp - 3600;
$end = $start + 3600;
$type = $field_definition
->getSetting('time_type');
if ($type === static::DATEDAY_TIME_DEFAULT_TYPE_FORMAT) {
$values['start_time_value'] = gmdate(static::DATE_TIME_DAY_H_I_FORMAT_STORAGE_FORMAT, $start);
$values['end_time_value'] = gmdate(static::DATE_TIME_DAY_H_I_FORMAT_STORAGE_FORMAT, $end);
}
if ($type === static::DATEDAY_TIME_TYPE_SECONDS_FORMAT) {
$values['start_time_value'] = gmdate(static::DATE_TIME_DAY_H_I_S_FORMAT_STORAGE_FORMAT, $start);
$values['end_time_value'] = gmdate(static::DATE_TIME_DAY_H_I_S_FORMAT_STORAGE_FORMAT, $end);
}
return $values;
}
/**
* {@inheritdoc}
*/
public function isEmpty() {
$value = $this
->get('value')
->getValue();
$start_value = $this
->get('start_time_value')
->getValue();
$end_value = $this
->get('end_time_value')
->getValue();
return ($value === NULL || $value === '') && ($start_value === NULL || $start_value === '') && ($end_value === NULL || $end_value === '');
}
/**
* {@inheritdoc}
*/
public function onChange($property_name, $notify = TRUE) {
// Enforce that the computed date is recalculated.
if ($property_name == 'start_time_value') {
$this->start_time = NULL;
}
elseif ($property_name == 'end_time_value') {
$this->end_time = NULL;
}
parent::onChange($property_name, $notify);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DateTimeDayItem:: |
constant | Values for the 'time_type' setting: store only a time, time & seconds. | ||
DateTimeDayItem:: |
constant | |||
DateTimeDayItem:: |
constant | |||
DateTimeDayItem:: |
constant | |||
DateTimeDayItem:: |
public static | function |
Defines the storage-level settings for this plugin. Overrides DateTimeItem:: |
|
DateTimeDayItem:: |
public static | function |
Generates placeholder field values. Overrides DateTimeItem:: |
|
DateTimeDayItem:: |
public | function |
Determines whether the data structure is empty. Overrides DateTimeItem:: |
|
DateTimeDayItem:: |
public | function |
React to changes to a child property or item. Overrides DateTimeItem:: |
|
DateTimeDayItem:: |
public static | function |
Defines field item properties. Overrides DateTimeItem:: |
|
DateTimeDayItem:: |
public static | function |
Returns the schema for the field. Overrides DateTimeItem:: |
|
DateTimeDayItem:: |
public | function |
Returns a form for the storage-level settings. Overrides DateTimeItem:: |
|
DateTimeItem:: |
constant | Value for the 'datetime_type' setting: store only a date. | ||
DateTimeItem:: |
constant | Value for the 'datetime_type' setting: store a date and time. | ||
DateTimeItemInterface:: |
constant | Defines the format that date and time should be stored in. | ||
DateTimeItemInterface:: |
constant | Defines the format that dates should be stored in. | ||
DateTimeItemInterface:: |
constant | Defines the timezone that dates should be stored in. | ||
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 | |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items on the storage level. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Defines the field-level settings for this plugin. Overrides FieldItemInterface:: |
7 |
FieldItemBase:: |
public | function |
Defines custom delete behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom revision delete behavior for field values. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Returns a form for the field-level settings. Overrides FieldItemInterface:: |
7 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Gets the entity that field belongs to. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the field definition. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the langcode of the field values held in the object. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function | Returns the value of a field setting. | |
FieldItemBase:: |
protected | function | Returns the array of field settings. | |
FieldItemBase:: |
public static | function |
Returns the name of the main property, if any. Overrides FieldItemInterface:: |
8 |
FieldItemBase:: |
public static | function |
Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom presave behavior for field values. Overrides FieldItemInterface:: |
7 |
FieldItemBase:: |
public | function |
Sets the data value. Overrides Map:: |
4 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Returns a renderable array for a single field item. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function |
Different to the parent Map class, we avoid creating property objects as
far as possible in order to optimize performance. Thus we just update
$this->values if no property object has been created yet. Overrides Map:: |
|
FieldItemBase:: |
public | function |
Constructs a TypedData object given its definition and context. Overrides TypedData:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Gets a property value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Magic method: Determines whether a property is set. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Magic method: Sets a property value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Unsets a property. Overrides FieldItemInterface:: |
|
Map:: |
protected | property |
The data definition. Overrides TypedData:: |
|
Map:: |
protected | property | The array of properties. | |
Map:: |
protected | property | An array of values for the contained properties. | |
Map:: |
public | function |
Applies the default value. Overrides TypedData:: |
4 |
Map:: |
public | function |
Gets a property object. Overrides ComplexDataInterface:: |
|
Map:: |
public | function | ||
Map:: |
public | function |
Gets an array of property objects. Overrides ComplexDataInterface:: |
|
Map:: |
public | function |
Returns a string representation of the data. Overrides TypedData:: |
|
Map:: |
public | function |
Gets the data value. Overrides TypedData:: |
1 |
Map:: |
public | function |
Sets a property value. Overrides ComplexDataInterface:: |
|
Map:: |
public | function |
Returns an array of all property values. Overrides ComplexDataInterface:: |
1 |
Map:: |
public | function | Magic method: Implements a deep clone. | |
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. | |
TypedData:: |
protected | property | The property name. | |
TypedData:: |
protected | property | The parent typed data object. | |
TypedData:: |
public static | function |
Constructs a TypedData object given its definition and context. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets a list of validation constraints. Overrides TypedDataInterface:: |
9 |
TypedData:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the name of a property or item. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Returns the property path of the data. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the root of the typed data tree. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Validates the currently set data value. Overrides TypedDataInterface:: |
|
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |