PriceModifiedDefaultFormatter.php in Price 3.0.x

Namespace

Drupal\price\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/PriceModifiedDefaultFormatter.php

<?php

namespace Drupal\price\Plugin\Field\FieldFormatter;

use Drupal\price\NumberFormatterFactoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FormatterBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use CommerceGuys\Intl\Formatter\NumberFormatterInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Plugin implementation of the 'price_modified' formatter.
 *
 * @FieldFormatter(
 *   id = "price_modified_default",
 *   label = @Translation("Default"),
 *   field_types = {
 *     "price_modified"
 *   }
 * )
 */
class PriceModifiedDefaultFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The currency storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $currencyStorage;

  /**
   * The modifier storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $modifierStorage;

  /**
   * The number formatter.
   *
   * @var \CommerceGuys\Intl\Formatter\NumberFormatterInterface
   */
  protected $numberFormatter;

  /**
   * Constructs a new PriceDefaultFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\price\NumberFormatterFactoryInterface $number_formatter_factory
   *   The number formatter factory.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager, NumberFormatterFactoryInterface $number_formatter_factory) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->currencyStorage = $entity_type_manager
      ->getStorage('price_currency');
    $this->modifierStorage = $entity_type_manager
      ->getStorage('price_modifier');
    $this->numberFormatter = $number_formatter_factory
      ->createInstance();
    $this->numberFormatter
      ->setMaximumFractionDigits(6);
    if ($this
      ->getSetting('strip_trailing_zeroes')) {
      $this->numberFormatter
        ->setMinimumFractionDigits(0);
    }
    if ($this
      ->getSetting('display_currency_code')) {
      $this->numberFormatter
        ->setCurrencyDisplay(NumberFormatterInterface::CURRENCY_DISPLAY_CODE);
    }
  }

  /**
   * {@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('entity_type.manager'), $container
      ->get('price.number_formatter_factory'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'strip_trailing_zeroes' => FALSE,
      'display_currency_code' => FALSE,
      'display_modifier' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = [];
    $elements['strip_trailing_zeroes'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Strip trailing zeroes after the decimal point.'),
      '#default_value' => $this
        ->getSetting('strip_trailing_zeroes'),
    ];
    $elements['display_currency_code'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display the currency code instead of the currency symbol.'),
      '#default_value' => $this
        ->getSetting('display_currency_code'),
    ];
    $elements['display_modifier'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display the modifier.'),
      '#default_value' => $this
        ->getSetting('display_modifier'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('strip_trailing_zeroes')) {
      $summary[] = $this
        ->t('Strip trailing zeroes after the decimal point.');
    }
    else {
      $summary[] = $this
        ->t('Do not strip trailing zeroes after the decimal point.');
    }
    if ($this
      ->getSetting('display_currency_code')) {
      $summary[] = $this
        ->t('Display the currency code instead of the currency symbol.');
    }
    else {
      $summary[] = $this
        ->t('Display the currency symbol.');
    }
    if ($this
      ->getSetting('display_modifier')) {
      $summary[] = $this
        ->t('Display the modifier.');
    }
    else {
      $summary[] = $this
        ->t('Do not display the modifier.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $currency_codes = [];
    $modifier_codes = [];
    foreach ($items as $delta => $item) {
      $currency_codes[] = $item->currency_code;
      $modifier_codes[] = $item->modifier;
    }
    $currencies = $currency_codes ? $this->currencyStorage
      ->loadMultiple($currency_codes) : [];
    $modifiers = $modifier_codes ? $this->modifierStorage
      ->loadMultiple($modifier_codes) : [];
    $elements = [];
    foreach ($items as $delta => $item) {
      $currency = $currencies[$item->currency_code];
      $modifier = $modifiers[$item->modifier];
      $elements[$delta] = [
        '#markup' => ($modifier
          ->id() != 'empty' ? $modifier
          ->label() : '') . ' ' . $this->numberFormatter
          ->formatCurrency($item->number, $currency),
        '#cache' => [
          'contexts' => [
            'languages:' . LanguageInterface::TYPE_INTERFACE,
            'price_country',
          ],
        ],
      ];
    }
    return $elements;
  }

}

Classes

Name	Description
PriceModifiedDefaultFormatter	Plugin implementation of the 'price_modified' formatter.