ProductAttributeValue.php in Commerce Core 8.2

Namespace

Drupal\commerce_product\Entity

File

modules/product/src/Entity/ProductAttributeValue.php

<?php

namespace Drupal\commerce_product\Entity;

use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;

/**
 * Defines the product attribute value entity class.
 *
 * @ContentEntityType(
 *   id = "commerce_product_attribute_value",
 *   label = @Translation("Product attribute value"),
 *   label_singular = @Translation("product attribute value"),
 *   label_plural = @Translation("product attribute values"),
 *   label_count = @PluralTranslation(
 *     singular = "@count product attribute value",
 *     plural = "@count product attribute values",
 *   ),
 *   bundle_label = @Translation("Product attribute"),
 *   handlers = {
 *     "event" = "Drupal\commerce_product\Event\ProductAttributeValueEvent",
 *     "storage" = "Drupal\commerce_product\ProductAttributeValueStorage",
 *     "access" = "Drupal\commerce_product\ProductAttributeValueAccessControlHandler",
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "views_data" = "Drupal\commerce\CommerceEntityViewsData",
 *     "translation" = "Drupal\content_translation\ContentTranslationHandler"
 *   },
 *   admin_permission = "administer commerce_product_attribute",
 *   translatable = TRUE,
 *   content_translation_ui_skip = TRUE,
 *   base_table = "commerce_product_attribute_value",
 *   data_table = "commerce_product_attribute_value_field_data",
 *   entity_keys = {
 *     "id" = "attribute_value_id",
 *     "bundle" = "attribute",
 *     "label" = "name",
 *     "langcode" = "langcode",
 *     "uuid" = "uuid",
 *   },
 *   bundle_entity_type = "commerce_product_attribute",
 *   field_ui_base_route = "entity.commerce_product_attribute.edit_form",
 * )
 */
class ProductAttributeValue extends ContentEntityBase implements ProductAttributeValueInterface {
  use EntityChangedTrait;

  /**
   * {@inheritdoc}
   */
  public function getAttribute() {
    $storage = $this
      ->entityTypeManager()
      ->getStorage('commerce_product_attribute');
    return $storage
      ->load($this
      ->bundle());
  }

  /**
   * {@inheritdoc}
   */
  public function getAttributeId() {
    return $this
      ->bundle();
  }

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

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);

    // Override the label for the generated bundle field.
    $fields['attribute']
      ->setLabel(t('Attribute'));
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('The attribute value name.'))
      ->setRequired(TRUE)
      ->setTranslatable(TRUE)
      ->setSettings([
      'default_value' => '',
      'max_length' => 255,
    ])
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'string',
      'weight' => -5,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => -5,
    ])
      ->setDisplayConfigurable('view', TRUE)
      ->setDisplayConfigurable('form', TRUE);
    $fields['weight'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Weight'))
      ->setDescription(t('The weight of this attribute value in relation to others.'))
      ->setDefaultValue(0);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time when the attribute value was created.'))
      ->setTranslatable(TRUE);
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time when the attribute value was last edited.'))
      ->setTranslatable(TRUE);
    return $fields;
  }

}

Classes

Name	Description
ProductAttributeValue	Defines the product attribute value entity class.