DurationHumanDisplayFormatter.php in Duration Field 8

Namespace

Drupal\duration_field\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/DurationHumanDisplayFormatter.php

<?php

namespace Drupal\duration_field\Plugin\Field\FieldFormatter;

use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FormatterBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a formatter for the duration field type.
 *
 * @FieldFormatter(
 *   id = "duration_human_display",
 *   label = @Translation("Human Friendly"),
 *   field_types = {
 *     "duration"
 *   }
 * )
 */
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');
      }
    }
  }

}

Classes

Name	Description
DurationHumanDisplayFormatter	Provides a formatter for the duration field type.