You are here

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

class ProductBundleItem in Commerce Product Bundle 8

Defines the product bundle item entity.

Plugin annotation


@ContentEntityType(
  id = "commerce_product_bundle_i",
  label = @Translation("Product bundle item"),
  label_collection = @Translation("Product bundle items"),
  label_singular = @Translation("Product bundle item"),
  label_plural = @Translation("Product bundle items"),
  label_count = @PluralTranslation(
    singular = "@count product bundle item",
    plural = "@count product bundle items",
  ),
  bundle_label = @Translation("Product bundle item type"),
  handlers = {
    "access" = "Drupal\commerce_product_bundle\ProductBundleItemAccessControlHandler",
    "storage" = "Drupal\commerce_product_bundle\ProductBundleItemStorage",
    "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
    "list_builder" = "Drupal\commerce_product_bundle\ProductBundleItemListBuilder",
    "views_data" = "Drupal\commerce_product_bundle\Entity\ProductBundleItemViewsData",
    "translation" = "Drupal\content_translation\ContentTranslationHandler",
    "form" = {
      "default" = "Drupal\commerce_product_bundle\Form\ProductBundleItemForm",
      "add" = "Drupal\commerce_product_bundle\Form\ProductBundleItemForm",
      "edit" = "Drupal\commerce_product_bundle\Form\ProductBundleItemForm",
      "delete" = "Drupal\commerce_product_bundle\Form\ProductBundleItemDeleteForm",
    },
    "inline_form" = "Drupal\commerce_product_bundle\Form\ProductBundleItemInlineForm",
    "route_provider" = {
      "default" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
      "delete-multiple" = "Drupal\entity\Routing\DeleteMultipleRouteProvider",
    },
    "permission_provider" = "Drupal\commerce_product_bundle\EntityPermissionProvider",
  },
  base_table = "commerce_product_bundle_i",
  data_table = "commerce_product_bundle_i_field_data",
  fieldable = TRUE,
  translatable = TRUE,
  admin_permission = "administer commerce_product_bundle_i",
  entity_keys = {
    "id" = "bundle_item_id",
    "bundle" = "type",
    "label" = "title",
    "uuid" = "uuid",
    "uid" = "uid",
    "langcode" = "langcode",
  },
  links = {
    "canonical" = "/product-bundle-items/{commerce_product_bundle_i}",
    "add-page" = "/product-bundle-items/add",
    "add-form" = "/product-bundle-items/add/{commerce_product_bundle_i_type}",
    "edit-form" = "/product-bundle-items/{commerce_product_bundle_i}/edit",
    "delete-form" = "/product-bundle-items/{commerce_product_bundle_i}/delete",
    "collection" = "/product-bundle-items",
  },
  constraints = {
    "MinQtyLessThanOrEqualMaxQty" = {}
  },
  bundle_entity_type = "commerce_product_bundle_i_type",
  field_ui_base_route = "entity.commerce_product_bundle_i_type.edit_form"
)

Hierarchy

Expanded class hierarchy of ProductBundleItem

4 files declare their use of ProductBundleItem
BundleItemOrderItemTest.php in tests/src/Kernel/Entity/BundleItemOrderItemTest.php
CommerceProductBundleItemTest.php in tests/src/Kernel/Entity/CommerceProductBundleItemTest.php
CommerceProductBundleTest.php in tests/src/Kernel/Entity/CommerceProductBundleTest.php
ProductBundleStockProxyKernelTest.php in modules/commerce_product_bundle_stock/tests/src/Kernel/ProductBundleStockProxyKernelTest.php

File

src/Entity/ProductBundleItem.php, line 79

Namespace

Drupal\commerce_product_bundle\Entity
View source 
class ProductBundleItem extends ContentEntityBase implements BundleItemInterface {
  use EntityChangedTrait;

  /**
   * The parent product bundle.
   *
   * @var \Drupal\commerce_product_bundle\Entity\BundleInterface
   */
  protected $bundle;

  /**
   * The bundle items current active quantity . In case
   * of a fresh bundle, that is the default quantity.
   *
   * @var float
   */
  protected $activeQuantity;

  /**
   * The currently selected variation.
   *
   * @var \Drupal\commerce_product\Entity\ProductVariationInterface
   */
  protected $currentVariation;

  /**
   * {@inheritdoc}
   */
  public function getOwner() {
    return $this
      ->get('uid')->entity;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getOwnerId() {
    return $this
      ->get('uid')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getBundle() {
    return $this
      ->get('bundle_id')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getBundleId() {
    return $this
      ->get('bundle_id')->target_id;
  }

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

  /**
   * {@inheritdoc}
   */
  public function setTitle($title) {
    $this
      ->set('title', $title);
    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 setOwner(UserInterface $account) {
    $this
      ->set('uid', $account
      ->id());
    return $this;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getUnitPrice() {
    if (!$this
      ->get('unit_price')
      ->isEmpty()) {
      return $this
        ->get('unit_price')
        ->first()
        ->toPrice();
    }
    $variation = $this
      ->getCurrentVariation();
    return $variation ? $variation
      ->getPrice() : NULL;
  }

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

  /**
   * {@inheritdoc}
   */
  public function setUnitPrice(Price $unit_price) {
    $this
      ->set('unit_price', $unit_price);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getQuantity() {
    if (isset($this->activeQuantity)) {
      return $this->activeQuantity;
    }
    return $this
      ->getMinimumQuantity();
  }

  /**
   * {@inheritdoc}
   */
  public function setQuantity($quantity) {

    // @todo We need to check against the min/max constraints
    // @see https://www.drupal.org/node/2847809
    $this->activeQuantity = (double) $quantity;
    return $this;
  }

  /**
   * @inheritdoc
   */
  public function setMinimumQuantity($minimum_quantity) {
    $this
      ->set('min_quantity', (double) $minimum_quantity);
    return $this;
  }

  /**
   * @inheritdoc
   */
  public function setMaximumQuantity($maximum_quantity) {
    $this
      ->set('max_quantity', (double) $maximum_quantity);
    return $this;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getProduct() {
    if ($this
      ->hasProduct()) {
      return $this
        ->get('product')
        ->referencedEntities()[0];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getProductId() {
    return $this
      ->getProduct()
      ->id();
  }

  /**
   * @inheritdoc
   */
  public function setProduct(ProductInterface $product) {

    // Unset variations, if we get another product.
    if ($this
      ->hasProduct()) {
      $currentProductId = $this
        ->getProduct()
        ->id();
      $newProductId = $product
        ->id();
      if ($currentProductId !== $newProductId) {
        $this
          ->set('variations', NULL);
      }
    }
    $this
      ->set('product', $product);
    return $this;
  }

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

  /**
   * {@inheritdoc}
   */
  public function addVariation(ProductVariationInterface $variation) {
    if ($this
      ->hasProduct() && $this
      ->hasVariations() && !$this
      ->hasVariation($variation)) {
      $this
        ->assertSameProduct([
        $variation,
      ]);
      $this
        ->get('variations')
        ->appendItem($variation);
    }
    return $this;
  }

  /**
   * Whether the bundle item has a specific variation referenced.
   *
   * @param \Drupal\commerce_product\Entity\ProductVariationInterface $variation
   *   The variation.
   *
   * @return bool
   *   True if the variations reference contains the variation, false otherwise.
   */
  protected function hasVariation(ProductVariationInterface $variation) {
    return $this
      ->getVariationIndex($variation) !== FALSE;
  }

  /**
   * Get the index of a variation in the variation references.
   *
   * @param \Drupal\commerce_product\Entity\ProductVariationInterface $variation
   *   The variation.
   *
   * @return false|int|string
   *   The key for the variation if it is found in the
   *   references, false otherwise.
   */
  protected function getVariationIndex(ProductVariationInterface $variation) {
    $result = array_search($variation
      ->id(), $this
      ->getVariationIds() ?: []);
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function getVariationIds() {
    $variations = $this
      ->getVariations();
    if (empty($variations)) {
      return NULL;
    }
    return array_map(function ($variation) {
      return $variation
        ->id();
    }, $this
      ->getVariations());
  }

  /**
   * {@inheritdoc}
   */
  public function removeVariation(ProductVariationInterface $variation) {
    $index = $this
      ->getVariationIndex($variation);
    if ($index !== FALSE) {
      $this
        ->get('variations')
        ->offsetUnset($index);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultVariation() {
    if (!$this
      ->hasProduct()) {
      return NULL;
    }
    foreach ($this
      ->getVariations() as $variation) {

      // Return the first active variation.
      if ($variation
        ->isPublished()) {
        return $variation;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getVariations() {
    if (!$this
      ->hasProduct()) {
      return NULL;
    }
    $variations = $this
      ->get('variations')
      ->referencedEntities();
    if (empty($variations)) {
      return $this
        ->getEnabledVariations();
    }
    return $this
      ->ensureTranslations($variations);
  }

  /**
   * Get the enabled product variations.
   *
   * @return null|\Drupal\commerce_product\Entity\ProductVariationInterface[]
   *   Array of enabled product variations or NULL.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  protected function getEnabledVariations() {
    $variationStorage = $this
      ->entityTypeManager()
      ->getStorage('commerce_product_variation');
    return $variationStorage
      ->loadEnabled($this
      ->getProduct());
  }

  /**
   * {@inheritdoc}
   */
  public function setVariations(array $variations) {
    if (empty($variations)) {
      return $this;
    }

    // If there is no product referenced on the bundle item, do it now.
    if ($this
      ->get('product')
      ->isEmpty()) {
      $this
        ->setProduct($variations[0]
        ->getProduct());
    }
    $this
      ->assertSameProduct($variations);
    $this
      ->set('variations', $variations);
    return $this;
  }

  /**
   * Ensure that all passed variations belong to the same product.
   *
   * @param array $variations
   *   \Drupal\commerce_product\Entity\ProductVariationInterface[].
   *
   * @throws \InvalidArgumentException
   *    In case a variation belongs to another product.
   */
  protected function assertSameProduct(array $variations) {
    foreach ($variations as $variation) {
      $shouldBeOfType = $this
        ->getProduct()
        ->id();
      $isType = $variation
        ->getProductId();
      if ($shouldBeOfType !== $isType) {
        throw new \InvalidArgumentException('All variations of a bundle item must be from the same product.');
      }
    }
  }

  /**
   * {@inheritdoc}
   *
   * @todo Figure out how to get the currently selected variation
   * without holding state in this object.
   * @see https://www.drupal.org/node/2831613
   */
  public function getCurrentVariation() {
    return $this->currentVariation ?: $this
      ->getDefaultVariation();
  }

  /**
   * {@inheritdoc}
   */
  public function setCurrentVariation(ProductVariationInterface $variation) {
    $this
      ->assertSameProduct([
      $variation,
    ]);
    if (!$this
      ->hasVariation($variation)) {
      throw new \InvalidArgumentException('Variation is not part of this product bundle.');
    }
    $this->currentVariation = $variation;
    return $this;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage_controller, array &$values) {
    parent::preCreate($storage_controller, $values);
    $values += [
      'uid' => \Drupal::currentUser()
        ->id(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Author'))
      ->setDescription(t('The user ID of author of the product bundle item entity.'))
      ->setSetting('target_type', 'user')
      ->setSetting('handler', 'default')
      ->setDefaultValueCallback('Drupal\\commerce_product_bundle\\Entity\\ProductBundleItem::getCurrentUserId')
      ->setDisplayOptions('view', [
      'title' => 'hidden',
      'type' => 'author',
      'weight' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'entity_reference_autocomplete',
      'weight' => 5,
      'settings' => [
        'match_operator' => 'CONTAINS',
        'size' => '60',
        'autocomplete_type' => 'tags',
        'match_limit' => 10,
        'placeholder' => '',
      ],
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['title'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Title'))
      ->setDescription(t('The title of the product bundle item entity.'))
      ->setRequired(TRUE)
      ->setTranslatable(TRUE)
      ->setSettings([
      'max_length' => 128,
      'text_processing' => 0,
    ])
      ->setDefaultValue('')
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'string',
      'weight' => -4,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => -4,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['required'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Required?'))
      ->setDescription(t('A boolean indicating whether the product bundle item is required or optional.'))
      ->setSettings([
      'on_label' => t('Yes, required'),
      'off_label' => t('No, optional'),
    ])
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'settings' => [
        'display_label' => TRUE,
      ],
      'weight' => 20,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDefaultValue(TRUE);

    // The product bundle backreference, populated by ProductBundle::postSave().
    $fields['bundle_id'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Product bundle'))
      ->setDescription(t('The parent product bundle.'))
      ->setSetting('target_type', 'commerce_product_bundle')
      ->setReadOnly(TRUE)
      ->setDisplayConfigurable('view', TRUE);

    // The price is not required because it's not guaranteed to be used
    // for storage. We may use the price of the referenced variations.
    // entity.
    $fields['unit_price'] = BaseFieldDefinition::create('commerce_price')
      ->setLabel(t('Unit price'))
      ->setDescription(t('The unit price, if overridden, of the variation selected from this bundle item.'))
      ->setDisplayOptions('view', [
      'label' => 'above',
      'type' => 'commerce_price_default',
      'weight' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'commerce_price_default',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['product'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Product'))
      ->setDescription(t('Reference to a product.'))
      ->setSetting('target_type', 'commerce_product')
      ->setSetting('handler', 'default')
      ->setCardinality(1)
      ->setRequired(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'entity_reference_label',
      'weight' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'entity_reference_autocomplete',
      'weight' => 5,
      'settings' => [
        'match_operator' => 'CONTAINS',
        'size' => '60',
        'autocomplete_type' => 'tags',
        'match_limit' => 10,
        'placeholder' => '',
      ],
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);

    // Variations added in commerce_product_bundle.module.
    // @see commerce_product_bundle_add_variations_field().
    $fields['min_quantity'] = BaseFieldDefinition::create('decimal')
      ->setLabel(t('Minimum Quantity'))
      ->setDescription(t('The minimum quantity.'))
      ->setSetting('unsigned', TRUE)
      ->setSetting('min', 0)
      ->setRequired(TRUE)
      ->setDefaultValue(1)
      ->setDisplayOptions('form', [
      'type' => 'number',
      'weight' => 1,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE)
      ->addPropertyConstraints('value', [
      'Range' => [
        'min' => 0,
      ],
    ]);
    $fields['max_quantity'] = BaseFieldDefinition::create('decimal')
      ->setLabel(t('Maximum Quantity'))
      ->setDescription(t('The maximum quantity.'))
      ->setSetting('unsigned', TRUE)
      ->setSetting('min', 1)
      ->setRequired(TRUE)
      ->setDefaultValue(1)
      ->setDisplayOptions('form', [
      'type' => 'number',
      'weight' => 1,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time that the entity was created.'));
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the entity was last edited.'));
    return $fields;
  }

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

      // If no owner has been set explicitly, make the anonymous user the owner.
      if (!$translation
        ->getOwner()) {
        $translation
          ->setOwnerId(0);
      }
    }
  }

  /**
   * Ensures that the provided entities are in the current entity's language.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface[] $entities
   *   The entities to process.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface[]
   *   The processed entities.
   */
  protected function ensureTranslations(array $entities) {
    $langcode = $this
      ->language()
      ->getId();
    foreach ($entities as $index => $entity) {

      /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
      if ($entity
        ->hasTranslation($langcode)) {
        $entities[$index] = $entity
          ->getTranslation($langcode);
      }
    }
    return $entities;
  }

  /**
   * Default value callback for 'uid' base field definition.
   *
   * @see ::baseFieldDefinitions()
   *
   * @return array
   *   An array of default values.
   */
  public static function getCurrentUserId() {
    return [
      \Drupal::currentUser()
        ->id(),
    ];
  }

}

Members

Namesort descending 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.
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::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
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::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 5
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::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
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::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 2
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
ProductBundleItem::$activeQuantity protected property The bundle items current active quantity . In case of a fresh bundle, that is the default quantity.
ProductBundleItem::$bundle protected property The parent product bundle.
ProductBundleItem::$currentVariation protected property The currently selected variation.
ProductBundleItem::addVariation public function Adds a variation. Overrides BundleItemInterface::addVariation
ProductBundleItem::assertSameProduct protected function Ensure that all passed variations belong to the same product.
ProductBundleItem::baseFieldDefinitions public static function Provides base field definitions for an entity type. Overrides ContentEntityBase::baseFieldDefinitions
ProductBundleItem::ensureTranslations protected function Ensures that the provided entities are in the current entity's language.
ProductBundleItem::getBundle public function Gets the parent bundle entity. Overrides BundleItemInterface::getBundle
ProductBundleItem::getBundleId public function Gets the parent product bundle ID. Overrides BundleItemInterface::getBundleId
ProductBundleItem::getCreatedTime public function Gets the product bundle item creation timestamp. Overrides BundleItemInterface::getCreatedTime
ProductBundleItem::getCurrentUserId public static function Default value callback for 'uid' base field definition.
ProductBundleItem::getCurrentVariation public function @todo Figure out how to get the currently selected variation without holding state in this object. Overrides BundleItemInterface::getCurrentVariation
ProductBundleItem::getDefaultVariation public function Get the default variation. Overrides BundleItemInterface::getDefaultVariation
ProductBundleItem::getEnabledVariations protected function Get the enabled product variations.
ProductBundleItem::getMaximumQuantity public function @inheritdoc Overrides BundleItemInterface::getMaximumQuantity
ProductBundleItem::getMinimumQuantity public function @inheritdoc Overrides BundleItemInterface::getMinimumQuantity
ProductBundleItem::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
ProductBundleItem::getOwnerId public function Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
ProductBundleItem::getProduct public function Get the referenced product. Overrides BundleItemInterface::getProduct
ProductBundleItem::getProductId public function Gets the bundle item's product id. Overrides BundleItemInterface::getProductId
ProductBundleItem::getQuantity public function Gets the bundle item quantity. Overrides BundleItemInterface::getQuantity
ProductBundleItem::getTitle public function Gets the product bundle item title. Overrides BundleItemInterface::getTitle
ProductBundleItem::getUnitPrice public function Gets the price of one unit of the referenced product variations. Overrides BundleItemInterface::getUnitPrice
ProductBundleItem::getVariationIds public function Gets the variation IDs. Overrides BundleItemInterface::getVariationIds
ProductBundleItem::getVariationIndex protected function Get the index of a variation in the variation references.
ProductBundleItem::getVariations public function Gets the product variations limited by the bundle item or enabled on the product. Overrides BundleItemInterface::getVariations
ProductBundleItem::hasProduct public function Gets whether the bundle item has a product set or not. Overrides BundleItemInterface::hasProduct
ProductBundleItem::hasUnitPrice public function Check whether the bundleItem has an own unit price. Overrides BundleItemInterface::hasUnitPrice
ProductBundleItem::hasVariation protected function Whether the bundle item has a specific variation referenced.
ProductBundleItem::hasVariations public function Gets whether the bundle item has restricted variations. Overrides BundleItemInterface::hasVariations
ProductBundleItem::isRequired public function Whether the product bundle item is required or not. Overrides BundleItemInterface::isRequired
ProductBundleItem::preCreate public static function Changes the values of an entity before it is created. Overrides EntityBase::preCreate
ProductBundleItem::preSave public function Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
ProductBundleItem::removeVariation public function Removes a variation. Overrides BundleItemInterface::removeVariation
ProductBundleItem::setCreatedTime public function Sets the product bundle item creation timestamp. Overrides BundleItemInterface::setCreatedTime
ProductBundleItem::setCurrentVariation public function Gets the currently selected variation, or the default variation. Overrides BundleItemInterface::setCurrentVariation
ProductBundleItem::setMaximumQuantity public function @inheritdoc Overrides BundleItemInterface::setMaximumQuantity
ProductBundleItem::setMinimumQuantity public function @inheritdoc Overrides BundleItemInterface::setMinimumQuantity
ProductBundleItem::setOwner public function Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
ProductBundleItem::setOwnerId public function Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
ProductBundleItem::setProduct public function @inheritdoc Overrides BundleItemInterface::setProduct
ProductBundleItem::setQuantity public function Sets the quantity for the bundle item. Overrides BundleItemInterface::setQuantity
ProductBundleItem::setRequired public function Set whether the product bundle item is required or not. Overrides BundleItemInterface::setRequired
ProductBundleItem::setTitle public function Sets the product bundle item title. Overrides BundleItemInterface::setTitle
ProductBundleItem::setUnitPrice public function Sets the price of one unit of the referenced product variations. Overrides BundleItemInterface::setUnitPrice
ProductBundleItem::setVariations public function Sets the variations. Overrides BundleItemInterface::setVariations
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.