class DateRangePlainFormatter
Same name in other branches
- 9 core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangePlainFormatter
- 8.9.x core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangePlainFormatter
- 11.x core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangePlainFormatter
Plugin implementation of the 'Plain' formatter for 'daterange' fields.
This formatter renders the data range as a plain text string, with a configurable separator using an ISO-like date format string.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
- class \Drupal\Core\Field\FormatterBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase extends \Drupal\Core\Field\FormatterBase
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimePlainFormatter extends \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase
- class \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangePlainFormatter extends \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimePlainFormatter uses \Drupal\datetime_range\DateTimeRangeTrait
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimePlainFormatter extends \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase extends \Drupal\Core\Field\FormatterBase
- class \Drupal\Core\Field\FormatterBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of DateRangePlainFormatter
2 files declare their use of DateRangePlainFormatter
- datetime_range.module in core/
modules/ datetime_range/ datetime_range.module - Field hooks to implement a datetime field that stores a start and end date.
- datetime_range.post_update.php in core/
modules/ datetime_range/ datetime_range.post_update.php - Post-update functions for Datetime Range module.
File
-
core/
modules/ datetime_range/ src/ Plugin/ Field/ FieldFormatter/ DateRangePlainFormatter.php, line 18
Namespace
Drupal\datetime_range\Plugin\Field\FieldFormatterView source
class DateRangePlainFormatter extends DateTimePlainFormatter {
use DateTimeRangeTrait;
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return static::dateTimeRangeDefaultSettings() + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$separator = $this->getSetting('separator');
foreach ($items as $delta => $item) {
if (!empty($item->start_date) && !empty($item->end_date)) {
/** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
$start_date = $item->start_date;
/** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
$end_date = $item->end_date;
if ($start_date->getTimestamp() !== $end_date->getTimestamp()) {
$elements[$delta] = $this->renderStartEnd($start_date, $separator, $end_date);
}
else {
$elements[$delta] = $this->buildDate($start_date);
if (!empty($item->_attributes)) {
$elements[$delta]['#attributes'] += $item->_attributes;
// Unset field item attributes since they have been included in the
// formatter output and should not be rendered in the field template.
unset($item->_attributes);
}
}
}
}
return $elements;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$form = parent::settingsForm($form, $form_state);
$form = $this->dateTimeRangeSettingsForm($form);
return $form;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
return array_merge(parent::settingsSummary(), $this->dateTimeRangeSettingsSummary());
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DateRangePlainFormatter::defaultSettings | public static | function | Defines the default settings for this plugin. | Overrides DateTimeFormatterBase::defaultSettings | |
DateRangePlainFormatter::settingsForm | public | function | Returns a form to configure settings for the formatter. | Overrides DateTimeFormatterBase::settingsForm | |
DateRangePlainFormatter::settingsSummary | public | function | Returns a short summary for the current formatter settings. | Overrides DateTimeFormatterBase::settingsSummary | |
DateRangePlainFormatter::viewElements | public | function | Builds a renderable array for a field value. | Overrides DateTimeRangeTrait::viewElements | |
DateTimeFormatterBase::$dateFormatStorage | protected | property | The date format entity storage. | ||
DateTimeFormatterBase::$dateFormatter | protected | property | The date formatter service. | ||
DateTimeFormatterBase::buildDate | protected | function | Creates a render array from a date object. | ||
DateTimeFormatterBase::buildDateWithIsoAttribute | protected | function | Creates a render array from a date object with ISO date attribute. | ||
DateTimeFormatterBase::create | public static | function | Creates an instance of the plugin. | Overrides FormatterBase::create | |
DateTimeFormatterBase::getFormatSettings | protected | function | Gets a settings array suitable for DrupalDateTime::format(). | ||
DateTimeFormatterBase::setTimeZone | protected | function | Sets the proper time zone on a DrupalDateTime object for the current user. | ||
DateTimeFormatterBase::__construct | public | function | Constructs a new DateTimeDefaultFormatter. | Overrides FormatterBase::__construct | |
DateTimePlainFormatter::formatDate | protected | function | Creates a formatted date value as a string. | Overrides DateTimeFormatterBase::formatDate | |
DateTimeRangeTrait::dateTimeRangeDefaultSettings | protected static | function | Get the default settings for a date and time range display. | ||
DateTimeRangeTrait::dateTimeRangeSettingsForm | protected | function | Configuration form for date time range. | ||
DateTimeRangeTrait::dateTimeRangeSettingsSummary | protected | function | Gets the date time range settings summary. | ||
DateTimeRangeTrait::endDateIsDisplayed | protected | function | Gets whether the end date should be displayed. | ||
DateTimeRangeTrait::getFromToOptions | protected | function | Returns a list of possible values for the 'from_to' setting. | ||
DateTimeRangeTrait::renderStartEnd | protected | function | Creates a render array given start/end dates. | ||
DateTimeRangeTrait::renderStartEndWithIsoAttribute | protected | function | Creates a render array with ISO attributes given start/end dates. | ||
DateTimeRangeTrait::startDateIsDisplayed | protected | function | Gets whether the start date should be displayed. | ||
FormatterBase::$fieldDefinition | protected | property | The field definition. | ||
FormatterBase::$label | protected | property | The label display setting. | ||
FormatterBase::$settings | protected | property | The formatter settings. | Overrides PluginSettingsBase::$settings | |
FormatterBase::$viewMode | protected | property | The view mode. | ||
FormatterBase::getFieldSetting | protected | function | Returns the value of a field setting. | ||
FormatterBase::getFieldSettings | protected | function | Returns the array of field settings. | ||
FormatterBase::isApplicable | public static | function | Returns if the formatter can be used for the provided field. | Overrides FormatterInterface::isApplicable | 12 |
FormatterBase::prepareView | public | function | Allows formatters to load information for field values being displayed. | Overrides FormatterInterface::prepareView | 2 |
FormatterBase::view | public | function | Builds a renderable array for a fully themed field. | Overrides FormatterInterface::view | 1 |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
PluginSettingsBase::$defaultSettingsMerged | protected | property | Whether default settings have been merged into the current $settings. | ||
PluginSettingsBase::$thirdPartySettings | protected | property | The plugin settings injected by third party modules. | ||
PluginSettingsBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 6 |
PluginSettingsBase::getSetting | public | function | Returns the value of a setting, or its default value if absent. | Overrides PluginSettingsInterface::getSetting | |
PluginSettingsBase::getSettings | public | function | Returns the array of settings, including defaults for missing settings. | Overrides PluginSettingsInterface::getSettings | |
PluginSettingsBase::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |
PluginSettingsBase::getThirdPartySetting | public | function | Gets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |
PluginSettingsBase::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |
PluginSettingsBase::mergeDefaults | protected | function | Merges default settings values into $settings. | ||
PluginSettingsBase::onDependencyRemoval | public | function | Informs the plugin that some configuration it depends on will be deleted. | Overrides PluginSettingsInterface::onDependencyRemoval | 3 |
PluginSettingsBase::setSetting | public | function | Sets the value of a setting for the plugin. | Overrides PluginSettingsInterface::setSetting | |
PluginSettingsBase::setSettings | public | function | Sets the settings for the plugin. | Overrides PluginSettingsInterface::setSettings | |
PluginSettingsBase::setThirdPartySetting | public | function | Sets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::setThirdPartySetting | |
PluginSettingsBase::unsetThirdPartySetting | public | function | Unsets a third-party setting. | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.