You are here

Home » API reference » Timefield 1.0.x » TimeFieldDuration.php

class TimeFieldDuration in Timefield 1.0.x

Plugin for the 'timefield_duration_formatter' field formatter.

Plugin annotation


@FieldFormatter(
 id = "timefield_duration_formatter",
 label = @Translation("Duration"),
 field_types = {"timefield"}
)

Hierarchy

Expanded class hierarchy of TimeFieldDuration

File

src/Plugin/Field/FieldFormatter/TimeFieldDuration.php, line 19

Namespace

Drupal\timefield\Plugin\Field\FieldFormatter
View source 
class TimeFieldDuration extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'duration_format' => 'minutes',
      'display_format' => [
        'hour' => 'g',
        'minute' => 'i',
        'separator' => ':',
        'period' => 'a',
        'periodSeparator' => '',
      ],
    ] + parent::defaultSettings();
  }

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

    // @todo Change the autogenerated stub
    $element = parent::settingsForm($form, $form_state);
    $settings = $this
      ->getSettings();
    $element['duration_format'] = [
      '#title' => $this
        ->t('Time Duration Format'),
      '#type' => 'select',
      '#options' => _timefield_duration_options(),
      '#default_value' => $settings['duration_format'],
      '#required' => TRUE,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {

    // @todo Change the autogenerated stub
    $summary = parent::settingsSummary();
    $settings = $this
      ->getSettings();
    $field_settings = $this
      ->getFieldSettings();
    if (empty($field_settings['totime'])) {
      $summary[] = $this
        ->t('This display format is invalid for the current field configuration');
    }
    else {
      $summary[] = $this
        ->t('Current Format: @format', [
        '@format' => _timefield_duration_options($settings['duration_format']),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $settings = $this
      ->getSettings();
    $field_settings = $this
      ->getFieldSettings();
    $label_hidden = $this->label == 'hidden';
    foreach ($items as $delta => $item) {
      $item = $items
        ->get($delta);
      if (!empty($item->value)) {
        $value = $item
          ->getValue('value');
        $value['value'] = trim(timefield_integer_to_time($settings['display_format'], $item->value));
        if (isset($item->value2)) {
          $value['value2'] = $item->value2;
          $value['formatted_value2'] = trim(timefield_integer_to_time($settings['display_format'], $item->value2));
          $value['duration'] = timefield_time_to_duration($item->value, $item->value2, $settings['duration_format']);
          $value['time'] = timefield_time_to_duration($item->value, $item->value2, $settings['duration_format']);
        }
        else {
          $value['time'] = 0;
        }
        $item
          ->setValue($value);
        $items
          ->set($delta, $value);
      }
    }
    $element = [
      '#theme' => 'timefield_duration',
      '#label' => $this->fieldDefinition
        ->get('label'),
      '#label_display' => $this->label,
      '#label_hidden' => $label_hidden,
      '#items' => $items,
      '#settings' => $field_settings,
      '#format' => 'duration',
      '#attributes' => new Attribute([
        'class' => 'timefield',
      ]),
    ];
    return $element;
  }

}

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.
TimeFieldDuration::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TimeFieldDuration::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TimeFieldDuration::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TimeFieldDuration::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements