class DateRangeDefaultFormatter in Drupal 8
Same name and namespace in other branches
- 9 core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeDefaultFormatter.php \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangeDefaultFormatter
- 10 core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeDefaultFormatter.php \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangeDefaultFormatter
Plugin implementation of the 'Default' formatter for 'daterange' fields.
This formatter renders the data range using <time> elements, with configurable date formats (from the list of configured formats) and a separator.
Plugin annotation
@FieldFormatter(
id = "daterange_default",
label = @Translation("Default"),
field_types = {
"daterange"
}
)
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\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase implements ContainerFactoryPluginInterface
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter
- class \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangeDefaultFormatter uses DateTimeRangeTrait
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DateRangeDefaultFormatter
File
- core/
modules/ datetime_range/ src/ Plugin/ Field/ FieldFormatter/ DateRangeDefaultFormatter.php, line 24
Namespace
Drupal\datetime_range\Plugin\Field\FieldFormatterView source
class DateRangeDefaultFormatter extends DateTimeDefaultFormatter {
use DateTimeRangeTrait;
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'separator' => '-',
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$form = parent::settingsForm($form, $form_state);
$form['separator'] = [
'#type' => 'textfield',
'#title' => $this
->t('Date separator'),
'#description' => $this
->t('The string to separate the start and end dates'),
'#default_value' => $this
->getSetting('separator'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
if ($separator = $this
->getSetting('separator')) {
$summary[] = $this
->t('Separator: %separator', [
'%separator' => $separator,
]);
}
return $summary;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DateRangeDefaultFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides DateTimeDefaultFormatter:: |
|
DateRangeDefaultFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides DateTimeDefaultFormatter:: |
|
DateRangeDefaultFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides DateTimeDefaultFormatter:: |
|
DateTimeDefaultFormatter:: |
protected | function |
Creates a formatted date value as a string. Overrides DateTimeFormatterBase:: |
|
DateTimeFormatterBase:: |
protected | property | The date format entity storage. | |
DateTimeFormatterBase:: |
protected | property | The date formatter service. | |
DateTimeFormatterBase:: |
protected | function | Creates a render array from a date object. | |
DateTimeFormatterBase:: |
protected | function | Creates a render array from a date object with ISO date attribute. | |
DateTimeFormatterBase:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
DateTimeFormatterBase:: |
protected | function | Gets a settings array suitable for DrupalDateTime::format(). | |
DateTimeFormatterBase:: |
protected | function | Sets the proper time zone on a DrupalDateTime object for the current user. | |
DateTimeFormatterBase:: |
public | function |
Constructs a new DateTimeDefaultFormatter. Overrides FormatterBase:: |
|
DateTimeRangeTrait:: |
public | function | 2 | |
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 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
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 | 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:: |
|
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. |