class PriceCalculatedFormatter in Commerce Core 8.2
Same name in this branch
- 8.2 modules/price/src/Plugin/Field/FieldFormatter/PriceCalculatedFormatter.php \Drupal\commerce_price\Plugin\Field\FieldFormatter\PriceCalculatedFormatter
- 8.2 modules/order/src/Plugin/Field/FieldFormatter/PriceCalculatedFormatter.php \Drupal\commerce_order\Plugin\Field\FieldFormatter\PriceCalculatedFormatter
Alternative implementation of the 'commerce_price_calculated' formatter.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\commerce_price\Plugin\Field\FieldFormatter\PriceDefaultFormatter implements ContainerFactoryPluginInterface
- class \Drupal\commerce_order\Plugin\Field\FieldFormatter\PriceCalculatedFormatter implements ContainerFactoryPluginInterface
- class \Drupal\commerce_price\Plugin\Field\FieldFormatter\PriceDefaultFormatter implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of PriceCalculatedFormatter
See also
\Drupal\commerce_price\Plugin\Field\FieldFormatter\PriceCalculatedFormatter
1 file declares its use of PriceCalculatedFormatter
- commerce_order.module in modules/
order/ commerce_order.module - Defines the Order entity and associated features.
File
- modules/
order/ src/ Plugin/ Field/ FieldFormatter/ PriceCalculatedFormatter.php, line 26
Namespace
Drupal\commerce_order\Plugin\Field\FieldFormatterView source
class PriceCalculatedFormatter extends PriceDefaultFormatter implements ContainerFactoryPluginInterface {
/**
* The adjustment type manager.
*
* @var \Drupal\commerce_order\AdjustmentTypeManager
*/
protected $adjustmentTypeManager;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* The current store.
*
* @var \Drupal\commerce_store\CurrentStoreInterface
*/
protected $currentStore;
/**
* The price calculator.
*
* @var \Drupal\commerce_order\PriceCalculatorInterface
*/
protected $priceCalculator;
/**
* Constructs a new PriceCalculatedFormatter 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 \CommerceGuys\Intl\Formatter\CurrencyFormatterInterface $currency_formatter
* The currency formatter.
* @param \Drupal\commerce_order\AdjustmentTypeManager $adjustment_type_manager
* The adjustment type manager.
* @param \Drupal\commerce_store\CurrentStoreInterface $current_store
* The current store.
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
* @param \Drupal\commerce_order\PriceCalculatorInterface $price_calculator
* The price calculator.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, CurrencyFormatterInterface $currency_formatter, AdjustmentTypeManager $adjustment_type_manager, CurrentStoreInterface $current_store, AccountInterface $current_user, PriceCalculatorInterface $price_calculator) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $currency_formatter);
$this->adjustmentTypeManager = $adjustment_type_manager;
$this->currentStore = $current_store;
$this->currentUser = $current_user;
$this->priceCalculator = $price_calculator;
}
/**
* {@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('commerce_price.currency_formatter'), $container
->get('plugin.manager.commerce_adjustment_type'), $container
->get('commerce_store.current_store'), $container
->get('current_user'), $container
->get('commerce_order.price_calculator'));
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'adjustment_types' => [],
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$elements = parent::settingsForm($form, $form_state);
$elements['adjustment_types'] = [
'#type' => 'checkboxes',
'#title' => $this
->t('Adjustments'),
'#options' => [],
'#default_value' => $this
->getSetting('adjustment_types'),
];
foreach ($this->adjustmentTypeManager
->getDefinitions() as $plugin_id => $definition) {
if (!in_array($plugin_id, [
'custom',
])) {
$label = $this
->t('Apply @label to the calculated price', [
'@label' => $definition['plural_label'],
]);
$elements['adjustment_types']['#options'][$plugin_id] = $label;
}
}
return $elements;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
$enabled_adjustment_types = array_filter($this
->getSetting('adjustment_types'));
foreach ($this->adjustmentTypeManager
->getDefinitions() as $plugin_id => $definition) {
if (in_array($plugin_id, $enabled_adjustment_types)) {
$summary[] = $this
->t('Apply @label to the calculated price', [
'@label' => $definition['plural_label'],
]);
}
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
if (!$items
->isEmpty()) {
$context = new Context($this->currentUser, $this->currentStore
->getStore(), NULL, [
'field_name' => $items
->getName(),
]);
/** @var \Drupal\commerce\PurchasableEntityInterface $purchasable_entity */
$purchasable_entity = $items
->getEntity();
$adjustment_types = array_filter($this
->getSetting('adjustment_types'));
$result = $this->priceCalculator
->calculate($purchasable_entity, 1, $context, $adjustment_types);
$calculated_price = $result
->getCalculatedPrice();
$options = $this
->getFormattingOptions();
$elements[0] = [
'#theme' => 'commerce_price_calculated',
'#result' => $result,
'#calculated_price' => $this->currencyFormatter
->format($calculated_price
->getNumber(), $calculated_price
->getCurrencyCode(), $options),
'#base_price' => $this->currencyFormatter
->format($result
->getBasePrice()
->getNumber(), $calculated_price
->getCurrencyCode(), $options),
'#adjustments' => $result
->getAdjustments(),
'#purchasable_entity' => $purchasable_entity,
'#cache' => [
'tags' => $purchasable_entity
->getCacheTags(),
'contexts' => Cache::mergeContexts($purchasable_entity
->getCacheContexts(), [
'languages:' . LanguageInterface::TYPE_INTERFACE,
'country',
]),
],
];
}
return $elements;
}
/**
* {@inheritdoc}
*/
public static function isApplicable(FieldDefinitionInterface $field_definition) {
$entity_type = \Drupal::entityTypeManager()
->getDefinition($field_definition
->getTargetEntityTypeId());
return $entity_type
->entityClassImplements(PurchasableEntityInterface::class);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PriceCalculatedFormatter:: |
protected | property | The adjustment type manager. | |
PriceCalculatedFormatter:: |
protected | property | The current store. | |
PriceCalculatedFormatter:: |
protected | property | The current user. | |
PriceCalculatedFormatter:: |
protected | property | The price calculator. | |
PriceCalculatedFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides PriceDefaultFormatter:: |
|
PriceCalculatedFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides PriceDefaultFormatter:: |
|
PriceCalculatedFormatter:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterBase:: |
|
PriceCalculatedFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides PriceDefaultFormatter:: |
|
PriceCalculatedFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides PriceDefaultFormatter:: |
|
PriceCalculatedFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides PriceDefaultFormatter:: |
|
PriceCalculatedFormatter:: |
public | function |
Constructs a new PriceCalculatedFormatter object. Overrides PriceDefaultFormatter:: |
|
PriceDefaultFormatter:: |
protected | property | The currency formatter. | |
PriceDefaultFormatter:: |
protected | function | Gets the formatting options for the currency formatter. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |