You are here

Home » API reference » Time Formatter 2.0.x » TimeFieldFormatter.php

class TimeFieldFormatter in Time Formatter 2.0.x

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

Plugin implementation of the 'time_field_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "number_time",
  label = @Translation("Time"),
  field_types = {
    "integer",
    "decimal",
    "float"
  }
)

Hierarchy

Expanded class hierarchy of TimeFieldFormatter

File

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

Namespace

Drupal\time_formatter\Plugin\Field\FieldFormatter
View source 
class TimeFieldFormatter extends FormatterBase {

  /**
   * Denotes that the field value should be treated as number of seconds.
   */
  const STORAGE_SECONDS = 0;

  /**
   * Denotes that the field value should be treated as number of milliseconds.
   */
  const STORAGE_MILLISECONDS = 1;

  /**
   * Denotes that the field should be displayed as "123h 59m 59s 999ms".
   */
  const DISPLAY_HMSMS = 0;

  /**
   * Denotes that the field should be displayed as "123h 59m 59s".
   */
  const DISPLAY_HMS = 1;

  /**
   * Denotes that the field should be displayed as "123:59:59.999".
   */
  const DISPLAY_NUMBERSMS = 2;

  /**
   * Denotes that the field should be displayed as "123:59:59".
   */
  const DISPLAY_NUMBERS = 3;

  /**
   * Denotes that the Hours component should always be displayed.
   */
  const HOURS_ALWAYS = 0;

  /**
   * Denotes that the Hours component should be displayed only if hours > 0.
   */
  const HOURS_OPTIONAL = 1;

  /**
   * Denotes that the Hours component should never be displayed.
   */
  const HOURS_NEVER = 2;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'storage' => self::STORAGE_MILLISECONDS,
      'display' => self::DISPLAY_NUMBERSMS,
      'hours' => self::HOURS_ALWAYS,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return [
      'storage' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Storage'),
        '#options' => [
          self::STORAGE_SECONDS => $this
            ->t('Seconds'),
          self::STORAGE_MILLISECONDS => $this
            ->t('Milliseconds'),
        ],
        '#default_value' => $this
          ->getSetting('storage'),
      ],
      'display' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Display'),
        '#options' => [
          self::DISPLAY_HMSMS => $this
            ->t('123h 59m 59s 999ms'),
          self::DISPLAY_HMS => $this
            ->t('123h 59m 59s'),
          self::DISPLAY_NUMBERSMS => $this
            ->t('123:59:59.999'),
          self::DISPLAY_NUMBERS => $this
            ->t('123:59:59'),
        ],
        '#default_value' => $this
          ->getSetting('display'),
      ],
      'hours' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Display hours'),
        '#options' => [
          self::HOURS_ALWAYS => $this
            ->t('Always'),
          self::HOURS_OPTIONAL => $this
            ->t('Optional'),
          self::HOURS_NEVER => $this
            ->t('Never'),
        ],
        '#default_value' => $this
          ->getSetting('hours'),
      ],
    ] + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    switch ($this
      ->getSetting('storage')) {
      case self::STORAGE_SECONDS:
        $summary['storage'] = $this
          ->t('Storage: Seconds');
        break;
      case self::STORAGE_MILLISECONDS:
        $summary['storage'] = $this
          ->t('Storage: Milliseconds');
        break;
    }
    switch ($this
      ->getSetting('display')) {
      case self::DISPLAY_HMSMS:
        $summary['display'] = $this
          ->t('Display: 123h 59m 59s 999ms');
        break;
      case self::DISPLAY_HMS:
        $summary['display'] = $this
          ->t('Display: 123h 59m 59s');
        break;
      case self::DISPLAY_NUMBERSMS:
        $summary['display'] = $this
          ->t('Display: 123:59:59.999');
        break;
      case self::DISPLAY_NUMBERS:
        $summary['display'] = $this
          ->t('Display: 123:59:59');
        break;
    }
    switch ($this
      ->getSetting('hours')) {
      case self::HOURS_ALWAYS:
        $summary['hours'] = $this
          ->t('Display hours: Always');
        break;
      case self::HOURS_OPTIONAL:
        $summary['hours'] = $this
          ->t('Display hours: Optional');
        break;
      case self::HOURS_NEVER:
        $summary['hours'] = $this
          ->t('Display hours: Never');
        break;
    }
    return $summary;
  }

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

  /**
   * 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) {
    $value = $item->value;
    if ($this
      ->getSetting('storage') == self::STORAGE_SECONDS) {
      $value *= 1000;
    }
    $value = round($value);
    $milliseconds = $value % 1000;
    $value = ($value - $milliseconds) / 1000;
    $seconds = $value % 60;
    $value = ($value - $seconds) / 60;
    if ($this
      ->getSetting('hours') == self::HOURS_NEVER) {
      $minutes = $value;
      $value = 0;
    }
    else {
      $minutes = $value % 60;
      $value = ($value - $minutes) / 60;
    }
    $include_hours = $value || $this
      ->getSetting('hours') == self::HOURS_ALWAYS;
    $return = 'N/A';
    switch ($this
      ->getSetting('display')) {
      case self::DISPLAY_HMSMS:
        $return = $include_hours ? "{$value}h " : '';
        $return .= "{$minutes}m {$seconds}s {$milliseconds}ms";
        break;
      case self::DISPLAY_HMS:
        $return = $include_hours ? "{$value}h " : '';
        $return .= "{$minutes}m {$seconds}s";
        break;
      case self::DISPLAY_NUMBERSMS:
        $format = $include_hours ? "{$value}:%02s:%02s.%03s" : '%s:%02s.%03s';
        $return = sprintf($format, $minutes, $seconds, $milliseconds);
        break;
      case self::DISPLAY_NUMBERS:
        $format = $include_hours ? "{$value}:%02s:%02s" : '%s:%02s';
        $return = sprintf($format, $minutes, $seconds, $milliseconds);
        break;
    }
    return $return;
  }

}

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::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.
TimeFieldFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TimeFieldFormatter::DISPLAY_HMS constant Denotes that the field should be displayed as "123h 59m 59s".
TimeFieldFormatter::DISPLAY_HMSMS constant Denotes that the field should be displayed as "123h 59m 59s 999ms".
TimeFieldFormatter::DISPLAY_NUMBERS constant Denotes that the field should be displayed as "123:59:59".
TimeFieldFormatter::DISPLAY_NUMBERSMS constant Denotes that the field should be displayed as "123:59:59.999".
TimeFieldFormatter::HOURS_ALWAYS constant Denotes that the Hours component should always be displayed.
TimeFieldFormatter::HOURS_NEVER constant Denotes that the Hours component should never be displayed.
TimeFieldFormatter::HOURS_OPTIONAL constant Denotes that the Hours component should be displayed only if hours > 0.
TimeFieldFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TimeFieldFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TimeFieldFormatter::STORAGE_MILLISECONDS constant Denotes that the field value should be treated as number of milliseconds.
TimeFieldFormatter::STORAGE_SECONDS constant Denotes that the field value should be treated as number of seconds.
TimeFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
TimeFieldFormatter::viewValue protected function Generate the output appropriate for one field item.