abstract class OrderItemPromotionOfferBase in Commerce Core 8.2

Provides the base class for order item offers.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\PromotionOfferBase implements PromotionOfferInterface, ContainerFactoryPluginInterface
    class \Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\OrderItemPromotionOfferBase implements OrderItemPromotionOfferInterface

Expanded class hierarchy of OrderItemPromotionOfferBase

File

modules/promotion/src/Plugin/Commerce/PromotionOffer/OrderItemPromotionOfferBase.php, line 11

Namespace

Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer

View source

abstract class OrderItemPromotionOfferBase extends PromotionOfferBase implements OrderItemPromotionOfferInterface {

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['display_inclusive'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Discount display'),
      '#title_display' => 'invisible',
      '#options' => [
        TRUE => $this
          ->t('Include the discount in the displayed unit price'),
        FALSE => $this
          ->t('Only show the discount on the order total summary'),
      ],
      '#default_value' => (int) $this->configuration['display_inclusive'],
    ];
    $form['conditions'] = [
      '#type' => 'commerce_conditions',
      '#title' => $this
        ->t('Applies to'),
      '#parent_entity_type' => 'commerce_promotion',
      '#entity_types' => [
        'commerce_order_item',
      ],
      '#default_value' => $this->configuration['conditions'],
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getConditions() {
    $plugin_manager = \Drupal::service('plugin.manager.commerce_condition');
    $conditions = [];
    foreach ($this->configuration['conditions'] as $condition) {
      $conditions[] = $plugin_manager
        ->createInstance($condition['plugin'], $condition['configuration']);
    }
    return $conditions;
  }

  /**
   * {@inheritdoc}
   */
  public function setConditions(array $conditions) {
    $this->configuration['conditions'] = [];
    foreach ($conditions as $condition) {
      if ($condition instanceof ConditionInterface) {
        $this->configuration['conditions'][] = [
          'plugin' => $condition
            ->getPluginId(),
          'configuration' => $condition
            ->getConfiguration(),
        ];
      }
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getConditionOperator() {
    return 'OR';
  }

}

Members

Name	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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OrderItemPromotionOfferBase::buildConfigurationForm	public	function	Form constructor. Overrides PromotionOfferBase::buildConfigurationForm
OrderItemPromotionOfferBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides PromotionOfferBase::defaultConfiguration
OrderItemPromotionOfferBase::getConditionOperator	public	function	Gets the condition operator. Overrides OrderItemPromotionOfferInterface::getConditionOperator
OrderItemPromotionOfferBase::getConditions	public	function	Gets the conditions. Overrides OrderItemPromotionOfferInterface::getConditions
OrderItemPromotionOfferBase::setConditions	public	function	Sets the conditions. Overrides OrderItemPromotionOfferInterface::setConditions
OrderItemPromotionOfferBase::submitConfigurationForm	public	function	Form submission handler. Overrides PromotionOfferBase::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.
PromotionOfferBase::$rounder	protected	property	The rounder.
PromotionOfferBase::assertEntity	protected	function	Asserts that the given entity is of the expected type.
PromotionOfferBase::clear	public	function	Allows an offer to clean up any modifications done to the given entity. Overrides PromotionOfferInterface::clear	1
PromotionOfferBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
PromotionOfferBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PromotionOfferBase::getEntityTypeId	public	function	Gets the offer entity type ID. Overrides PromotionOfferInterface::getEntityTypeId
PromotionOfferBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PromotionOfferBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	2
PromotionOfferBase::__construct	public	function	Constructs a new PromotionOfferBase object. Overrides PluginBase::__construct	1
PromotionOfferInterface::apply	public	function	Applies the offer to the given entity.	6
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.

You are here

abstract class OrderItemPromotionOfferBase in Commerce Core 8.2

Hierarchy

File

Namespace

Members

API Navigation