class SmartDatePlainFormatter in Smart Date 3.0.x

Plugin implementation of the 'Plain' formatter for 'smartdate' fields.

This formatter renders the data range as a plain text string, with a configurable separator using an ISO-like date format string.

Plugin annotation

@FieldFormatter(
  id = "smartdate_plain",
  label = @Translation("Plain"),
  field_types = {
    "smartdate"
  }
)

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
          • class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimePlainFormatter
            • class \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDatePlainFormatter uses SmartDateTrait

File

src/Plugin/Field/FieldFormatter/SmartDatePlainFormatter.php, line 25

Namespace

Drupal\smart_date\Plugin\Field\FieldFormatter

class SmartDatePlainFormatter extends DateTimePlainFormatter {
  use SmartDateTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'separator' => '-',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $separator = $this
      ->getSetting('separator');
    foreach ($items as $delta => $item) {
      $item->start_time = isset($items[$delta]->value) ? DrupalDateTime::createFromTimestamp($items[$delta]->value) : '';
      $item->end_time = isset($items[$delta]->end_value) ? DrupalDateTime::createFromTimestamp($items[$delta]->end_value) : '';
      if (!empty($item->start_time) && !empty($item->end_time)) {

        /** @var \Drupal\Core\Datetime\DrupalDateTime $start_time */
        $start_time = $item->start_time;

        /** @var \Drupal\Core\Datetime\DrupalDateTime $end_time */
        $end_time = $item->end_time;
        if ($start_time
          ->getTimestamp() !== $end_time
          ->getTimestamp()) {
          $elements[$delta] = [
            'start_time' => $this
              ->buildDate($start_time),
            'separator' => [
              '#plain_text' => ' ' . $separator . ' ',
            ],
            'end_time' => $this
              ->buildDate($end_time),
          ];
        }
        else {
          $elements[$delta] = $this
            ->buildDate($start_time);
          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 render 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['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
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
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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	14
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
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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
SmartDatePlainFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides DateTimeFormatterBase::defaultSettings
SmartDatePlainFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides DateTimeFormatterBase::settingsForm
SmartDatePlainFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides DateTimeFormatterBase::settingsSummary
SmartDatePlainFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides SmartDateTrait::viewElements
SmartDateTrait::addRangeClasses	private	function
SmartDateTrait::arrayToRender	private static	function	Helper function to turn a simple, nested array into a render array.
SmartDateTrait::formatSmartDate	public static	function	Creates a formatted date value as a string.
SmartDateTrait::isAllDay	public static	function	Evaluates whether or not a provided range is "all day".
SmartDateTrait::loadSmartDateFormat	public static	function	Load a Smart Date Format from a format name.
SmartDateTrait::rangeDateReduce	private static	function	Reduce duplication in a provided date range.
SmartDateTrait::rangeFormat	private static	function	Format a provided range, using provided settings.
SmartDateTrait::timeFormat	private static	function	Helper function to apply time formats.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.