class SmartDateCustomFormatter in Smart Date 3.0.x

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

This formatter renders the time range as plain text, with a fully configurable date format using the PHP date syntax and separator.

Plugin annotation

@FieldFormatter(
  id = "smartdate_custom",
  label = @Translation("Custom"),
  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\Core\Field\Plugin\Field\FieldFormatter\TimestampFormatter
          • class \Drupal\smart_date\Plugin\Field\FieldFormatter\SmartDateCustomFormatter uses SmartDateTrait

File

src/Plugin/Field/FieldFormatter/SmartDateCustomFormatter.php, line 23

Namespace

Drupal\smart_date\Plugin\Field\FieldFormatter

class SmartDateCustomFormatter extends TimestampFormatter {
  use SmartDateTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'separator' => ' - ',
      'join' => ', ',
      'time_format' => 'g:ia',
      'time_hour_format' => 'ga',
      'date_format' => 'D, M j Y',
      'allday_label' => 'All day',
      'date_first' => '1',
      'ampm_reduce' => '1',
      'site_time_toggle' => '1',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);

    // Don't need format_type provided by parent, so unset.
    unset($form['format_type']);
    $form['separator'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Time separator'),
      '#description' => $this
        ->t('The string to separate the start and end times. Include spaces before and after if those are desired.'),
      '#default_value' => $this
        ->getSetting('separator'),
    ];
    $form['join'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Date/time join'),
      '#description' => $this
        ->t('The characters that will be used to join dates and their associated times.'),
      '#default_value' => $this
        ->getSetting('join'),
    ];
    $form['time_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('PHP Time Format'),
      '#description' => $this
        ->t('The PHP date code to use for formatting times.'),
      '#default_value' => $this
        ->getSetting('time_format'),
    ];
    $form['time_hour_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('PHP Time Format - on the hour'),
      '#description' => $this
        ->t('The PHP date code to use for formatting times that fall on the hour. Examples might be 2pm or 14h. Leave this blank to always use the standard format specified above.'),
      '#default_value' => $this
        ->getSetting('time_format'),
    ];
    $form['date_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('PHP Date Format'),
      '#description' => $this
        ->t('The PHP date code to use for formatting dates.'),
      '#default_value' => $this
        ->getSetting('date_format'),
    ];
    $form['allday_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('All Day Label'),
      '#description' => $this
        ->t('What to output when an event has been set to run all day. Leave blank to only show the date.'),
      '#default_value' => $this
        ->getSetting('allday_label'),
    ];
    $form['date_first'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('First part shown'),
      '#description' => $this
        ->t('Specify whether the time or date should be shown first.'),
      '#default_value' => $this
        ->getSetting('first'),
      '#options' => [
        '1' => $this
          ->t('Date'),
        '0' => $this
          ->t('Time'),
      ],
    ];
    $form['ampm_reduce'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Reduce AM/PM display'),
      '#description' => $this
        ->t("Don't show am/pm in the start time if it's the same as the value for the end time, in the same day. Note that this is recommended by the Associated Press style guide."),
      '#default_value' => $this
        ->getSetting('ampm_reduce'),
    ];
    $form['site_time_toggle'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Turn off site time display'),
      '#description' => $this
        ->t("Don't show default site time in parentheses at end of the value."),
      '#default_value' => $this
        ->getSetting('site_time_toggle'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    if ($separator = $this
      ->getSetting('separator')) {
      $summary[] = $this
        ->t('Separator: %separator', [
        '%separator' => $separator,
      ]);
    }
    if ($join = $this
      ->getSetting('join')) {
      $summary[] = $this
        ->t('Join: %join', [
        '%join' => $join,
      ]);
    }
    if ($time_format = $this
      ->getSetting('time_format')) {
      $summary[] = $this
        ->t('Time Format: %time_format', [
        '%time_format' => $time_format,
      ]);
    }
    if ($date_format = $this
      ->getSetting('date_format')) {
      $summary[] = $this
        ->t('Date Format: %date_format', [
        '%date_format' => $date_format,
      ]);
    }
    return $summary;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
SmartDateCustomFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides TimestampFormatter::defaultSettings
SmartDateCustomFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides TimestampFormatter::settingsForm
SmartDateCustomFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides TimestampFormatter::settingsSummary
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.
SmartDateTrait::viewElements	public	function		4
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.
TimestampFormatter::$dateFormatStorage	protected	property	The date format entity storage.
TimestampFormatter::$dateFormatter	protected	property	The date formatter service.
TimestampFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
TimestampFormatter::__construct	public	function	Constructs a new TimestampFormatter. Overrides FormatterBase::__construct