You are here

Home » API reference » Time Field For Drupal 8.x / 9.x 2.x » TimeRangeFormatter.php

class TimeRangeFormatter in Time Field For Drupal 8.x / 9.x 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/TimeRangeFormatter.php \Drupal\time_field\Plugin\Field\FieldFormatter\TimeRangeFormatter

Plugin implementation of the 'time_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "time_range_formatter",
  label = @Translation("Time range formatter"),
  field_types = {
    "time_range"
  }
)

Hierarchy

Expanded class hierarchy of TimeRangeFormatter

File

src/Plugin/Field/FieldFormatter/TimeRangeFormatter.php, line 22

Namespace

Drupal\time_field\Plugin\Field\FieldFormatter
View source 
class TimeRangeFormatter extends FormatterBase {

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return string
   *   The textual output generated.
   */
  protected function viewValue(FieldItemInterface $item) {

    // The text value has no text format assigned to it, so the user input
    // should equal the output, including newlines.
    $from = Time::createFromTimestamp($item->from);
    $to = Time::createFromTimestamp($item->to);
    $time_format = $this
      ->getSetting('time_format');
    $timerange_format = $this
      ->getSetting('timerange_format');
    $timerange_format = str_replace('start', $from
      ->format($time_format), $timerange_format);
    $timerange_format = str_replace('end', $to
      ->format($time_format), $timerange_format);
    return $timerange_format;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#markup' => $this
          ->viewValue($item),
      ];
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['timerange_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Time Range Format'),
      '#default_value' => (string) $this
        ->getSetting('timerange_format'),
      '#description' => $this
        ->t('This setting must have `start` and `end` keys'),
    ];
    $elements['time_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Time Format'),
      '#default_value' => $this
        ->getSetting('time_format'),
      '#description' => $this
        ->getTimeDescription(),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'time_format' => 'h:i a',
      'timerange_format' => 'start ~ end',
    ] + parent::defaultSettings();
  }

  /**
   * Description of the time field.
   *
   * @return string
   *   Description of the time field.
   */
  private function getTimeDescription() {
    $output = '';
    $output .= $this
      ->t('a - Lowercase am or pm') . '<br/>';
    $output .= $this
      ->t('A - Uppercase AM or PM') . '<br/>';
    $output .= $this
      ->t('B - Swatch Internet time (000 to 999)') . '<br/>';
    $output .= $this
      ->t('g - 12-hour format of an hour (1 to 12)') . '<br/>';
    $output .= $this
      ->t('G - 24-hour format of an hour (0 to 23)') . '<br/>';
    $output .= $this
      ->t('h - 12-hour format of an hour (01 to 12)') . '<br/>';
    $output .= $this
      ->t('H - 24-hour format of an hour (00 to 23)') . '<br/>';
    $output .= $this
      ->t('i - Minutes with leading zeros (00 to 59)') . '<br/>';
    $output .= $this
      ->t('s - Seconds, with leading zeros (00 to 59)') . '<br/>';
    return $output;
  }

}

Members

Namesort descending 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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 12
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::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 12
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
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.
TimeRangeFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TimeRangeFormatter::getTimeDescription private function Description of the time field.
TimeRangeFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TimeRangeFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
TimeRangeFormatter::viewValue protected function Generate the output appropriate for one field item.