class Promotion in Commerce Core 8.2

Defines the promotion entity class.

Plugin annotation


@ContentEntityType(
  id = "commerce_promotion",
  label = @Translation("Promotion", context = "Commerce"),
  label_collection = @Translation("Promotions", context = "Commerce"),
  label_singular = @Translation("promotion", context = "Commerce"),
  label_plural = @Translation("promotions", context = "Commerce"),
  label_count = @PluralTranslation(
    singular = "@count promotion",
    plural = "@count promotions",
    context = "Commerce",
  ),
  handlers = {
    "event" = "Drupal\commerce_promotion\Event\PromotionEvent",
    "storage" = "Drupal\commerce_promotion\PromotionStorage",
    "access" = "Drupal\entity\EntityAccessControlHandler",
    "permission_provider" = "Drupal\entity\EntityPermissionProvider",
    "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
    "list_builder" = "Drupal\commerce_promotion\PromotionListBuilder",
    "views_data" = "Drupal\commerce_promotion\PromotionViewsData",
    "form" = {
      "default" = "Drupal\commerce_promotion\Form\PromotionForm",
      "add" = "Drupal\commerce_promotion\Form\PromotionForm",
      "enable" = "Drupal\commerce_promotion\Form\PromotionEnableForm",
      "disable" = "Drupal\commerce_promotion\Form\PromotionDisableForm",
      "edit" = "Drupal\commerce_promotion\Form\PromotionForm",
      "duplicate" = "Drupal\commerce_promotion\Form\PromotionForm",
      "delete" = "Drupal\Core\Entity\ContentEntityDeleteForm"
    },
    "local_task_provider" = {
      "default" = "Drupal\entity\Menu\DefaultEntityLocalTaskProvider",
    },
    "route_provider" = {
      "default" = "Drupal\commerce_promotion\PromotionRouteProvider",
      "delete-multiple" = "Drupal\entity\Routing\DeleteMultipleRouteProvider",
    },
    "translation" = "Drupal\commerce_promotion\PromotionTranslationHandler",
  },
  base_table = "commerce_promotion",
  data_table = "commerce_promotion_field_data",
  admin_permission = "administer commerce_promotion",
  translatable = TRUE,
  translation = {
    "content_translation" = {
      "access_callback" = "content_translation_translate_access"
    },
  },
  entity_keys = {
    "id" = "promotion_id",
    "label" = "name",
    "langcode" = "langcode",
    "uuid" = "uuid",
    "owner" = "uid",
    "status" = "status",
  },
  links = {
    "add-form" = "/promotion/add",
    "edit-form" = "/promotion/{commerce_promotion}/edit",
    "enable-form" = "/promotion/{commerce_promotion}/enable",
    "disable-form" = "/promotion/{commerce_promotion}/disable",
    "duplicate-form" = "/promotion/{commerce_promotion}/duplicate",
    "delete-form" = "/promotion/{commerce_promotion}/delete",
    "delete-multiple-form" = "/admin/commerce/promotions/delete",
    "collection" = "/admin/commerce/promotions",
    "drupal:content-translation-overview" = "/promotion/{commerce_promotion}/translations",
    "drupal:content-translation-add" = "/promotion/{commerce_promotion}/translations/add/{source}/{target}",
    "drupal:content-translation-edit" = "/promotion/{commerce_promotion}/translations/edit/{language}",
    "drupal:content-translation-delete" = "/promotion/{commerce_promotion}/translations/delete/{language}",
  },
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
  - class \Drupal\commerce\Entity\CommerceContentEntityBase implements CommerceContentEntityInterface
    class \Drupal\commerce_promotion\Entity\Promotion implements PromotionInterface uses EntityOwnerTrait, EntityChangedTrait

Expanded class hierarchy of Promotion

24 files declare their use of Promotion

BuyXGetYTest.php in modules/promotion/tests/src/Kernel/Plugin/Commerce/PromotionOffer/BuyXGetYTest.php
CombinationOfferTest.php in modules/promotion/tests/src/Kernel/Plugin/Commerce/PromotionOffer/CombinationOfferTest.php
commerce_promotion.install in modules/promotion/commerce_promotion.install: Install, update and uninstall functions for the commerce_promotion module.
CouponAccessTest.php in modules/promotion/tests/src/Kernel/CouponAccessTest.php
CouponCodeGeneratorTest.php in modules/promotion/tests/src/Kernel/CouponCodeGeneratorTest.php

... See full list

3 string references to 'Promotion'

commerce_order.commerce_adjustment_types.yml in modules/order/commerce_order.commerce_adjustment_types.yml: modules/order/commerce_order.commerce_adjustment_types.yml
OrderItemPercentageOffTest::testStackingPromotions in modules/promotion/tests/src/Kernel/Plugin/Commerce/PromotionOffer/OrderItemPercentageOffTest.php: Tests applying both an inclusive and a non inclusive promotion.
PromotionOrderProcessorTest::testCouponRemoval in modules/promotion/tests/src/Kernel/PromotionOrderProcessorTest.php: Tests the order refresh to remove coupons from an order when invalid.

File

modules/promotion/src/Entity/Promotion.php, line 94

Namespace

Drupal\commerce_promotion\Entity

View source

class Promotion extends CommerceContentEntityBase implements PromotionInterface {
  use EntityChangedTrait;
  use EntityOwnerTrait;

  /**
   * {@inheritdoc}
   */
  public function toUrl($rel = 'canonical', array $options = []) {
    if ($rel == 'canonical') {
      $rel = 'edit-form';
    }
    return parent::toUrl($rel, $options);
  }

  /**
   * {@inheritdoc}
   */
  public function createDuplicate() {
    $duplicate = parent::createDuplicate();

    // Coupons cannot be transferred because their codes are unique.
    $duplicate
      ->set('coupons', []);
    return $duplicate;
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this
      ->get('name')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setName($name) {
    $this
      ->set('name', $name);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDisplayName() {
    return $this
      ->get('display_name')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setDisplayName($display_name) {
    $this
      ->set('display_name', $display_name);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->get('description')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    $this
      ->set('description', $description);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this
      ->get('created')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCreatedTime($timestamp) {
    $this
      ->set('created', $timestamp);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOrderTypes() {
    return $this
      ->get('order_types')
      ->referencedEntities();
  }

  /**
   * {@inheritdoc}
   */
  public function setOrderTypes(array $order_types) {
    $this
      ->set('order_types', $order_types);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOrderTypeIds() {
    $order_type_ids = [];
    foreach ($this
      ->get('order_types') as $field_item) {
      $order_type_ids[] = $field_item->target_id;
    }
    return $order_type_ids;
  }

  /**
   * {@inheritdoc}
   */
  public function setOrderTypeIds(array $order_type_ids) {
    $this
      ->set('order_types', $order_type_ids);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getStores() {
    return $this
      ->getTranslatedReferencedEntities('stores');
  }

  /**
   * {@inheritdoc}
   */
  public function setStores(array $stores) {
    $this
      ->set('stores', $stores);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getStoreIds() {
    $store_ids = [];
    foreach ($this
      ->get('stores') as $field_item) {
      $store_ids[] = $field_item->target_id;
    }
    return $store_ids;
  }

  /**
   * {@inheritdoc}
   */
  public function setStoreIds(array $store_ids) {
    $this
      ->set('stores', $store_ids);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOffer() {
    if (!$this
      ->get('offer')
      ->isEmpty()) {
      return $this
        ->get('offer')
        ->first()
        ->getTargetInstance();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setOffer(PromotionOfferInterface $offer) {
    $this
      ->set('offer', [
      'target_plugin_id' => $offer
        ->getPluginId(),
      'target_plugin_configuration' => $offer
        ->getConfiguration(),
    ]);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getConditions() {
    $conditions = [];
    foreach ($this
      ->get('conditions') as $field_item) {

      /** @var \Drupal\commerce\Plugin\Field\FieldType\PluginItemInterface $field_item */
      $condition = $field_item
        ->getTargetInstance();
      if ($condition instanceof ParentEntityAwareInterface) {
        $condition
          ->setParentEntity($this);
      }
      $conditions[] = $condition;
    }
    return $conditions;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getConditionOperator() {
    return $this
      ->get('condition_operator')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setConditionOperator($condition_operator) {
    $this
      ->set('condition_operator', $condition_operator);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCouponIds() {
    $coupon_ids = [];
    foreach ($this
      ->get('coupons') as $field_item) {
      $coupon_ids[] = $field_item->target_id;
    }
    return $coupon_ids;
  }

  /**
   * {@inheritdoc}
   */
  public function getCoupons() {
    $coupons = $this
      ->get('coupons')
      ->referencedEntities();
    return $coupons;
  }

  /**
   * {@inheritdoc}
   */
  public function setCoupons(array $coupons) {
    $this
      ->set('coupons', $coupons);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasCoupons() {
    return !$this
      ->get('coupons')
      ->isEmpty();
  }

  /**
   * {@inheritdoc}
   */
  public function addCoupon(CouponInterface $coupon) {
    if (!$this
      ->hasCoupon($coupon)) {
      $this
        ->get('coupons')
        ->appendItem($coupon);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function removeCoupon(CouponInterface $coupon) {
    $index = $this
      ->getCouponIndex($coupon);
    if ($index !== FALSE) {
      $this
        ->get('coupons')
        ->offsetUnset($index);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasCoupon(CouponInterface $coupon) {
    return in_array($coupon
      ->id(), $this
      ->getCouponIds());
  }

  /**
   * Gets the index of the given coupon.
   *
   * @param \Drupal\commerce_promotion\Entity\CouponInterface $coupon
   *   The coupon.
   *
   * @return int|bool
   *   The index of the given coupon, or FALSE if not found.
   */
  protected function getCouponIndex(CouponInterface $coupon) {
    return array_search($coupon
      ->id(), $this
      ->getCouponIds());
  }

  /**
   * {@inheritdoc}
   */
  public function getUsageLimit() {
    return $this
      ->get('usage_limit')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setUsageLimit($usage_limit) {
    $this
      ->set('usage_limit', $usage_limit);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCustomerUsageLimit() {
    return $this
      ->get('usage_limit_customer')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCustomerUsageLimit($usage_limit_customer) {
    $this
      ->set('usage_limit_customer', $usage_limit_customer);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getStartDate($store_timezone = 'UTC') {
    return new DrupalDateTime($this
      ->get('start_date')->value, $store_timezone);
  }

  /**
   * {@inheritdoc}
   */
  public function setStartDate(DrupalDateTime $start_date) {
    $this
      ->get('start_date')->value = $start_date
      ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getEndDate($store_timezone = 'UTC') {
    if (!$this
      ->get('end_date')
      ->isEmpty()) {
      return new DrupalDateTime($this
        ->get('end_date')->value, $store_timezone);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setEndDate(DrupalDateTime $end_date = NULL) {
    $this
      ->get('end_date')->value = NULL;
    if ($end_date) {
      $this
        ->get('end_date')->value = $end_date
        ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCompatibility() {
    return $this
      ->get('compatibility')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCompatibility($compatibility) {
    if (!in_array($compatibility, [
      self::COMPATIBLE_NONE,
      self::COMPATIBLE_ANY,
    ])) {
      throw new \InvalidArgumentException('Invalid compatibility type');
    }
    $this
      ->get('compatibility')->value = $compatibility;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isEnabled() {
    return (bool) $this
      ->getEntityKey('status');
  }

  /**
   * {@inheritdoc}
   */
  public function setEnabled($enabled) {
    $this
      ->set('status', (bool) $enabled);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return (int) $this
      ->get('weight')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setWeight($weight) {
    $this
      ->set('weight', $weight);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function available(OrderInterface $order) {
    if (!$this
      ->isEnabled()) {
      return FALSE;
    }
    if (!in_array($order
      ->bundle(), $this
      ->getOrderTypeIds())) {
      return FALSE;
    }
    if (!in_array($order
      ->getStoreId(), $this
      ->getStoreIds())) {
      return FALSE;
    }
    $date = $order
      ->getCalculationDate();
    $store_timezone = $date
      ->getTimezone()
      ->getName();
    $start_date = $this
      ->getStartDate($store_timezone);
    if ($start_date
      ->format('U') > $date
      ->format('U')) {
      return FALSE;
    }
    $end_date = $this
      ->getEndDate($store_timezone);
    if ($end_date && $end_date
      ->format('U') <= $date
      ->format('U')) {
      return FALSE;
    }
    $usage_limit = $this
      ->getUsageLimit();
    $usage_limit_customer = $this
      ->getCustomerUsageLimit();

    // If there are no usage limits, the promotion is available.
    if (!$usage_limit && !$usage_limit_customer) {
      return TRUE;
    }

    /** @var \Drupal\commerce_promotion\PromotionUsageInterface $usage */
    $usage = \Drupal::service('commerce_promotion.usage');
    if ($usage_limit && $usage_limit <= $usage
      ->load($this)) {
      return FALSE;
    }
    if ($usage_limit_customer) {

      // Promotion cannot apply to orders without email addresses.
      if (!($email = $order
        ->getEmail())) {
        return FALSE;
      }
      if ($usage_limit_customer <= $usage
        ->load($this, $email)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function applies(OrderInterface $order) {

    // Check compatibility.
    // @todo port remaining strategies from Commerce Discount #2762997.
    switch ($this
      ->getCompatibility()) {
      case self::COMPATIBLE_NONE:

        // If there are any existing promotions, then this cannot apply.
        foreach ($order
          ->collectAdjustments() as $adjustment) {
          if ($adjustment
            ->getType() == 'promotion') {
            return FALSE;
          }
        }
        break;
      case self::COMPATIBLE_ANY:
        break;
    }
    $conditions = $this
      ->getConditions();
    if (!$conditions) {

      // Promotions without conditions always apply.
      return TRUE;
    }

    // Filter the conditions just in case there are leftover order item
    // conditions (which have been moved to offer conditions).
    $conditions = array_filter($conditions, function ($condition) {

      /** @var \Drupal\commerce\Plugin\Commerce\Condition\ConditionInterface $condition */
      return $condition
        ->getEntityTypeId() == 'commerce_order';
    });
    $condition_group = new ConditionGroup($conditions, $this
      ->getConditionOperator());
    return $condition_group
      ->evaluate($order);
  }

  /**
   * {@inheritdoc}
   */
  public function apply(OrderInterface $order) {
    $offer = $this
      ->getOffer();
    if ($offer instanceof OrderItemPromotionOfferInterface) {
      $offer_conditions = new ConditionGroup($offer
        ->getConditions(), $offer
        ->getConditionOperator());

      // Apply the offer to order items that pass the conditions.
      foreach ($order
        ->getItems() as $order_item) {

        // Skip order items with a null unit price or with a quantity = 0.
        if (!$order_item
          ->getUnitPrice() || Calculator::compare($order_item
          ->getQuantity(), '0') === 0) {
          continue;
        }
        if ($offer_conditions
          ->evaluate($order_item)) {
          $offer
            ->apply($order_item, $this);
        }
      }
    }
    else {
      $offer
        ->apply($order, $this);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function clear(OrderInterface $order) {
    $offer = $this
      ->getOffer();
    if ($offer instanceof OrderItemPromotionOfferInterface) {
      foreach ($order
        ->getItems() as $order_item) {
        $offer
          ->clear($order_item, $this);
      }
    }
    else {
      $offer
        ->clear($order, $this);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);
    foreach (array_keys($this
      ->getTranslationLanguages()) as $langcode) {
      $translation = $this
        ->getTranslation($langcode);

      // Explicitly set the owner ID to 0 if the translation owner is anonymous
      // (This will ensure we don't store a broken reference in case the user
      // no longer exists).
      if ($translation
        ->getOwner()
        ->isAnonymous()) {
        $translation
          ->setOwnerId(0);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);

    // Ensure there's a back-reference on each coupon.
    foreach ($this
      ->getCoupons() as $coupon) {
      if (!$coupon
        ->getPromotionId()) {
        $coupon->promotion_id = $this
          ->id();
        $coupon
          ->save();
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageInterface $storage, array $entities) {

    // Delete the linked coupons and usage records.
    $coupons = [];
    foreach ($entities as $entity) {
      foreach ($entity
        ->getCoupons() as $coupon) {
        $coupons[] = $coupon;
      }
    }

    /** @var \Drupal\commerce_promotion\CouponStorageInterface $coupon_storage */
    $coupon_storage = \Drupal::service('entity_type.manager')
      ->getStorage('commerce_promotion_coupon');
    $coupon_storage
      ->delete($coupons);

    /** @var \Drupal\commerce_promotion\PromotionUsageInterface $usage */
    $usage = \Drupal::service('commerce_promotion.usage');
    $usage
      ->delete($entities);
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);
    $fields += static::ownerBaseFieldDefinitions($entity_type);
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('The promotion name.'))
      ->setRequired(TRUE)
      ->setTranslatable(TRUE)
      ->setSettings([
      'default_value' => '',
      'max_length' => 255,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayConfigurable('form', TRUE);
    $fields['uid']
      ->setLabel(t('Owner'))
      ->setDescription(t('The promotion owner.'))
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayConfigurable('form', TRUE);
    $fields['display_name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Display name'))
      ->setDescription(t('If provided, shown on the order instead of "@translated".', [
      '@translated' => t('Discount'),
    ]))
      ->setTranslatable(TRUE)
      ->setSettings([
      'display_description' => TRUE,
      'default_value' => '',
      'max_length' => 255,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayConfigurable('form', TRUE);
    $fields['description'] = BaseFieldDefinition::create('string_long')
      ->setLabel(t('Description'))
      ->setDescription(t('Additional information about the promotion to show to the customer'))
      ->setTranslatable(TRUE)
      ->setDefaultValue('')
      ->setDisplayOptions('form', [
      'type' => 'string_textarea',
      'weight' => 1,
      'settings' => [
        'rows' => 3,
      ],
    ])
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayConfigurable('form', TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setTranslatable(TRUE)
      ->setDescription(t('The time when the promotion was created.'));
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setTranslatable(TRUE)
      ->setDescription(t('The time when the promotion was last edited.'))
      ->setDisplayConfigurable('view', TRUE);
    $fields['order_types'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Order types'))
      ->setDescription(t('The order types for which the promotion is valid.'))
      ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
      ->setRequired(TRUE)
      ->setSetting('target_type', 'commerce_order_type')
      ->setSetting('handler', 'default')
      ->setDisplayOptions('form', [
      'type' => 'commerce_entity_select',
      'weight' => 2,
    ]);
    $fields['stores'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Stores'))
      ->setDescription(t('The stores for which the promotion is valid.'))
      ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
      ->setRequired(TRUE)
      ->setSetting('target_type', 'commerce_store')
      ->setSetting('handler', 'default')
      ->setDisplayOptions('form', [
      'type' => 'commerce_entity_select',
      'weight' => 2,
    ]);
    $fields['offer'] = BaseFieldDefinition::create('commerce_plugin_item:commerce_promotion_offer')
      ->setLabel(t('Offer type'))
      ->setCardinality(1)
      ->setRequired(TRUE)
      ->setDisplayOptions('form', [
      'type' => 'commerce_plugin_select',
      'weight' => 3,
    ]);
    $fields['conditions'] = BaseFieldDefinition::create('commerce_plugin_item:commerce_condition')
      ->setLabel(t('Conditions'))
      ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
      ->setRequired(FALSE)
      ->setDisplayOptions('form', [
      'type' => 'commerce_conditions',
      'weight' => 3,
      'settings' => [
        'entity_types' => [
          'commerce_order',
        ],
      ],
    ]);
    $fields['condition_operator'] = BaseFieldDefinition::create('list_string')
      ->setLabel(t('Condition operator'))
      ->setDescription(t('The condition operator.'))
      ->setRequired(TRUE)
      ->setSetting('allowed_values', [
      'AND' => t('All conditions must pass'),
      'OR' => t('Only one condition must pass'),
    ])
      ->setDisplayOptions('form', [
      'type' => 'options_buttons',
      'weight' => 4,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDefaultValue('AND');
    $fields['coupons'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Coupons'))
      ->setDescription(t('Coupons which allow promotion to be redeemed.'))
      ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
      ->setRequired(FALSE)
      ->setSetting('target_type', 'commerce_promotion_coupon')
      ->setSetting('handler', 'default');
    $fields['usage_limit'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Usage limit'))
      ->setDescription(t('The maximum number of times the promotion can be used. 0 for unlimited.'))
      ->setDefaultValue(0)
      ->setDisplayOptions('form', [
      'type' => 'commerce_usage_limit',
      'weight' => 4,
    ]);
    $fields['usage_limit_customer'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Customer usage limit'))
      ->setDescription(t('The maximum number of times the promotion can be used by a customer. 0 for unlimited.'))
      ->setDefaultValue(0)
      ->setDisplayOptions('form', [
      'type' => 'commerce_usage_limit',
      'weight' => 4,
    ]);
    $fields['start_date'] = BaseFieldDefinition::create('datetime')
      ->setLabel(t('Start date'))
      ->setDescription(t('The date the promotion becomes valid.'))
      ->setRequired(TRUE)
      ->setSetting('datetime_type', 'datetime')
      ->setDefaultValueCallback('Drupal\\commerce_promotion\\Entity\\Promotion::getDefaultStartDate')
      ->setDisplayOptions('form', [
      'type' => 'commerce_store_datetime',
      'weight' => 5,
    ]);
    $fields['end_date'] = BaseFieldDefinition::create('datetime')
      ->setLabel(t('End date'))
      ->setDescription(t('The date after which the promotion is invalid.'))
      ->setRequired(FALSE)
      ->setSetting('datetime_type', 'datetime')
      ->setSetting('datetime_optional_label', t('Provide an end date'))
      ->setDisplayOptions('form', [
      'type' => 'commerce_store_datetime',
      'weight' => 6,
    ]);
    $fields['compatibility'] = BaseFieldDefinition::create('list_string')
      ->setLabel(t('Compatibility with other promotions'))
      ->setSetting('allowed_values_function', [
      '\\Drupal\\commerce_promotion\\Entity\\Promotion',
      'getCompatibilityOptions',
    ])
      ->setRequired(TRUE)
      ->setDefaultValue(self::COMPATIBLE_ANY)
      ->setDisplayOptions('form', [
      'type' => 'options_buttons',
      'weight' => 4,
    ]);
    $fields['status'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Status'))
      ->setDescription(t('Whether the promotion is enabled.'))
      ->setDefaultValue(TRUE)
      ->setRequired(TRUE)
      ->setSettings([
      'on_label' => t('Enabled'),
      'off_label' => t('Disabled'),
    ])
      ->setDisplayOptions('form', [
      'type' => 'options_buttons',
      'weight' => 0,
    ]);
    $fields['weight'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Weight'))
      ->setDescription(t('The weight of this promotion in relation to others.'))
      ->setDefaultValue(0);
    return $fields;
  }

  /**
   * Default value callback for 'start_date' base field definition.
   *
   * @see ::baseFieldDefinitions()
   *
   * @return string
   *   The default value (date string).
   */
  public static function getDefaultStartDate() {
    $timestamp = \Drupal::time()
      ->getRequestTime();
    return gmdate(DateTimeItemInterface::DATETIME_STORAGE_FORMAT, $timestamp);
  }

  /**
   * Helper callback for uasort() to sort promotions by weight and label.
   *
   * @param \Drupal\commerce_promotion\Entity\PromotionInterface $a
   *   The first promotion to sort.
   * @param \Drupal\commerce_promotion\Entity\PromotionInterface $b
   *   The second promotion to sort.
   *
   * @return int
   *   The comparison result for uasort().
   */
  public static function sort(PromotionInterface $a, PromotionInterface $b) {
    $a_weight = $a
      ->getWeight();
    $b_weight = $b
      ->getWeight();
    if ($a_weight == $b_weight) {
      $a_label = $a
        ->label();
      $b_label = $b
        ->label();
      return strnatcasecmp($a_label, $b_label);
    }
    return $a_weight < $b_weight ? -1 : 1;
  }

  /**
   * Gets the allowed values for the 'compatibility' base field.
   *
   * @return array
   *   The allowed values.
   */
  public static function getCompatibilityOptions() {
    return [
      self::COMPATIBLE_ANY => t('Any promotion'),
      self::COMPATIBLE_NONE => t('Not with any other promotions'),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
CommerceContentEntityBase::ensureTranslations	protected	function	Ensures entities are in the current entity's language, if possible.
CommerceContentEntityBase::getTranslatedReferencedEntities	public	function	Gets the translations of an entity reference field. Overrides CommerceContentEntityInterface::getTranslatedReferencedEntities
CommerceContentEntityBase::getTranslatedReferencedEntity	public	function	Gets the translation of a referenced entity. Overrides CommerceContentEntityInterface::getTranslatedReferencedEntity
ContentEntityBase::$activeLangcode	protected	property	Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode	protected	property	Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey	protected	property	The default langcode entity key.
ContentEntityBase::$enforceRevisionTranslationAffected	protected	property	Whether the revision translation affected flag has been enforced.
ContentEntityBase::$entityKeys	protected	property	Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions	protected	property	Local cache for field definitions.
ContentEntityBase::$fields	protected	property	The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck	protected static	property	Local cache for fields to skip from the checking for translation changes.
ContentEntityBase::$isDefaultRevision	protected	property	Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey	protected	property	The language entity key.
ContentEntityBase::$languages	protected	property	Local cache for the available language objects.
ContentEntityBase::$loadedRevisionId	protected	property	The loaded revision ID before the new revision was set.
ContentEntityBase::$newRevision	protected	property	Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$revisionTranslationAffectedKey	protected	property	The revision translation affected entity key.
ContentEntityBase::$translatableEntityKeys	protected	property	Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize	protected	property	A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations	protected	property	An array of entity translation metadata.
ContentEntityBase::$validated	protected	property	Whether entity validation was performed.
ContentEntityBase::$validationRequired	protected	property	Whether entity validation is required before saving the entity.
ContentEntityBase::$values	protected	property	The plain data values of the contained fields.
ContentEntityBase::access	public	function	Checks data value access. Overrides EntityBase::access	1
ContentEntityBase::addTranslation	public	function	Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions	4
ContentEntityBase::clearTranslationCache	protected	function	Clear entity translation object cache to remove stale references.
ContentEntityBase::get	public	function	Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey	protected	function	Gets the value of the given entity key, if defined.	1
ContentEntityBase::getFieldDefinition	public	function	Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions	public	function	Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields	public	function	Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck	protected	function	Returns an array of field names to skip in ::hasTranslationChanges.	1
ContentEntityBase::getIterator	public	function
ContentEntityBase::getLanguages	protected	function
ContentEntityBase::getLoadedRevisionId	public	function	Gets the loaded Revision ID of the entity. Overrides RevisionableInterface::getLoadedRevisionId
ContentEntityBase::getRevisionId	public	function	Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields	public	function	Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField	protected	function	Gets a translated field.
ContentEntityBase::getTranslation	public	function	Gets a translation of the data. Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages	public	function	Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getTranslationStatus	public	function	Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated	public	function	Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField	public	function	Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation	public	function	Checks there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface::hasTranslationChanges
ContentEntityBase::id	public	function	Gets the identifier. Overrides EntityBase::id
ContentEntityBase::initializeTranslation	protected	function	Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision	public	function	Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation	public	function	Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isDefaultTranslationAffectedOnly	public	function	Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly
ContentEntityBase::isLatestRevision	public	function	Checks if this entity is the latest revision. Overrides RevisionableInterface::isLatestRevision
ContentEntityBase::isLatestTranslationAffectedRevision	public	function	Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision
ContentEntityBase::isNewRevision	public	function	Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation	public	function	Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected
ContentEntityBase::isRevisionTranslationAffectedEnforced	public	function	Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced
ContentEntityBase::isTranslatable	public	function	Returns the translation support status. Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::label	public	function	Gets the label of the entity. Overrides EntityBase::label	2
ContentEntityBase::language	public	function	Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange	public	function	Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate
ContentEntityBase::preSaveRevision	public	function	Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision	2
ContentEntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities	1
ContentEntityBase::removeTranslation	public	function	Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set	public	function	Sets a field value. Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode	protected	function	Populates the local cache for the default language code.
ContentEntityBase::setNewRevision	public	function	Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected
ContentEntityBase::setRevisionTranslationAffectedEnforced	public	function	Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced
ContentEntityBase::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray
ContentEntityBase::updateFieldLangcodes	protected	function	Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId	public	function	Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface::updateLoadedRevisionId
ContentEntityBase::updateOriginalValues	public	function	Updates the original values with the interim changes.
ContentEntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate	public	function	Validates the currently set values. Overrides FieldableEntityInterface::validate
ContentEntityBase::wasDefaultRevision	public	function	Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface::wasDefaultRevision
ContentEntityBase::__clone	public	function	Magic method: Implements a deep clone.
ContentEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct
ContentEntityBase::__get	public	function	Implements the magic method for getting object properties.
ContentEntityBase::__isset	public	function	Implements the magic method for isset().
ContentEntityBase::__set	public	function	Implements the magic method for setting object properties.
ContentEntityBase::__sleep	public	function	Overrides EntityBase::__sleep
ContentEntityBase::__unset	public	function	Implements the magic method for unset().
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	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate	2
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName	1
EntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget	1
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityInterface::getOriginalId	1
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::invalidateTagsOnDelete	protected static	function	Invalidates an entity's cache tags upon delete.	1
EntityBase::invalidateTagsOnSave	protected	function	Invalidates an entity's cache tags upon save.	1
EntityBase::isNew	public	function	Determines whether the entity is new. Overrides EntityInterface::isNew	2
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link	1
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete	4
EntityBase::save	public	function	Saves an entity permanently. Overrides EntityInterface::save	3
EntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityInterface::setOriginalId	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityInterface::url	2
EntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityInterface::urlInfo	1
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
EntityChangedTrait::getChangedTime	public	function	Gets the timestamp of the last entity change for the current translation.
EntityChangedTrait::getChangedTimeAcrossTranslations	public	function	Returns the timestamp of the last entity change across all translations.
EntityChangedTrait::setChangedTime	public	function	Sets the timestamp of the last entity change for the current translation.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck	protected	function	Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
EntityOwnerTrait::getDefaultEntityOwner	public static	function	Default value callback for 'owner' base field.	1
EntityOwnerTrait::getOwner	public	function	Overrides EntityOwnerTrait::getOwner
EntityOwnerTrait::getOwnerId	public	function
EntityOwnerTrait::ownerBaseFieldDefinitions	public static	function	Returns an array of base field definitions for entity owners.
EntityOwnerTrait::setOwner	public	function
EntityOwnerTrait::setOwnerId	public	function
Promotion::addCoupon	public	function	Adds a coupon. Overrides PromotionInterface::addCoupon
Promotion::applies	public	function	Checks whether the promotion can be applied to the given order. Overrides PromotionInterface::applies
Promotion::apply	public	function	Applies the promotion to the given order. Overrides PromotionInterface::apply
Promotion::available	public	function	Checks whether the promotion is available for the given order. Overrides PromotionInterface::available
Promotion::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type. Overrides ContentEntityBase::baseFieldDefinitions
Promotion::clear	public	function	Allows a promotion to clean up any modifications done to the given order. Overrides PromotionInterface::clear
Promotion::createDuplicate	public	function	Creates a duplicate of the entity. Overrides ContentEntityBase::createDuplicate
Promotion::getCompatibility	public	function	Gets the promotion compatibility. Overrides PromotionInterface::getCompatibility
Promotion::getCompatibilityOptions	public static	function	Gets the allowed values for the 'compatibility' base field.
Promotion::getConditionOperator	public	function	Gets the condition operator. Overrides PromotionInterface::getConditionOperator
Promotion::getConditions	public	function	Gets the conditions. Overrides PromotionInterface::getConditions
Promotion::getCouponIds	public	function	Gets the coupon IDs. Overrides PromotionInterface::getCouponIds
Promotion::getCouponIndex	protected	function	Gets the index of the given coupon.
Promotion::getCoupons	public	function	Gets the coupons. Overrides PromotionInterface::getCoupons
Promotion::getCreatedTime	public	function	Gets the promotion creation timestamp. Overrides PromotionInterface::getCreatedTime
Promotion::getCustomerUsageLimit	public	function	Gets the per customer promotion usage limit. Overrides PromotionInterface::getCustomerUsageLimit
Promotion::getDefaultStartDate	public static	function	Default value callback for 'start_date' base field definition.
Promotion::getDescription	public	function	Gets the promotion description. Overrides PromotionInterface::getDescription
Promotion::getDisplayName	public	function	Gets the promotion display name. Overrides PromotionInterface::getDisplayName
Promotion::getEndDate	public	function	Gets the promotion end date/time. Overrides PromotionInterface::getEndDate
Promotion::getName	public	function	Gets the promotion name. Overrides PromotionInterface::getName
Promotion::getOffer	public	function	Gets the offer. Overrides PromotionInterface::getOffer
Promotion::getOrderTypeIds	public	function	Gets the promotion order type IDs. Overrides PromotionInterface::getOrderTypeIds
Promotion::getOrderTypes	public	function	Gets the promotion order types. Overrides PromotionInterface::getOrderTypes
Promotion::getStartDate	public	function	Gets the promotion start date/time. Overrides PromotionInterface::getStartDate
Promotion::getStoreIds	public	function	Gets the store IDs. Overrides EntityStoresInterface::getStoreIds
Promotion::getStores	public	function	Gets the stores. Overrides EntityStoresInterface::getStores
Promotion::getUsageLimit	public	function	Gets the promotion usage limit. Overrides PromotionInterface::getUsageLimit
Promotion::getWeight	public	function	Gets the weight. Overrides PromotionInterface::getWeight
Promotion::hasCoupon	public	function	Checks whether the promotion has a given coupon. Overrides PromotionInterface::hasCoupon
Promotion::hasCoupons	public	function	Gets whether the promotion has coupons. Overrides PromotionInterface::hasCoupons
Promotion::isEnabled	public	function	Get whether the promotion is enabled. Overrides PromotionInterface::isEnabled
Promotion::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
Promotion::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides ContentEntityBase::postSave
Promotion::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
Promotion::removeCoupon	public	function	Removes a coupon. Overrides PromotionInterface::removeCoupon
Promotion::setCompatibility	public	function	Sets the promotion compatibility. Overrides PromotionInterface::setCompatibility
Promotion::setConditionOperator	public	function	Sets the condition operator. Overrides PromotionInterface::setConditionOperator
Promotion::setConditions	public	function	Sets the conditions. Overrides PromotionInterface::setConditions
Promotion::setCoupons	public	function	Sets the coupons. Overrides PromotionInterface::setCoupons
Promotion::setCreatedTime	public	function	Sets the promotion creation timestamp. Overrides PromotionInterface::setCreatedTime
Promotion::setCustomerUsageLimit	public	function	Sets the per customer promotion usage limit. Overrides PromotionInterface::setCustomerUsageLimit
Promotion::setDescription	public	function	Sets the promotion description. Overrides PromotionInterface::setDescription
Promotion::setDisplayName	public	function	Sets the promotion display name. Overrides PromotionInterface::setDisplayName
Promotion::setEnabled	public	function	Sets whether the promotion is enabled. Overrides PromotionInterface::setEnabled
Promotion::setEndDate	public	function	Sets the promotion end date/time. Overrides PromotionInterface::setEndDate
Promotion::setName	public	function	Sets the promotion name. Overrides PromotionInterface::setName
Promotion::setOffer	public	function	Sets the offer. Overrides PromotionInterface::setOffer
Promotion::setOrderTypeIds	public	function	Sets the promotion order type IDs. Overrides PromotionInterface::setOrderTypeIds
Promotion::setOrderTypes	public	function	Sets the promotion order types. Overrides PromotionInterface::setOrderTypes
Promotion::setStartDate	public	function	Sets the promotion start date/time. Overrides PromotionInterface::setStartDate
Promotion::setStoreIds	public	function	Sets the store IDs. Overrides EntityStoresInterface::setStoreIds
Promotion::setStores	public	function	Sets the stores. Overrides EntityStoresInterface::setStores
Promotion::setUsageLimit	public	function	Sets the promotion usage limit. Overrides PromotionInterface::setUsageLimit
Promotion::setWeight	public	function	Sets the weight. Overrides PromotionInterface::setWeight
Promotion::sort	public static	function	Helper callback for uasort() to sort promotions by weight and label.
Promotion::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
PromotionInterface::COMPATIBLE_ANY		constant
PromotionInterface::COMPATIBLE_NONE		constant
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function
TranslationStatusInterface::TRANSLATION_CREATED		constant	Status code identifying a newly created translation.
TranslationStatusInterface::TRANSLATION_EXISTING		constant	Status code identifying an existing translation.
TranslationStatusInterface::TRANSLATION_REMOVED		constant	Status code identifying a removed translation.

You are here

class Promotion in Commerce Core 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation