You are here

Home » API reference » Commerce Product Bundle 8 » BundlePriceCalculatedFormatter.php

class BundlePriceCalculatedFormatter in Commerce Product Bundle 8

Plugin implementation of the 'commerce_price_calculated' formatter.

Plugin annotation


@FieldFormatter(
  id = "commerce_product_bundle_calculated",
  label = @Translation("Calculated product bundle price"),
  field_types = {
    "commerce_price"
  }
)

Hierarchy

Expanded class hierarchy of BundlePriceCalculatedFormatter

File

src/Plugin/Field/FieldFormatter/BundlePriceCalculatedFormatter.php, line 23

Namespace

Drupal\commerce_product_bundle\Plugin\Field\FieldFormatter
View source 
class BundlePriceCalculatedFormatter extends PriceCalculatedFormatter {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];

    /** @var \Drupal\commerce\PurchasableEntityInterface $purchasable_entity */
    $purchasable_entity = $items
      ->getEntity();

    // We only handle product bundles. Let the commerce core calculated price
    // formatter handle other purchasable entities.
    if (!$purchasable_entity
      ->getEntityType()
      ->entityClassImplements(BundleInterface::class)) {
      return parent::viewElements($items, $langcode);
    }
    $context = new Context($this->currentUser, $this->currentStore
      ->getStore(), NULL, [
      'field_name' => $items
        ->getName(),
    ]);

    // We need to run the logic, even if we have no valid price from the bundle
    // entity itself. The bundle price resolver will calculate a price from the
    // product bundle items.
    for ($delta = $items
      ->isEmpty() ? 0 : 1; $delta <= count($items); $delta = $delta + 1) {
      $resolved_price = $this->chainPriceResolver
        ->resolve($purchasable_entity, 1, $context);
      if ($resolved_price) {
        $number = $resolved_price
          ->getNumber();
        $currency_code = $resolved_price
          ->getCurrencyCode();
        $options = $this
          ->getFormattingOptions();
        $elements[$delta] = [
          '#markup' => $this->currencyFormatter
            ->format($number, $currency_code, $options),
          '#cache' => [
            'tags' => $purchasable_entity
              ->getCacheTags(),
            'contexts' => Cache::mergeContexts($purchasable_entity
              ->getCacheContexts(), [
              'languages:' . LanguageInterface::TYPE_INTERFACE,
              'country',
            ]),
          ],
        ];
      }
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BundlePriceCalculatedFormatter::viewElements public function Builds a renderable array for a field value. Overrides PriceCalculatedFormatter::viewElements
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::$chainPriceResolver protected property The chain price resolver.
PriceCalculatedFormatter::$currentStore protected property The current store.
PriceCalculatedFormatter::$currentUser protected property The current user.
PriceCalculatedFormatter::create public static function Creates an instance of the plugin. Overrides PriceDefaultFormatter::create
PriceCalculatedFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
PriceCalculatedFormatter::__construct public function Constructs a new PriceCalculatedFormatter object. Overrides PriceDefaultFormatter::__construct
PriceDefaultFormatter::$currencyFormatter protected property The currency formatter.
PriceDefaultFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 1
PriceDefaultFormatter::getFormattingOptions protected function Gets the formatting options for the currency formatter.
PriceDefaultFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 1
PriceDefaultFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary 1
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.