You are here

Home » API reference » Duration Field 8 » DurationHumanDisplayFormatter.php

class DurationHumanDisplayFormatter in Duration Field 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/DurationHumanDisplayFormatter.php \Drupal\duration_field\Plugin\Field\FieldFormatter\DurationHumanDisplayFormatter
  2. 3.0.x src/Plugin/Field/FieldFormatter/DurationHumanDisplayFormatter.php \Drupal\duration_field\Plugin\Field\FieldFormatter\DurationHumanDisplayFormatter

Provides a formatter for the duration field type.

Plugin annotation


@FieldFormatter(
  id = "duration_human_display",
  label = @Translation("Human Friendly"),
  field_types = {
    "duration"
  }
)

Hierarchy

Expanded class hierarchy of DurationHumanDisplayFormatter

File

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

Namespace

Drupal\duration_field\Plugin\Field\FieldFormatter
View source 
class DurationHumanDisplayFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a DurationHumanDisplayFormatter object.
   *
   * @param string $plugin_id
   *   The ID of the plugin.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param mixed $field_config
   *   The field definition.
   * @param array $settings
   *   The field settings.
   * @param mixed $label
   *   The label of the field.
   * @param string $view_mode
   *   The current view mode.
   * @param array $third_party_settings
   *   The third party settings.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler service.
   */
  public function __construct($plugin_id, $plugin_definition, $field_config, array $settings, $label, $view_mode, array $third_party_settings, ModuleHandlerInterface $moduleHandler) {
    parent::__construct($plugin_id, $plugin_definition, $field_config, $settings, $label, $view_mode, $third_party_settings);
    $this->moduleHandler = $moduleHandler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();
    $summary[] = $this
      ->t('Displays the duration in a human-friendly format. Words are shown in @text_length form, and separated by @separator', [
      '@text_length' => $this
        ->getHumanFriendlyLabel($settings['text_length'], FALSE),
      '@separator' => $this
        ->getHumanFriendlyLabel($settings['separator'], FALSE),
    ]);
    return $summary;
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['text_length'] = [
      '#title' => t('Text length'),
      '#type' => 'select',
      '#options' => [
        'full' => $this
          ->getHumanFriendlyLabel('full'),
        'short' => $this
          ->getHumanFriendlyLabel('short'),
      ],
      '#default_value' => $this
        ->getSetting('text_length'),
    ];
    $custom_separators = $this->moduleHandler
      ->invokeAll('duration_field_separators');
    $custom_separator_mappings = [];
    foreach (array_keys($custom_separators) as $custom_separator) {
      $custom_separator_mappings[$custom_separator] = $this
        ->getHumanFriendlyLabel($custom_separator);
    }
    $element['separator'] = [
      '#title' => $this
        ->t('Separator'),
      '#type' => 'select',
      '#options' => [
        'space' => $this
          ->getHumanFriendlyLabel('space'),
        'hyphen' => $this
          ->getHumanFriendlyLabel('hyphen'),
        'comma' => $this
          ->getHumanFriendlyLabel('comma'),
        'newline' => $this
          ->getHumanFriendlyLabel('newline'),
      ] + $custom_separator_mappings,
      '#default_value' => $this
        ->getSetting('separator'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    $granularity = $this
      ->getFieldSetting('granularity');
    foreach ($items as $delta => $item) {
      $duration = new \DateInterval($item->value);
      $output = [];
      if ($granularity['year'] && ($years = $duration
        ->format('%y'))) {
        $output[] = $this
          ->getTimePeriod('year', $years);
      }
      if ($granularity['month'] && ($months = $duration
        ->format('%m'))) {
        $output[] = $this
          ->getTimePeriod('month', $months);
      }
      if ($granularity['day'] && ($days = $duration
        ->format('%d'))) {
        $output[] = $this
          ->getTimePeriod('day', $days);
      }
      if ($granularity['hour'] && ($hours = $duration
        ->format('%h'))) {
        $output[] = $this
          ->getTimePeriod('hour', $hours);
      }
      if ($granularity['minute'] && ($minutes = $duration
        ->format('%i'))) {
        $output[] = $this
          ->getTimePeriod('minute', $minutes);
      }
      if ($granularity['second'] && ($seconds = $duration
        ->format('%s'))) {
        $output[] = $this
          ->getTimePeriod('second', $seconds);
      }
      $value = count($output) ? implode($this
        ->getSeparator(), $output) : '0';

      // Render each element as markup.
      $element[$delta] = [
        '#markup' => $value,
      ];
    }
    return $element;
  }

  /**
   * Converts a key to a human readable value.
   *
   * @param string $key
   *   The machine readable name to be converted.
   * @param bool $capitalize
   *   Whether or not the return value should be capitalized.
   *
   * @return string
   *   The converted value, if a mapping exists, otherwise the original key
   */
  protected function getHumanFriendlyLabel($key, $capitalize = TRUE) {
    $custom_labels = $this->moduleHandler
      ->invokeAll('duration_field_labels');
    if (!isset($custom_labels['capitalized'])) {
      $custom_labels['capitalized'] = [];
    }
    if (!isset($custom_labels['lowercase'])) {
      $custom_labels['lowercase'] = [];
    }
    if ($capitalize) {
      $values = [
        'full' => t('Full'),
        'short' => t('Short'),
        'space' => t('Spaces'),
        'hyphen' => t('Hyphens'),
        'comma' => t('Commas'),
        'newline' => t('New lines'),
      ] + $custom_labels['capitalized'];
    }
    else {
      $values = [
        'full' => t('full'),
        'short' => t('short'),
        'space' => t('spaces'),
        'hyphen' => t('hyphens'),
        'comma' => t('commas'),
        'newline' => t('new lines'),
      ] + $custom_labels['lowercase'];
    }
    return isset($values[$key]) ? $values[$key] : $key;
  }

  /**
   * Converts the key for a separator between values.
   *
   * @return string
   *   The value to be inserted between returned elements
   */
  protected function getSeparator() {
    $custom_separators = $this->moduleHandler
      ->invokeAll('duration_field_separators');
    $separators = [
      'space' => ' ',
      'hyphen' => ' - ',
      'comma' => ', ',
      'newline' => '<br />',
    ] + $custom_separators;
    return $separators[$this
      ->getSetting('separator')];
  }

  /**
   * Returns a human-friendly value for a given time period key.
   *
   * @param string $type
   *   The type of the humann readable value to retrieve.
   * @param int $value
   *   The amount for that time period.
   *
   * @return string
   *   The translateable human-friendly count of the given type
   */
  protected function getTimePeriod($type, $value) {
    $text_length = $this
      ->getSetting('text_length');
    if ($type == 'year') {
      if ($text_length == 'full') {
        return $this
          ->formatPlural($value, '1 year', '@count years');
      }
      else {
        return $this
          ->formatPlural($value, '1 yr', '@count yr');
      }
    }
    elseif ($type == 'month') {
      if ($text_length == 'full') {
        return $this
          ->formatPlural($value, '1 months', '@count months');
      }
      else {
        return $this
          ->formatPlural($value, '1 mo', '@count mo');
      }
    }
    elseif ($type == 'day') {
      return $this
        ->formatPlural($value, '1 day', '@count days');
    }
    elseif ($type == 'hour') {
      if ($text_length == 'full') {
        return $this
          ->formatPlural($value, '1 hour', '@count hours');
      }
      else {
        return $this
          ->formatPlural($value, '1 hr', '@count hr');
      }
    }
    elseif ($type == 'minute') {
      if ($text_length == 'full') {
        return $this
          ->formatPlural($value, '1 minute', '@count minutes');
      }
      else {
        return $this
          ->formatPlural($value, '1 min', '@count min');
      }
    }
    elseif ($type == 'second') {
      if ($text_length == 'full') {
        return $this
          ->formatPlural($value, '1 second', '@count seconds');
      }
      else {
        return $this
          ->formatPlural($value, '1 s', '@count s');
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DurationHumanDisplayFormatter::$moduleHandler protected property The module handler service.
DurationHumanDisplayFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
DurationHumanDisplayFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
DurationHumanDisplayFormatter::getHumanFriendlyLabel protected function Converts a key to a human readable value.
DurationHumanDisplayFormatter::getSeparator protected function Converts the key for a separator between values.
DurationHumanDisplayFormatter::getTimePeriod protected function Returns a human-friendly value for a given time period key.
DurationHumanDisplayFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
DurationHumanDisplayFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
DurationHumanDisplayFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
DurationHumanDisplayFormatter::__construct public function Constructs a DurationHumanDisplayFormatter object. Overrides FormatterBase::__construct
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 1
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.