You are here

Home » API reference » Price Difference Formatter 8 » PriceDifferenceFormatter.php

class PriceDifferenceFormatter in Price Difference Formatter 8

Plugin implementation of the 'price_difference_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "price_difference_formatter",
  label = @Translation("Price Difference Formatter"),
  field_types = {
    "commerce_price"
  }
)

Hierarchy

Expanded class hierarchy of PriceDifferenceFormatter

File

src/Plugin/Field/FieldFormatter/PriceDifferenceFormatter.php, line 27

Namespace

Drupal\price_difference_formatter\Plugin\Field\FieldFormatter
View source 
class PriceDifferenceFormatter extends PriceCalculatedFormatter implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    if (!$items
      ->isEmpty()) {
      $context = new Context($this->currentUser, $this->currentStore
        ->getStore(), NULL, []);

      /** @var \Drupal\commerce\PurchasableEntityInterface $purchasable_entity */
      $purchasable_entity = $items
        ->getEntity();
      $quantity = 1;
      if ($purchasable_entity instanceof OrderItemInterface) {
        if ($items
          ->getName() === 'total_price') {
          $quantity = $purchasable_entity
            ->getQuantity();
        }
        $purchasable_entity = $purchasable_entity
          ->getPurchasedEntity();
      }
      $adjustment_types = array_filter($this
        ->getSetting('adjustment_types'));

      // Get the adjusted price.
      $result = $this->priceCalculator
        ->calculate($purchasable_entity, $quantity, $context, $adjustment_types);
      $calculated_price = $result
        ->getCalculatedPrice();
      $number = $calculated_price
        ->getNumber();
      $currency_code = $calculated_price
        ->getCurrencyCode();
      $options = $this
        ->getFormattingOptions();

      // Get the price without the promotion adjustment, but still include
      // any other adjustments that were selected.
      unset($adjustment_types['promotion']);
      $result_without_promotion = $this->priceCalculator
        ->calculate($purchasable_entity, $quantity, $context, $adjustment_types);
      $calculated_price_without_promotion = $result_without_promotion
        ->getCalculatedPrice();
      $number_without_promotion = $calculated_price_without_promotion
        ->getNumber();
      if ($number_without_promotion != $number) {
        $difference = $number_without_promotion - $number;
        $percentage = $difference / $number_without_promotion;
      }

      // Get the display settings for the formatter.
      $display_elements = array_filter($this
        ->getSetting('display_elements'));
      $elements[0] = [
        '#theme' => 'price_difference_formatter',
        '#final_price' => $this->currencyFormatter
          ->format($number, $currency_code, $options),
        '#original_price' => $this->currencyFormatter
          ->format($number_without_promotion, $currency_code, $options),
        '#discount_percentage' => isset($percentage) && isset($display_elements['discount_percentage']) ? round($percentage * 100, 2) . '%' : NULL,
        '#discount_currency' => isset($difference) && isset($display_elements['discount_currency']) ? $this->currencyFormatter
          ->format($difference, $currency_code, $options) : NULL,
        '#adjustments' => $result
          ->getAdjustments(),
        '#cache' => [
          'tags' => $purchasable_entity
            ->getCacheTags(),
          'contexts' => Cache::mergeContexts($purchasable_entity
            ->getCacheContexts(), [
            'languages:' . LanguageInterface::TYPE_INTERFACE,
            'country',
          ]),
        ],
      ];
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'display_elements' => [
        'discount_percentage' => 'discount_percentage',
      ],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['display_elements'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Display Elements'),
      '#options' => $this
        ->getDisplayOptions(),
      '#default_value' => $this
        ->getSetting('display_elements'),
    ];
    return $elements;
  }

  /**
   * Gets the options for the fields display elements.
   *
   * @return array
   *   An array of options.
   */
  public function getDisplayOptions() {
    return [
      'discount_percentage' => $this
        ->t('The discount percentage amount'),
      'discount_currency' => $this
        ->t('The discount currency amount'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $options = $this
      ->getDisplayOptions();
    foreach (array_filter($this
      ->getSetting('display_elements')) as $key) {
      $summary[] = $this
        ->t('Display @label', [
        '@label' => $options[$key],
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $entity_type = \Drupal::entityTypeManager()
      ->getDefinition($field_definition
      ->getTargetEntityTypeId());
    return $entity_type
      ->entityClassImplements(PurchasableEntityInterface::class) || $entity_type
      ->entityClassImplements(OrderItemInterface::class);
  }

}

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::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
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
PriceCalculatedFormatter::$adjustmentTypeManager protected property The adjustment type manager.
PriceCalculatedFormatter::$currentStore protected property The current store.
PriceCalculatedFormatter::$currentUser protected property The current user.
PriceCalculatedFormatter::$priceCalculator protected property The price calculator.
PriceCalculatedFormatter::create public static function Creates an instance of the plugin. Overrides PriceDefaultFormatter::create
PriceCalculatedFormatter::__construct public function Constructs a new PriceCalculatedFormatter object. Overrides PriceDefaultFormatter::__construct
PriceDefaultFormatter::$currencyFormatter protected property The currency formatter.
PriceDefaultFormatter::getFormattingOptions protected function Gets the formatting options for the currency formatter.
PriceDifferenceFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PriceCalculatedFormatter::defaultSettings
PriceDifferenceFormatter::getDisplayOptions public function Gets the options for the fields display elements.
PriceDifferenceFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides PriceCalculatedFormatter::isApplicable
PriceDifferenceFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides PriceCalculatedFormatter::settingsForm
PriceDifferenceFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides PriceCalculatedFormatter::settingsSummary
PriceDifferenceFormatter::viewElements public function Builds a renderable array for a field value. Overrides PriceCalculatedFormatter::viewElements
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.