class DateRecurSubItem in Recurring Dates Field 3.0.x
Same name and namespace in other branches
- 8.2 tests/modules/date_recur_subfield/src/Plugin/Field/FieldType/DateRecurSubItem.php \Drupal\date_recur_subfield\Plugin\Field\FieldType\DateRecurSubItem
- 3.x tests/modules/date_recur_subfield/src/Plugin/Field/FieldType/DateRecurSubItem.php \Drupal\date_recur_subfield\Plugin\Field\FieldType\DateRecurSubItem
- 3.1.x tests/modules/date_recur_subfield/src/Plugin/Field/FieldType/DateRecurSubItem.php \Drupal\date_recur_subfield\Plugin\Field\FieldType\DateRecurSubItem
Extends Date Recur field.
Plugin annotation
@FieldType(
id = "date_recur_sub",
label = @Translation("Date Recur Sub"),
description = @Translation("Field subclassing date recur."),
default_widget = "date_recur_basic_widget",
default_formatter = "date_recur_basic_formatter",
list_class = "\Drupal\date_recur\Plugin\Field\FieldType\DateRecurFieldItemList"
)
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\datetime_range\Plugin\Field\FieldType\DateRangeItem
- class \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem
- class \Drupal\date_recur_subfield\Plugin\Field\FieldType\DateRecurSubItem
- class \Drupal\date_recur\Plugin\Field\FieldType\DateRecurItem
- class \Drupal\datetime_range\Plugin\Field\FieldType\DateRangeItem
- 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 DateRecurSubItem
1 file declares its use of DateRecurSubItem
- DateRecurSubFieldTest.php in tests/
src/ Kernel/ DateRecurSubFieldTest.php
File
- tests/
modules/ date_recur_subfield/ src/ Plugin/ Field/ FieldType/ DateRecurSubItem.php, line 22
Namespace
Drupal\date_recur_subfield\Plugin\Field\FieldTypeView source
class DateRecurSubItem extends DateRecurItem {
/**
* {@inheritdoc}
*/
public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) : array {
$properties = parent::propertyDefinitions($field_definition);
$properties['color'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Color'))
->setRequired(FALSE);
return $properties;
}
/**
* {@inheritdoc}
*/
public static function schema(FieldStorageDefinitionInterface $field_definition) : array {
$schema = parent::schema($field_definition);
$schema['columns']['color'] = [
'description' => 'Color',
'type' => 'varchar',
'not null' => FALSE,
'length' => '16',
];
return $schema;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DateRangeItem:: |
constant | Value for the 'datetime_type' setting: store a date and time. | ||
DateRecurItem:: |
protected | property | The date recur helper. | |
DateRecurItem:: |
public static | function |
Defines the field-level settings for this plugin. Overrides FieldItemBase:: |
|
DateRecurItem:: |
public static | function |
Defines the storage-level settings for this plugin. Overrides DateTimeItem:: |
|
DateRecurItem:: |
public | function |
Returns a form for the field-level settings. Overrides FieldItemBase:: |
|
DateRecurItem:: |
public | constant | Value for frequency setting: 'Disabled'. | |
DateRecurItem:: |
public | constant | Value for frequency setting: 'All parts'. | |
DateRecurItem:: |
public | constant | Value for frequency setting: 'Specify parts'. | |
DateRecurItem:: |
public static | function |
Generates placeholder field values. Overrides DateRangeItem:: |
|
DateRecurItem:: |
public | function | Get the date storage format of this field. | |
DateRecurItem:: |
public | function | Get the helper for this field item. | |
DateRecurItem:: |
public | function |
Determines whether the data structure is empty. Overrides DateRangeItem:: |
|
DateRecurItem:: |
public | function | Determine whether the field value is recurring/repeating. | |
DateRecurItem:: |
public | function |
React to changes to a child property or item. Overrides DateRangeItem:: |
|
DateRecurItem:: |
public static | function | After build used to format of submitted values. | |
DateRecurItem:: |
public | constant | Part used represent when all parts in a frequency are supported. | |
DateRecurItem:: |
public | function |
Defines custom presave behavior for field values. Overrides FieldItemBase:: |
|
DateRecurItem:: |
public | function | Resets helper value since source values changed. | |
DateRecurItem:: |
public | function |
Sets the data value. Overrides FieldItemBase:: |
|
DateRecurItem:: |
public | function |
Returns a form for the storage-level settings. Overrides DateRangeItem:: |
|
DateRecurSubItem:: |
public static | function |
Defines field item properties. Overrides DateRecurItem:: |
|
DateRecurSubItem:: |
public static | function |
Returns the schema for the field. Overrides DateRecurItem:: |
|
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 | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
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 | 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 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 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. | 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. | |
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 |