class OrderCurrency in Commerce Core 8.2

Provides the currency condition for orders.

Plugin annotation

@CommerceCondition(
  id = "order_currency",
  label = @Translation("Order currency"),
  category = @Translation("Order", context = "Commerce"),
  entity_type = "commerce_order",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\commerce\Plugin\Commerce\Condition\ConditionBase implements ConditionInterface
      • class \Drupal\commerce_order\Plugin\Commerce\Condition\OrderCurrency

1 file declares its use of OrderCurrency

OrderCurrencyTest.php in modules/order/tests/src/Unit/Plugin/Commerce/Condition/OrderCurrencyTest.php

File

modules/order/src/Plugin/Commerce/Condition/OrderCurrency.php, line 19

Namespace

Drupal\commerce_order\Plugin\Commerce\Condition

class OrderCurrency extends ConditionBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'currencies' => [],
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['currencies'] = [
      '#type' => 'commerce_entity_select',
      '#title' => $this
        ->t('Currencies'),
      '#default_value' => $this->configuration['currencies'],
      '#target_type' => 'commerce_currency',
      '#hide_single_entity' => FALSE,
      '#multiple' => TRUE,
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $values = $form_state
      ->getValue($form['#parents']);
    $this->configuration['currencies'] = $values['currencies'];
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate(EntityInterface $entity) {
    $this
      ->assertEntity($entity);

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = $entity;
    $total_price = $order
      ->getTotalPrice();
    $order_currency = $total_price ? $total_price
      ->getCurrencyCode() : '';
    return in_array($order_currency, $this->configuration['currencies']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConditionBase::assertEntity	protected	function	Asserts that the given entity is of the expected type.
ConditionBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionBase::getComparisonOperators	protected	function	Gets the comparison operators.
ConditionBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionBase::getDisplayLabel	public	function	Gets the condition display label. Overrides ConditionInterface::getDisplayLabel
ConditionBase::getEntityTypeId	public	function	Gets the condition entity type ID. Overrides ConditionInterface::getEntityTypeId
ConditionBase::getLabel	public	function	Gets the condition label. Overrides ConditionInterface::getLabel
ConditionBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConditionBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	8
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OrderCurrency::buildConfigurationForm	public	function	Form constructor. Overrides ConditionBase::buildConfigurationForm
OrderCurrency::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConditionBase::defaultConfiguration
OrderCurrency::evaluate	public	function	Evaluates the condition. Overrides ConditionInterface::evaluate
OrderCurrency::submitConfigurationForm	public	function	Form submission handler. Overrides ConditionBase::submitConfigurationForm
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.
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.