You are here

Home » API reference » Range 8 » RangeFormatterBase.php

abstract class RangeFormatterBase in Range 8

Parent plugin for decimal and integer range formatters.

Hierarchy

Expanded class hierarchy of RangeFormatterBase

File

src/Plugin/Field/FieldFormatter/RangeFormatterBase.php, line 14

Namespace

Drupal\range\Plugin\Field\FieldFormatter
View source 
abstract class RangeFormatterBase extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'range_separator' => '-',
      'range_combine' => TRUE,
      'field_prefix_suffix' => FALSE,
      'from_prefix_suffix' => FALSE,
      'to_prefix_suffix' => FALSE,
      'combined_prefix_suffix' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['range_separator'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Range separator'),
      '#default_value' => $this
        ->getSetting('range_separator'),
      '#weight' => 0,
    ];
    $elements['range_combine'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Combine equivalent values'),
      '#description' => $this
        ->t('If the FROM and TO values are equal, combine the display into a single value.'),
      '#default_value' => $this
        ->getSetting('range_combine'),
      '#weight' => 50,
    ];
    $elements['field_prefix_suffix'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display <em>FIELD value</em> prefix and suffix'),
      '#default_value' => $this
        ->getSetting('field_prefix_suffix'),
      '#weight' => 55,
    ];
    $elements['from_prefix_suffix'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display <em>FROM value</em> prefix and suffix'),
      '#default_value' => $this
        ->getSetting('from_prefix_suffix'),
      '#weight' => 60,
    ];
    $elements['to_prefix_suffix'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display <em>TO value</em> prefix and suffix'),
      '#default_value' => $this
        ->getSetting('to_prefix_suffix'),
      '#weight' => 65,
    ];
    $elements['combined_prefix_suffix'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display <em>COMBINED value</em> prefix and suffix'),
      '#default_value' => $this
        ->getSetting('combined_prefix_suffix'),
      '#weight' => 70,
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][range_combine]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $from_value = $this
      ->formatNumber(1234.123456789);
    $to_value = $this
      ->formatNumber(4321.0987654321);
    $summary[] = [
      '#theme' => 'range_formatter_range_separate',
      '#from' => $from_value,
      '#range_separator' => $this
        ->getSetting('range_separator'),
      '#to' => $to_value,
    ];
    if ($this
      ->getSetting('range_combine')) {
      $summary[] = $this
        ->t('Equivalent values will be combined into a single value.');
    }
    if ($this
      ->getSetting('field_prefix_suffix')) {
      $summary[] = $this
        ->t('Display with <em>FIELD value</em> prefix and suffix.');
    }
    if ($this
      ->getSetting('from_prefix_suffix')) {
      $summary[] = $this
        ->t('Display with <em>FROM value</em> prefix and suffix.');
    }
    if ($this
      ->getSetting('to_prefix_suffix')) {
      $summary[] = $this
        ->t('Display with <em>TO value</em> prefix and suffix.');
    }
    if ($this
      ->getSetting('range_combine') && $this
      ->getSetting('combined_prefix_suffix')) {
      $summary[] = $this
        ->t('Display with <em>COMBINED value</em> prefix and suffix.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $from_value = $this
        ->formatNumber($item->from);
      $to_value = $this
        ->formatNumber($item->to);

      // Combine values if they are equal.
      if ($this
        ->getSetting('range_combine') && $from_value === $to_value) {
        $output = $this
          ->viewElementCombined($item, $from_value);
      }
      else {
        $output = $this
          ->viewElementSeparate($item, $from_value, $to_value);
      }
      if ($this
        ->getSetting('field_prefix_suffix')) {
        $output['#field_prefix'] = FieldFilteredMarkup::create($this
          ->getFieldSetting('field')['prefix']);
        $output['#field_suffix'] = FieldFilteredMarkup::create($this
          ->getFieldSetting('field')['suffix']);
      }
      $elements[$delta] = $output;
    }
    return $elements;
  }

  /**
   * Helper method. Returns the combined value renderable array.
   *
   * FROM and TO might have different prefixes/suffixes.
   * Code below decides which one to use, based on the following:
   *   1. If COMBINED is disabled and both FROM/TO are disabled - show naked
   *      value.
   *   2. If COMBINED is enabled - show it.
   *   3. If COMBINED is disabled and either FROM or TO are enabled - show
   *      prefix/suffix of the enabled one.
   *   4. If COMBINED is disabled and both FROM/TO are enabled, show prefix
   *      from FROM and suffix from TO.
   *
   * @param \Drupal\range\RangeItemInterface $item
   *   Range field item.
   * @param string $value
   *   Field combined value.
   *
   * @return array
   *   Field value renderable array.
   */
  protected function viewElementCombined(RangeItemInterface $item, $value) {
    $from_prefix_suffix = !empty($this
      ->getSetting('from_prefix_suffix'));
    $to_prefix_suffix = !empty($this
      ->getSetting('to_prefix_suffix'));
    $combined_prefix_suffix = !empty($this
      ->getSetting('combined_prefix_suffix'));

    // Option #1: COMBINED is disabled and both FROM/TO are disabled.
    $output = [
      '#theme' => 'range_formatter_range_combined',
      '#item' => $item,
      '#value' => $value,
    ];

    // Option #2: COMBINED is enabled.
    if ($combined_prefix_suffix) {
      $output['#value_prefix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('combined')['prefix']);
      $output['#value_suffix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('combined')['suffix']);
    }
    elseif ($from_prefix_suffix && !$to_prefix_suffix) {
      $output['#value_prefix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('from')['prefix']);
      $output['#value_suffix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('from')['suffix']);
    }
    elseif (!$from_prefix_suffix && $to_prefix_suffix) {
      $output['#value_prefix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('to')['prefix']);
      $output['#value_suffix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('to')['suffix']);
    }
    elseif ($from_prefix_suffix && $to_prefix_suffix) {
      $output['#value_prefix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('from')['prefix']);
      $output['#value_suffix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('to')['suffix']);
    }
    return $output;
  }

  /**
   * Helper method. Returns the separate values renderable array.
   *
   * @param \Drupal\range\RangeItemInterface $item
   *   Range field item.
   * @param string $from_value
   *   Field FROM value.
   * @param string $to_value
   *   Field TO value.
   *
   * @return array
   *   Field value renderable array.
   */
  protected function viewElementSeparate(RangeItemInterface $item, $from_value, $to_value) {
    $output = [
      '#theme' => 'range_formatter_range_separate',
      '#item' => $item,
      '#from' => $from_value,
      '#range_separator' => $this
        ->getSetting('range_separator'),
      '#to' => $to_value,
    ];
    if ($this
      ->getSetting('from_prefix_suffix')) {
      $output['#from_prefix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('from')['prefix']);
      $output['#from_suffix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('from')['suffix']);
    }
    if ($this
      ->getSetting('to_prefix_suffix')) {
      $output['#to_prefix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('to')['prefix']);
      $output['#to_suffix'] = FieldFilteredMarkup::create($this
        ->getFieldSetting('to')['suffix']);
    }
    return $output;
  }

  /**
   * Formats a number.
   *
   * @param mixed $number
   *   The numeric value.
   *
   * @return string
   *   The formatted number.
   */
  protected abstract function formatNumber($number);

}

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
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 11
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 11
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
RangeFormatterBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 2
RangeFormatterBase::formatNumber abstract protected function Formats a number. 3
RangeFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 2
RangeFormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
RangeFormatterBase::viewElementCombined protected function Helper method. Returns the combined value renderable array.
RangeFormatterBase::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
RangeFormatterBase::viewElementSeparate protected function Helper method. Returns the separate values renderable array.
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.