vendor/sylius/sylius/src/Sylius/Component/Core/Model/ProductVariant.php line 23

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Sylius package.
  5.  *
  6.  * (c) Paweł Jędrzejewski
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace Sylius\Component\Core\Model;
  16. use Doctrine\Common\Collections\ArrayCollection;
  17. use Doctrine\Common\Collections\Collection;
  18. use Doctrine\Common\Comparable;
  19. use Sylius\Component\Product\Model\ProductVariant as BaseVariant;
  20. use Sylius\Component\Shipping\Model\ShippingCategoryInterface;
  21. use Sylius\Component\Taxation\Model\TaxCategoryInterface;
  23. class ProductVariant extends BaseVariant implements ProductVariantInterface, Comparable, \Stringable
  24. {
  25.     /** @var int */
  26.     protected $version = 1;
  28.     /** @var int */
  29.     protected $onHold = 0;
  31.     /** @var int */
  32.     protected $onHand = 0;
  34.     /** @var bool */
  35.     protected $tracked = false;
  37.     /** @var float|null */
  38.     protected $weight;
  40.     /** @var float|null */
  41.     protected $width;
  43.     /** @var float|null */
  44.     protected $height;
  46.     /** @var float|null */
  47.     protected $depth;
  49.     /** @var TaxCategoryInterface|null */
  50.     protected $taxCategory;
  52.     /** @var ShippingCategoryInterface|null */
  53.     protected $shippingCategory;
  55.     /** @var Collection */
  56.     protected $channelPricings;
  58.     /** @var bool */
  59.     protected $shippingRequired = true;
  61.     /**
  62.      * @var Collection|ProductImageInterface[]
  63.      *
  64.      * @psalm-var Collection<array-key, ProductImageInterface>
  65.      */
  66.     protected $images;
  68.     public function __construct()
  69.     {
  70.         parent::__construct();
  72.         /** @var ArrayCollection<array-key, ChannelPricingInterface> $this->channelPricings */
  73.         $this->channelPricings = new ArrayCollection();
  75.         /** @var ArrayCollection<array-key, ProductImageInterface> $this->images */
  76.         $this->images = new ArrayCollection();
  77.     }
  79.     public function __toString(): string
  80.     {
  81.         $string = (string) $this->getProduct()->getName();
  83.         if (!$this->getOptionValues()->isEmpty()) {
  84.             $string .= '(';
  86.             foreach ($this->getOptionValues() as $option) {
  87.                 $string .= $option->getOption()->getName() . ': ' . $option->getValue() . ', ';
  88.             }
  90.             $string = substr($string, 0, -2) . ')';
  91.         }
  93.         return $string;
  94.     }
  96.     public function getVersion(): ?int
  97.     {
  98.         return $this->version;
  99.     }
  101.     public function setVersion(?int $version): void
  102.     {
  103.         $this->version = $version;
  104.     }
  106.     public function isInStock(): bool
  107.     {
  108.         return 0 < $this->onHand;
  109.     }
  111.     public function getOnHold(): ?int
  112.     {
  113.         return $this->onHold;
  114.     }
  116.     public function setOnHold(?int $onHold): void
  117.     {
  118.         $this->onHold = $onHold;
  119.     }
  121.     public function getOnHand(): ?int
  122.     {
  123.         return $this->onHand;
  124.     }
  126.     public function setOnHand(?int $onHand): void
  127.     {
  128.         $this->onHand = (0 > $onHand) ? 0 : $onHand;
  129.     }
  131.     public function isTracked(): bool
  132.     {
  133.         return $this->tracked;
  134.     }
  136.     public function setTracked(bool $tracked): void
  137.     {
  138.         $this->tracked = $tracked;
  139.     }
  141.     public function getInventoryName(): ?string
  142.     {
  143.         return $this->getProduct()->getName();
  144.     }
  146.     public function getShippingCategory(): ?ShippingCategoryInterface
  147.     {
  148.         return $this->shippingCategory;
  149.     }
  151.     public function setShippingCategory(?ShippingCategoryInterface $shippingCategory): void
  152.     {
  153.         $this->shippingCategory = $shippingCategory;
  154.     }
  156.     public function getWeight(): ?float
  157.     {
  158.         return $this->weight;
  159.     }
  161.     public function setWeight(?float $weight): void
  162.     {
  163.         $this->weight = $weight;
  164.     }
  166.     public function getWidth(): ?float
  167.     {
  168.         return $this->width;
  169.     }
  171.     public function setWidth(?float $width): void
  172.     {
  173.         $this->width = $width;
  174.     }
  176.     public function getHeight(): ?float
  177.     {
  178.         return $this->height;
  179.     }
  181.     public function setHeight(?float $height): void
  182.     {
  183.         $this->height = $height;
  184.     }
  186.     public function getDepth(): ?float
  187.     {
  188.         return $this->depth;
  189.     }
  191.     public function setDepth(?float $depth): void
  192.     {
  193.         $this->depth = $depth;
  194.     }
  196.     public function getShippingWeight(): ?float
  197.     {
  198.         return $this->getWeight();
  199.     }
  201.     public function getShippingWidth(): ?float
  202.     {
  203.         return $this->getWidth();
  204.     }
  206.     public function getShippingHeight(): ?float
  207.     {
  208.         return $this->getHeight();
  209.     }
  211.     public function getShippingDepth(): ?float
  212.     {
  213.         return $this->getDepth();
  214.     }
  216.     public function getShippingVolume(): ?float
  217.     {
  218.         return $this->depth * $this->height * $this->width;
  219.     }
  221.     public function getTaxCategory(): ?TaxCategoryInterface
  222.     {
  223.         return $this->taxCategory;
  224.     }
  226.     public function setTaxCategory(?TaxCategoryInterface $category): void
  227.     {
  228.         $this->taxCategory = $category;
  229.     }
  231.     public function getChannelPricings(): Collection
  232.     {
  233.         return $this->channelPricings;
  234.     }
  236.     public function getChannelPricingForChannel(ChannelInterface $channel): ?ChannelPricingInterface
  237.     {
  238.         if ($this->channelPricings->containsKey($channel->getCode())) {
  239.             return $this->channelPricings->get($channel->getCode());
  240.         }
  242.         return null;
  243.     }
  245.     public function hasChannelPricingForChannel(ChannelInterface $channel): bool
  246.     {
  247.         return null !== $this->getChannelPricingForChannel($channel);
  248.     }
  250.     public function hasChannelPricing(ChannelPricingInterface $channelPricing): bool
  251.     {
  252.         return $this->channelPricings->contains($channelPricing);
  253.     }
  255.     public function addChannelPricing(ChannelPricingInterface $channelPricing): void
  256.     {
  257.         if (!$this->hasChannelPricing($channelPricing)) {
  258.             $channelPricing->setProductVariant($this);
  259.             $this->channelPricings->set($channelPricing->getChannelCode(), $channelPricing);
  260.         }
  261.     }
  263.     public function removeChannelPricing(ChannelPricingInterface $channelPricing): void
  264.     {
  265.         if ($this->hasChannelPricing($channelPricing)) {
  266.             $channelPricing->setProductVariant(null);
  267.             $this->channelPricings->remove($channelPricing->getChannelCode());
  268.         }
  269.     }
  271.     public function isShippingRequired(): bool
  272.     {
  273.         return $this->shippingRequired;
  274.     }
  276.     public function setShippingRequired(bool $shippingRequired): void
  277.     {
  278.         $this->shippingRequired = $shippingRequired;
  279.     }
  281.     public function getAppliedPromotionsForChannel(ChannelInterface $channel): Collection
  282.     {
  283.         $channelPricing = $this->getChannelPricingForChannel($channel);
  285.         return ($channelPricing !== null) ? $channelPricing->getAppliedPromotions() : new ArrayCollection();
  286.     }
  288.     /**
  289.      * @psalm-suppress InvalidReturnType https://github.com/doctrine/collections/pull/220
  290.      * @psalm-suppress InvalidReturnStatement https://github.com/doctrine/collections/pull/220
  291.      */
  292.     public function getImages(): Collection
  293.     {
  294.         return $this->images;
  295.     }
  297.     /**
  298.      * @psalm-suppress InvalidReturnType https://github.com/doctrine/collections/pull/220
  299.      * @psalm-suppress InvalidReturnStatement https://github.com/doctrine/collections/pull/220
  300.      */
  301.     public function getImagesByType(string $type): Collection
  302.     {
  303.         return $this->images->filter(function (ProductImageInterface $image) use ($type): bool {
  304.             return $type === $image->getType();
  305.         });
  306.     }
  308.     public function hasImages(): bool
  309.     {
  310.         return !$this->images->isEmpty();
  311.     }
  313.     public function hasImage(ProductImageInterface $image): bool
  314.     {
  315.         return $this->images->contains($image);
  316.     }
  318.     public function addImage(ProductImageInterface $image): void
  319.     {
  320.         if ($this->hasImage($image)) {
  321.             return;
  322.         }
  323.         $image->setOwner($this->getProduct());
  324.         $image->addProductVariant($this);
  325.         $this->images->add($image);
  326.     }
  328.     public function removeImage(ProductImageInterface $image): void
  329.     {
  330.         if ($this->hasImage($image)) {
  331.             $this->images->removeElement($image);
  332.         }
  333.     }
  335.     public function compareTo($other): int
  336.     {
  337.         return $this->code === $other->getCode() ? 0 : 1;
  338.     }
  339. }