modules/XC/ProductVariants/src/Model/ProductVariant.php line 98

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2001-present X-Cart Holdings LLC. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace XC\ProductVariants\Model;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use XC\ProductVariants\API\Endpoint\ProductVariant\DTO\ProductVariantInput as Input;
  13. use XC\ProductVariants\API\Endpoint\ProductVariant\DTO\ProductVariantUpdate as Update;
  14. use XC\ProductVariants\API\Endpoint\ProductVariant\DTO\ProductVariantOutput as Output;
  15. use XC\ProductVariants\Controller\API\ProductVariant\Delete;
  16. use XC\ProductVariants\Controller\API\ProductVariant\Put;
  17. use XC\ProductVariants\Model\Product\ProductVariantsStockAvailabilityPolicy;
  18. use XLite\Model\Cart;
  20. /**
  21.  * Product variant
  22.  *
  23.  * @ORM\Entity
  24.  * @ORM\Table  (name="product_variants")
  25.  *
  26.  * @ApiPlatform\ApiResource(
  27.  *     shortName="Product Variant",
  28.  *     itemOperations={
  29.  *          "get"={
  30.  *              "method"="GET",
  31.  *              "path"="/products/{product_id}/variants/{id}.{_format}",
  32.  *              "identifiers"={"product_id", "id"},
  33.  *              "requirements"={"product_id"="\d+", "id"="\d+"},
  34.  *              "input"=Input::class,
  35.  *              "output"=Output::class,
  36.  *              "openapi_context"={
  37.  *                  "parameters"={
  38.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  39.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  40.  *                  }
  41.  *              }
  42.  *          },
  43.  *          "put"={
  44.  *              "method"="PUT",
  45.  *              "path"="/products/{product_id}/variants/{id}.{_format}",
  46.  *              "identifiers"={"product_id", "id"},
  47.  *              "requirements"={"product_id"="\d+", "id"="\d+"},
  48.  *              "controller"=Put::class,
  49.  *              "input"=Update::class,
  50.  *              "output"=Output::class,
  51.  *              "openapi_context"={
  52.  *                  "parameters"={
  53.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  54.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  55.  *                  }
  56.  *              }
  57.  *          },
  58.  *          "delete"={
  59.  *              "method"="DELETE",
  60.  *              "path"="/products/{product_id}/variants/{id}.{_format}",
  61.  *              "identifiers"={"product_id", "id"},
  62.  *              "requirements"={"product_id"="\d+", "id"="\d+"},
  63.  *              "controller"=Delete::class,
  64.  *              "input"=Input::class,
  65.  *              "output"=Output::class,
  66.  *              "openapi_context"={
  67.  *                  "parameters"={
  68.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  69.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  70.  *                  }
  71.  *              }
  72.  *          }
  73.  *     },
  74.  *     collectionOperations={
  75.  *          "get"={
  76.  *              "method"="GET",
  77.  *              "path"="/products/{product_id}/variants.{_format}",
  78.  *              "identifiers"={"product_id"},
  79.  *              "requirements"={"product_id"="\d+"},
  80.  *              "input"=Input::class,
  81.  *              "output"=Output::class,
  82.  *              "openapi_context"={
  83.  *                  "parameters"={
  84.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  85.  *                  },
  86.  *              }
  87.  *          },
  88.  *          "post"={
  89.  *              "method"="POST",
  90.  *              "path"="/products/{product_id}/variants.{_format}",
  91.  *              "controller"="xcart.api.xc.product_variants.product_variant.controller",
  92.  *              "identifiers"={"product_id"},
  93.  *              "requirements"={"product_id"="\d+"},
  94.  *              "input"=Input::class,
  95.  *              "output"=Output::class,
  96.  *              "openapi_context"={
  97.  *                  "parameters"={
  98.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  99.  *                  }
  100.  *              }
  101.  *          }
  102.  *     }
  103.  * )
  104.  */
  105. class ProductVariant extends \XLite\Model\AEntity
  106. {
  107.     /**
  108.      * Unique ID
  109.      *
  110.      * @var integer
  111.      *
  112.      * @ORM\Id
  113.      * @ORM\GeneratedValue (strategy="AUTO")
  114.      * @ORM\Column         (type="integer", options={ "unsigned": true })
  115.      */
  116.     protected $id;
  118.     /**
  119.      * Product
  120.      *
  121.      * @var \XLite\Model\Product
  122.      *
  123.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Product", inversedBy="variants")
  124.      * @ORM\JoinColumn (name="product_id", referencedColumnName="product_id", onDelete="CASCADE")
  125.      */
  126.     protected $product;
  128.     /**
  129.      * Price
  130.      *
  131.      * @var float
  132.      *
  133.      * @ORM\Column (type="decimal", precision=14, scale=4)
  134.      */
  135.     protected $price = 0.0000;
  137.     /**
  138.      * Default price flag
  139.      *
  140.      * @var boolean
  141.      *
  142.      * @ORM\Column (type="boolean")
  143.      */
  144.     protected $defaultPrice = true;
  146.     /**
  147.      * Amount
  148.      *
  149.      * @var integer
  150.      *
  151.      * @ORM\Column (type="integer", options={ "unsigned": true })
  152.      */
  153.     protected $amount = 0;
  155.     /**
  156.      * Default amount flag
  157.      *
  158.      * @var boolean
  159.      *
  160.      * @ORM\Column (type="boolean")
  161.      */
  162.     protected $defaultAmount = true;
  164.     /**
  165.      * Weight
  166.      *
  167.      * @var float
  168.      *
  169.      * @ORM\Column (type="decimal", precision=14, scale=4)
  170.      */
  172.     protected $weight = 0.0000;
  174.     /**
  175.      * Default weight flag
  176.      *
  177.      * @var boolean
  178.      *
  179.      * @ORM\Column (type="boolean")
  180.      */
  181.     protected $defaultWeight = true;
  183.     /**
  184.      * Product SKU
  185.      *
  186.      * @var string
  187.      *
  188.      * @ORM\Column (type="string", length=32, nullable=true)
  189.      */
  190.     protected $sku;
  192.     /**
  193.      * Product variant unique id
  194.      *
  195.      * @var string
  196.      *
  197.      * @ORM\Column (type="string", length=32, nullable=true)
  198.      */
  199.     protected $variant_id;
  201.     /**
  202.      * Default flag
  203.      *
  204.      * @var boolean
  205.      *
  206.      * @ORM\Column (type="boolean")
  207.      */
  208.     protected $defaultValue = false;
  210.     /**
  211.      * Image
  212.      *
  213.      * @var \XC\ProductVariants\Model\Image\ProductVariant\Image
  214.      *
  215.      * @ORM\OneToOne  (targetEntity="XC\ProductVariants\Model\Image\ProductVariant\Image", mappedBy="product_variant", cascade={"all"})
  216.      */
  217.     protected $image;
  219.     /**
  220.      * Attribute value (checkbox)
  221.      *
  222.      * @var \Doctrine\Common\Collections\Collection
  223.      *
  224.      * @ORM\ManyToMany (targetEntity="XLite\Model\AttributeValue\AttributeValueCheckbox", inversedBy="variants")
  225.      * @ORM\JoinTable (
  226.      *      name="product_variant_attribute_value_checkbox",
  227.      *      joinColumns={@ORM\JoinColumn (name="variant_id", referencedColumnName="id", onDelete="CASCADE")},
  228.      *      inverseJoinColumns={@ORM\JoinColumn (name="attribute_value_id", referencedColumnName="id", onDelete="CASCADE")}
  229.      * )
  230.      */
  231.     protected $attributeValueC;
  233.     /**
  234.      * Attribute value (select)
  235.      *
  236.      * @var \Doctrine\Common\Collections\Collection
  237.      *
  238.      * @ORM\ManyToMany (targetEntity="XLite\Model\AttributeValue\AttributeValueSelect", inversedBy="variants")
  239.      * @ORM\JoinTable (
  240.      *      name="product_variant_attribute_value_select",
  241.      *      joinColumns={@ORM\JoinColumn (name="variant_id", referencedColumnName="id", onDelete="CASCADE")},
  242.      *      inverseJoinColumns={@ORM\JoinColumn (name="attribute_value_id", referencedColumnName="id", onDelete="CASCADE")}
  243.      * )
  244.      */
  245.     protected $attributeValueS;
  247.     /**
  248.      * Product order items
  249.      *
  250.      * @var \Doctrine\ORM\PersistentCollection
  251.      *
  252.      * @ORM\OneToMany (targetEntity="XLite\Model\OrderItem", mappedBy="variant")
  253.      */
  254.     protected $orderItems;
  256.     /**
  257.      * Constructor
  258.      *
  259.      * @param array $data Entity properties OPTIONAL
  260.      */
  261.     public function __construct(array $data = [])
  262.     {
  263.         $this->attributeValueC = new \Doctrine\Common\Collections\ArrayCollection();
  264.         $this->attributeValueS = new \Doctrine\Common\Collections\ArrayCollection();
  265.         $this->orderItems = new \Doctrine\Common\Collections\ArrayCollection();
  267.         parent::__construct($data);
  268.     }
  270.     /**
  271.      * Get attribute value
  272.      *
  273.      * @param \XLite\Model\Attribute $attribute Attribute
  274.      *
  275.      * @return mixed
  276.      */
  277.     public function getAttributeValue(\XLite\Model\Attribute $attribute)
  278.     {
  279.         $result = null;
  281.         foreach ($this->getValues() as $v) {
  282.             if ($v->getAttribute()->getId() == $attribute->getId()) {
  283.                 $result = $v;
  284.                 break;
  285.             }
  286.         }
  288.         return $result;
  289.     }
  291.     /**
  292.      * Get attribute values
  293.      *
  294.      * @return array
  295.      */
  296.     public function getValues()
  297.     {
  298.         return array_merge(
  299.             $this->getAttributeValueS()->toArray(),
  300.             $this->getAttributeValueC()->toArray()
  301.         );
  302.     }
  304.     /**
  305.      * Increase / decrease product inventory amount
  306.      *
  307.      * @param integer $delta Amount delta
  308.      */
  309.     public function changeAmount($delta)
  310.     {
  311.         if (!$this->getDefaultAmount()) {
  312.             $this->setAmount($this->getAmount() + $delta);
  313.         }
  314.     }
  316.     /**
  317.      * Get attribute values hash
  318.      *
  319.      * @return string
  320.      */
  321.     public function getValuesHash()
  322.     {
  323.         $hash = [];
  324.         foreach ($this->getValues() as $av) {
  325.             $hash[] = $av->getAttribute()->getId() . '_' . $av->getId();
  326.         }
  327.         sort($hash);
  329.         return md5(implode('_', $hash));
  330.     }
  332.     /**
  333.      * Get quick data price
  334.      *
  335.      * @return float
  336.      */
  337.     public function getQuickDataPrice()
  338.     {
  339.         return $this->getClearPrice();
  340.     }
  342.     /**
  343.      * Get clear price
  344.      *
  345.      * @return float
  346.      */
  347.     public function getClearPrice()
  348.     {
  349.         return $this->getDefaultPrice()
  350.             ? $this->getProduct()->getPrice()
  351.             : $this->getPrice();
  352.     }
  354.     /**
  355.      * Get net Price
  356.      *
  357.      * @return float
  358.      */
  359.     public function getNetPrice()
  360.     {
  361.         return \XLite\Logic\Price::getInstance()->apply($this, 'getClearPrice', ['taxable'], 'net');
  362.     }
  364.     /**
  365.      * Get display Price
  366.      *
  367.      * @return float
  368.      */
  369.     public function getDisplayPrice()
  370.     {
  371.         return \XLite\Logic\Price::getInstance()->apply($this, 'getNetPrice', ['taxable'], 'display');
  372.     }
  374.     /**
  375.      * Get clear weight
  376.      *
  377.      * @return float
  378.      */
  379.     public function getClearWeight()
  380.     {
  381.         return $this->getDefaultWeight()
  382.             ? $this->getProduct()->getWeight()
  383.             : $this->getWeight();
  384.     }
  386.     /**
  387.      * Get display sku
  388.      *
  389.      * @return float
  390.      */
  391.     public function getDisplaySku()
  392.     {
  393.         return $this->getSku() ?: $this->getProduct()->getSku();
  394.     }
  396.     /**
  397.      * Get SKU
  398.      *
  399.      * @return string
  400.      */
  401.     public function getSku()
  402.     {
  403.         return $this->sku !== null ? (string)$this->sku : null;
  404.     }
  406.     /**
  407.      * Set sku and trim it to max length
  408.      *
  409.      * @param string $sku
  410.      */
  411.     public function setSku($sku)
  412.     {
  413.         $this->sku = substr($sku, 0, \XLite\Core\Database::getRepo('XC\ProductVariants\Model\ProductVariant')->getFieldInfo('sku', 'length'));
  414.     }
  416.     /**
  417.      * Return VariantId
  418.      *
  419.         @return string
  420.      */
  421.     public function getVariantId()
  422.     {
  423.         return $this->variant_id;
  424.     }
  426.     /**
  427.      * Set VariantId
  428.      *
  429.      * @param string $variant_id
  430.      *
  431.      * @return $this
  432.      */
  433.     public function setVariantId($variant_id)
  434.     {
  435.         $this->variant_id = $variant_id;
  436.         return $this;
  437.     }
  439.     /**
  440.      * Set needProcess to related product
  441.      *
  442.      * @param boolean $needProcess
  443.      *
  444.      * @return \XLite\Model\Product
  445.      */
  446.     public function setNeedProcess($needProcess)
  447.     {
  448.         if ($this->getProduct()) {
  449.             $this->getProduct()->setNeedProcess($needProcess);
  450.         }
  452.         return $this->getProduct();
  453.     }
  455.     /**
  456.      * Check if the product is out-of-stock
  457.      *
  458.      * @return boolean
  459.      */
  460.     public function isShowStockWarning()
  461.     {
  462.         return $this->getProduct()
  463.             && $this->getProduct()->getInventoryEnabled()
  464.             && $this->getProduct()->getLowLimitEnabledCustomer()
  465.             && ($this->getPublicAmount() <= $this->getProduct()->getLowLimitAmount())
  466.             && !$this->isOutOfStock();
  467.     }
  469.     /**
  470.      * Return true if product variant can be purchased
  471.      *
  472.      * @return boolean
  473.      */
  474.     public function isAvailable()
  475.     {
  476.         return $this->availableInDate()
  477.             && !$this->isOutOfStock();
  478.     }
  480.     /**
  481.      * Flag if the product is available according date/time
  482.      *
  483.      * @return boolean
  484.      */
  485.     public function availableInDate()
  486.     {
  487.         return $this->getProduct()
  488.             ? $this->getProduct()->availableInDate()
  489.             : true;
  490.     }
  492.     /**
  493.      * Alias: is product in stock or not
  494.      *
  495.      * @return boolean
  496.      */
  497.     public function isOutOfStock()
  498.     {
  499.         /** @var ProductVariantsStockAvailabilityPolicy $availabilityPolicy */
  500.         $availabilityPolicy = $this->getProduct()->getStockAvailabilityPolicy();
  502.         return !$availabilityPolicy->getAvailableVariantAmount(Cart::getInstance(), $this->getId());
  503.     }
  505.     /**
  506.      * Return public amount
  507.      *
  508.      * @return integer
  509.      */
  510.     public function getPublicAmount()
  511.     {
  512.         return $this->getDefaultAmount()
  513.             ? $this->getProduct()->getPublicAmount()
  514.             : $this->getAmount();
  515.     }
  517.     /**
  518.      * Return product amount available to add to cart
  519.      *
  520.      * @return integer
  521.      */
  522.     public function getAvailableAmount()
  523.     {
  524.         /** @var ProductVariantsStockAvailabilityPolicy $availabilityPolicy */
  525.         $availabilityPolicy = $this->getProduct()->getStockAvailabilityPolicy();
  527.         return $availabilityPolicy->getAvailableVariantAmount(Cart::getInstance(), $this->getId());
  528.     }
  530.     /**
  531.      * Return max possibly product amount available to add to cart
  532.      *
  533.      * @return integer
  534.      */
  535.     public function getMaxAmount()
  536.     {
  537.         return $this->getAvailableAmount();
  538.     }
  540.     /**
  541.      * How many product items added to cart
  542.      *
  543.      * @return boolean
  544.      */
  545.     public function getItemsInCart()
  546.     {
  547.         $availabilityPolicy = $this->getProduct()->getStockAvailabilityPolicy();
  549.         return $availabilityPolicy->getInCartVariantAmount(Cart::getInstance(), $this->getId());
  550.     }
  552.     /**
  553.      * How many product items added to cart
  554.      *
  555.      * @return boolean
  556.      */
  557.     public function getItemsInCartMessage()
  558.     {
  559.         $availabilityPolicy = $this->getProduct()->getStockAvailabilityPolicy();
  561.         $count = $availabilityPolicy->getInCartVariantAmount(Cart::getInstance(), $this->getId());
  563.         return \XLite\Core\Translation::getInstance()->translate(
  564.             'Items with selected options in your cart: X',
  565.             ['count' => $count]
  566.         );
  567.     }
  569.     /**
  570.      * Alias: is all product items in cart
  571.      *
  572.      * @return boolean
  573.      */
  574.     public function isAllStockInCart()
  575.     {
  576.         return $this->getAvailableAmount() <= $this->getItemsInCart();
  577.     }
  579.     /**
  580.      * Clone
  581.      *
  582.      * @return \XLite\Model\AEntity
  583.      */
  584.     public function cloneEntity()
  585.     {
  586.         $newEntity = parent::cloneEntity();
  588.         if ($this->getSku()) {
  589.             $newEntity->setSku(
  590.                 \XLite\Core\Database::getRepo('XC\ProductVariants\Model\ProductVariant')
  591.                     ->assembleUniqueSKU($this->getSku())
  592.             );
  593.         }
  595.         $newEntity->setVariantId(
  596.             \XLite\Core\Database::getRepo('XC\ProductVariants\Model\ProductVariant')
  597.                     ->assembleUniqueVariantId($this->getVariantId())
  598.         );
  600.         $this->cloneEntityImage($newEntity);
  602.         return $newEntity;
  603.     }
  605.     /**
  606.      * Clone entity (image)
  607.      *
  608.      * @param \XC\ProductVariants\Model\ProductVariant $newEntity New entity
  609.      */
  610.     public function cloneEntityImage(\XC\ProductVariants\Model\ProductVariant $newEntity)
  611.     {
  612.         if ($this->getImage()) {
  613.             $newImage = $this->getImage()->cloneEntity();
  614.             $newImage->setProductVariant($newEntity);
  615.             $newEntity->setImage($newImage);
  616.         }
  617.     }
  619.     /**
  620.      * Return taxable
  621.      *
  622.      * @return boolean
  623.      */
  624.     public function getTaxable()
  625.     {
  626.         return $this->getProduct()->getTaxable();
  627.     }
  629.     /**
  630.      * Check if product amount is less than its low limit
  631.      *
  632.      * @return boolean
  633.      */
  634.     public function isLowLimitReached()
  635.     {
  636.         /** @var \XLite\Model\Product $product */
  637.         $product = $this->getProduct();
  639.         return $product->getLowLimitEnabled() && $this->getPublicAmount() <= $product->getLowLimitAmount();
  640.     }
  642.     /**
  643.      * List of controllers which should not send notifications
  644.      *
  645.      * @return array
  646.      */
  647.     protected function getForbiddenControllers()
  648.     {
  649.         return [
  650.             '\XLite\Controller\Admin\EventTask',
  651.             '\XLite\Controller\Admin\ProductList',
  652.             '\XLite\Controller\Admin\Product',
  653.         ];
  654.     }
  656.     /**
  657.      * Check if notifications should be sent in current situation
  658.      *
  659.      * @return boolean
  660.      */
  661.     public function isShouldSend()
  662.     {
  663.         $currentController = \XLite::getInstance()->getController();
  664.         $isControllerForbidden = array_reduce(
  665.             $this->getForbiddenControllers(),
  666.             static function ($carry, $controllerName) use ($currentController) {
  667.                 return $carry ?: ($currentController instanceof $controllerName);
  668.             },
  669.             false
  670.         );
  671.         return
  672.             \XLite\Core\Request::getInstance()->event !== 'import'
  673.             && !$isControllerForbidden;
  674.     }
  676.     /**
  677.      * Send notification to admin about product low limit
  678.      */
  679.     public function sendLowLimitNotification()
  680.     {
  681.         \XLite\Core\Mailer::sendLowVariantLimitWarningAdmin(
  682.             $this->prepareDataForNotification()
  683.         );
  684.     }
  686.     /**
  687.      * Prepare data for 'low limit warning' email notifications
  688.      *
  689.      * @return array
  690.      */
  691.     public function prepareDataForNotification()
  692.     {
  693.         $data = [];
  695.         $product = $this->getProduct();
  697.         $data['product'] = $product;
  698.         $data['name'] = $product->getName();
  699.         $data['attributes'] = $this->prepareAttributesForEmail();
  700.         $data['sku'] = $this->getDisplaySku();
  701.         $data['amount'] = $this->getAmount();
  702.         $data['variantsTabUrl'] = $this->getUrlToVariant();
  704.         return $data;
  705.     }
  707.     /**
  708.      * Prepare attributes for view
  709.      *
  710.      * @return array
  711.      */
  712.     protected function prepareAttributesForEmail()
  713.     {
  714.         $attrs = [];
  715.         foreach ($this->getValues() as $attributeValue) {
  716.             if ($attributeValue->getAttribute()->isVariable($this->getProduct())) {
  717.                 $attrs[] = [
  718.                     'name'  => $attributeValue->getAttribute()->getName(),
  719.                     'value' => $attributeValue->asString(),
  720.                 ];
  721.             }
  722.         }
  724.         return $attrs;
  725.     }
  727.     /**
  728.      * Get url to variants tab
  729.      *
  730.      * @return string
  731.      */
  732.     protected function getUrlToVariant()
  733.     {
  734.         $params = [
  735.             'product_id' => $this->getProduct()->getProductId(),
  736.             'page'       => 'variants',
  737.         ];
  738.         $fullUrl = \XLite\Core\Converter::buildFullURL(
  739.             'product',
  740.             '',
  741.             $params,
  742.             \XLite::getAdminScript()
  743.         );
  745.         $hashForUrl = sprintf('#data-%d-amount', $this->getId());
  747.         return $fullUrl . $hashForUrl;
  748.     }
  750.     /**
  751.      * Get id
  752.      *
  753.      * @return integer
  754.      */
  755.     public function getId()
  756.     {
  757.         return $this->id;
  758.     }
  760.     /**
  761.      * Set price
  762.      *
  763.      * @param float $price
  764.      * @return ProductVariant
  765.      */
  766.     public function setPrice($price)
  767.     {
  768.         $this->price = $price;
  769.         return $this;
  770.     }
  772.     /**
  773.      * Get price
  774.      *
  775.      * @return float
  776.      */
  777.     public function getPrice()
  778.     {
  779.         return $this->price;
  780.     }
  782.     /**
  783.      * Set defaultPrice
  784.      *
  785.      * @param boolean $defaultPrice
  786.      * @return ProductVariant
  787.      */
  788.     public function setDefaultPrice($defaultPrice)
  789.     {
  790.         $this->defaultPrice = $defaultPrice;
  791.         return $this;
  792.     }
  794.     /**
  795.      * Get defaultPrice
  796.      *
  797.      * @return boolean
  798.      */
  799.     public function getDefaultPrice()
  800.     {
  801.         return $this->defaultPrice;
  802.     }
  804.     /**
  805.      * Set amount
  806.      *
  807.      * @param integer $amount
  808.      * @return ProductVariant
  809.      */
  810.     public function setAmount($amount)
  811.     {
  812.         $this->amount = $this->correctAmount($amount);
  813.         return $this;
  814.     }
  816.     /**
  817.      * Get amount
  818.      *
  819.      * @return integer
  820.      */
  821.     public function getAmount()
  822.     {
  823.         return $this->amount;
  824.     }
  826.     /**
  827.      * Set defaultAmount
  828.      *
  829.      * @param boolean $defaultAmount
  830.      * @return ProductVariant
  831.      */
  832.     public function setDefaultAmount($defaultAmount)
  833.     {
  834.         $this->defaultAmount = $defaultAmount;
  835.         return $this;
  836.     }
  838.     /**
  839.      * Get defaultAmount
  840.      *
  841.      * @return boolean
  842.      */
  843.     public function getDefaultAmount()
  844.     {
  845.         return $this->defaultAmount;
  846.     }
  848.     /**
  849.      * Set weight
  850.      *
  851.      * @param float $weight
  852.      * @return ProductVariant
  853.      */
  854.     public function setWeight($weight)
  855.     {
  856.         $this->weight = $weight;
  857.         return $this;
  858.     }
  860.     /**
  861.      * Get weight
  862.      *
  863.      * @return float
  864.      */
  865.     public function getWeight()
  866.     {
  867.         return $this->weight;
  868.     }
  870.     /**
  871.      * Set defaultWeight
  872.      *
  873.      * @param boolean $defaultWeight
  874.      * @return ProductVariant
  875.      */
  876.     public function setDefaultWeight($defaultWeight)
  877.     {
  878.         $this->defaultWeight = $defaultWeight;
  879.         return $this;
  880.     }
  882.     /**
  883.      * Get defaultWeight
  884.      *
  885.      * @return boolean
  886.      */
  887.     public function getDefaultWeight()
  888.     {
  889.         return $this->defaultWeight;
  890.     }
  892.     /**
  893.      * Set defaultValue
  894.      *
  895.      * @param boolean $defaultValue
  896.      * @return ProductVariant
  897.      */
  898.     public function setDefaultValue($defaultValue)
  899.     {
  900.         $this->defaultValue = $defaultValue;
  901.         return $this;
  902.     }
  904.     /**
  905.      * Get defaultValue
  906.      *
  907.      * @return boolean
  908.      */
  909.     public function getDefaultValue()
  910.     {
  911.         return $this->defaultValue;
  912.     }
  914.     /**
  915.      * Set product
  916.      *
  917.      * @param \XLite\Model\Product $product
  918.      * @return ProductVariant
  919.      */
  920.     public function setProduct(\XLite\Model\Product $product = null)
  921.     {
  922.         $this->product = $product;
  923.         return $this;
  924.     }
  926.     /**
  927.      * Get product
  928.      *
  929.      * @return \XLite\Model\Product
  930.      */
  931.     public function getProduct()
  932.     {
  933.         return $this->product;
  934.     }
  936.     /**
  937.      * Set image
  938.      *
  939.      * @param \XC\ProductVariants\Model\Image\ProductVariant\Image $image
  940.      * @return ProductVariant
  941.      */
  942.     public function setImage(\XC\ProductVariants\Model\Image\ProductVariant\Image $image = null)
  943.     {
  944.         $this->image = $image;
  945.         return $this;
  946.     }
  948.     /**
  949.      * Get image
  950.      *
  951.      * @return \XC\ProductVariants\Model\Image\ProductVariant\Image
  952.      */
  953.     public function getImage()
  954.     {
  955.         return $this->image;
  956.     }
  958.     /**
  959.      * Add attributeValueC
  960.      *
  961.      * @param \XLite\Model\AttributeValue\AttributeValueCheckbox $attributeValueC
  962.      * @return ProductVariant
  963.      */
  964.     public function addAttributeValueC(\XLite\Model\AttributeValue\AttributeValueCheckbox $attributeValueC)
  965.     {
  966.         $this->attributeValueC[] = $attributeValueC;
  967.         return $this;
  968.     }
  970.     /**
  971.      * Get attributeValueC
  972.      *
  973.      * @return \Doctrine\Common\Collections\Collection
  974.      */
  975.     public function getAttributeValueC()
  976.     {
  977.         return $this->attributeValueC;
  978.     }
  980.     /**
  981.      * Add attributeValueS
  982.      *
  983.      * @param \XLite\Model\AttributeValue\AttributeValueSelect $attributeValueS
  984.      * @return ProductVariant
  985.      */
  986.     public function addAttributeValueS(\XLite\Model\AttributeValue\AttributeValueSelect $attributeValueS)
  987.     {
  988.         $this->attributeValueS[] = $attributeValueS;
  989.         return $this;
  990.     }
  992.     /**
  993.      * Get attributeValueS
  994.      *
  995.      * @return \Doctrine\Common\Collections\Collection
  996.      */
  997.     public function getAttributeValueS()
  998.     {
  999.         return $this->attributeValueS;
  1000.     }
  1002.     /**
  1003.      * Add orderItems
  1004.      *
  1005.      * @param \XLite\Model\OrderItem $orderItems
  1006.      * @return ProductVariant
  1007.      */
  1008.     public function addOrderItems(\XLite\Model\OrderItem $orderItems)
  1009.     {
  1010.         $this->orderItems[] = $orderItems;
  1011.         return $this;
  1012.     }
  1014.     /**
  1015.      * Get orderItems
  1016.      *
  1017.      * @return \Doctrine\Common\Collections\Collection
  1018.      */
  1019.     public function getOrderItems()
  1020.     {
  1021.         return $this->orderItems;
  1022.     }
  1024.     /**
  1025.      * Check and (if needed) correct amount value
  1026.      *
  1027.      * @param integer $amount Value to check
  1028.      *
  1029.      * @return integer
  1030.      */
  1031.     protected function correctAmount($amount)
  1032.     {
  1033.         return max(0, (int) $amount);
  1034.     }
  1035. }