modules/CDev/VolumeDiscounts/src/Model/VolumeDiscount.php line 62

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2011-present Qualiteam software Ltd. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace CDev\VolumeDiscounts\Model;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use CDev\VolumeDiscounts\API\Endpoint\VolumeDiscount\DTO\VolumeDiscountInput;
  12. use CDev\VolumeDiscounts\API\Endpoint\VolumeDiscount\DTO\VolumeDiscountOutput;
  13. use CDev\VolumeDiscounts\Logic\Order\Modifier\Discount;
  14. use Doctrine\ORM\Mapping as ORM;
  15. use XLite\Core\Database;
  16. use XLite\Model\Membership;
  17. use XLite\Model\Zone;
  18. use XLite\View\FormField\Input\PriceOrPercent;
  19. use XLite\View\FormField\Select\AbsoluteOrPercent;
  21. /**
  22.  * Volume discount model
  23.  *
  24.  * @ORM\Entity
  25.  * @ORM\Table  (name="volume_discounts",
  26.  *      indexes={
  27.  *          @ORM\Index (name="date_range", columns={"dateRangeBegin","dateRangeEnd"}),
  28.  *          @ORM\Index (name="subtotal", columns={"subtotalRangeBegin"}),
  29.  *      }
  30.  * )
  31.  * @ApiPlatform\ApiResource(
  32.  *     shortName="Volume Discount",
  33.  *     input=VolumeDiscountInput::class,
  34.  *     output=VolumeDiscountOutput::class,
  35.  *     itemOperations={
  36.  *          "get"={
  37.  *              "method"="GET",
  38.  *              "path"="/volume_discounts/{id}.{_format}",
  39.  *              "identifiers"={"id"},
  40.  *              "requirements"={"id"="\d+"}
  41.  *          },
  42.  *          "put"={
  43.  *              "method"="PUT",
  44.  *              "path"="/volume_discounts/{id}.{_format}",
  45.  *              "identifiers"={"id"},
  46.  *              "requirements"={"id"="\d+"}
  47.  *          },
  48.  *          "delete"={
  49.  *              "method"="DELETE",
  50.  *              "path"="/volume_discounts/{id}.{_format}",
  51.  *              "identifiers"={"id"},
  52.  *              "requirements"={"id"="\d+"}
  53.  *          }
  54.  *     },
  55.  *     collectionOperations={
  56.  *          "get"={
  57.  *              "method"="GET",
  58.  *              "identifiers"={},
  59.  *              "path"="/volume_discounts.{_format}"
  60.  *          },
  61.  *          "post"={
  62.  *              "method"="POST",
  63.  *              "identifiers"={},
  64.  *              "path"="/volume_discounts.{_format}"
  65.  *          }
  66.  *     }
  67.  * )
  68.  */
  69. class VolumeDiscount extends \XLite\Model\AEntity
  70. {
  71.     public const TYPE_PERCENT  = '%';
  72.     public const TYPE_ABSOLUTE = '$';
  75.     /**
  76.      * Discount unique ID
  77.      *
  78.      * @var   integer
  79.      *
  80.      * @ORM\Id
  81.      * @ORM\GeneratedValue (strategy="AUTO")
  82.      * @ORM\Column         (type="integer", options={ "unsigned": true })
  83.      */
  84.     protected $id;
  86.     /**
  87.      * Value
  88.      *
  89.      * @var   float
  90.      *
  91.      * @ORM\Column (type="decimal", precision=14, scale=4)
  92.      */
  93.     protected $value = 0.0000;
  95.     /**
  96.      * Type
  97.      *
  98.      * @var   string
  99.      *
  100.      * @ORM\Column (type="string", options={ "fixed": true }, length=1)
  101.      */
  102.     protected $type = self::TYPE_PERCENT;
  104.     /**
  105.      * Subtotal range (begin)
  106.      *
  107.      * @var   float
  108.      *
  109.      * @ORM\Column (type="decimal", precision=14, scale=4)
  110.      */
  111.     protected $subtotalRangeBegin = 0;
  113.     /**
  114.      * Membership
  115.      *
  116.      * @var   \XLite\Model\Membership
  117.      *
  118.      * @ORM\ManyToOne (targetEntity="XLite\Model\Membership")
  119.      * @ORM\JoinColumn (name="membership_id", referencedColumnName="membership_id", onDelete="CASCADE")
  120.      */
  121.     protected $membership;
  123.     /**
  124.      * Zones
  125.      *
  126.      * @var   \Doctrine\Common\Collections\ArrayCollection
  127.      *
  128.      * @ORM\ManyToMany (targetEntity="XLite\Model\Zone", inversedBy="volumeDiscounts")
  129.      * @ORM\JoinTable (name="zones_volume_discounts",
  130.      *      joinColumns={@ORM\JoinColumn (name="volume_discount_id", referencedColumnName="id", onDelete="CASCADE")},
  131.      *      inverseJoinColumns={@ORM\JoinColumn (name="zone_id", referencedColumnName="zone_id", onDelete="CASCADE")}
  132.      * )
  133.      */
  134.     protected $zones;
  136.     /**
  137.      * Date range (begin)
  138.      *
  139.      * @var   integer
  140.      *
  141.      * @ORM\Column (type="integer", options={ "unsigned": true })
  142.      */
  143.     protected $dateRangeBegin = 0;
  145.     /**
  146.      * Date range (end)
  147.      *
  148.      * @var   integer
  149.      *
  150.      * @ORM\Column (type="integer", options={ "unsigned": true })
  151.      */
  152.     protected $dateRangeEnd = 0;
  154.     /**
  155.      * Constructor
  156.      *
  157.      * @param array $data Entity properties OPTIONAL
  158.      */
  159.     public function __construct(array $data = [])
  160.     {
  161.         $this->zones = new \Doctrine\Common\Collections\ArrayCollection();
  163.         parent::__construct($data);
  164.     }
  166.     /**
  167.      * Returns handling fee
  168.      *
  169.      * @return array
  170.      */
  171.     public function getDiscount()
  172.     {
  173.         return [
  174.             PriceOrPercent::PRICE_VALUE => $this->getValue(),
  175.             PriceOrPercent::TYPE_VALUE  => $this->getType() === static::TYPE_PERCENT
  176.                 ? AbsoluteOrPercent::TYPE_PERCENT
  177.                 : AbsoluteOrPercent::TYPE_ABSOLUTE
  178.         ];
  179.     }
  181.     /**
  182.      * Set Discount
  183.      *
  184.      * @param array $Discount
  185.      * @return VolumeDiscount
  186.      */
  187.     public function setDiscount($Discount): VolumeDiscount
  188.     {
  189.         $this->setValue(
  190.             $Discount[PriceOrPercent::PRICE_VALUE] ?? 0
  191.         );
  193.         $this->setType(
  194.             isset($Discount[PriceOrPercent::TYPE_VALUE])
  195.             && $Discount[PriceOrPercent::TYPE_VALUE] === AbsoluteOrPercent::TYPE_PERCENT
  196.                 ? static::TYPE_PERCENT
  197.                 : static::TYPE_ABSOLUTE
  198.         );
  200.         return $this;
  201.     }
  203.     /**
  204.      * Check - discount is absolute or not
  205.      *
  206.      * @return boolean
  207.      */
  208.     public function isAbsolute()
  209.     {
  210.         return $this->getType() === static::TYPE_ABSOLUTE;
  211.     }
  213.     /**
  214.      * Get discount amount
  215.      *
  216.      * @param \XLite\Model\Order $order Order
  217.      *
  218.      * @return float
  219.      */
  220.     public function getAmount(\XLite\Model\Order $order)
  221.     {
  222.         $subTotal = $order->getSubtotal();
  224.         /** @var \XLite\Model\Order\Surcharge $surcharge */
  225.         foreach ($order->getSurchargesByType(\XLite\Model\Base\Surcharge::TYPE_DISCOUNT) as $surcharge) {
  226.             if (
  227.                 $surcharge->getAvailable()
  228.                 && !$surcharge->getInclude()
  229.                 && $surcharge->getCode() !== Discount::MODIFIER_CODE
  230.             ) {
  231.                 $subTotal += $order->getCurrency()->roundValue($surcharge->getValue());
  232.             }
  233.         }
  235.         $discount = $this->isAbsolute()
  236.             ? $this->getValue()
  237.             : ($subTotal * $this->getValue() / 100);
  239.         return min($discount, $subTotal);
  240.     }
  242.     /**
  243.      * Get id
  244.      *
  245.      * @return integer
  246.      */
  247.     public function getId()
  248.     {
  249.         return $this->id;
  250.     }
  252.     /**
  253.      * Set value
  254.      *
  255.      * @param float $value
  256.      * @return VolumeDiscount
  257.      */
  258.     public function setValue($value)
  259.     {
  260.         $this->value = $value;
  261.         return $this;
  262.     }
  264.     /**
  265.      * Get value
  266.      *
  267.      * @return float
  268.      */
  269.     public function getValue()
  270.     {
  271.         return $this->value;
  272.     }
  274.     /**
  275.      * Set type
  276.      *
  277.      * @param string $type
  278.      * @return VolumeDiscount
  279.      */
  280.     public function setType($type)
  281.     {
  282.         $this->type = $type;
  283.         return $this;
  284.     }
  286.     /**
  287.      * Get type
  288.      *
  289.      * @return string
  290.      */
  291.     public function getType()
  292.     {
  293.         return $this->type;
  294.     }
  296.     /**
  297.      * Set subtotalRangeBegin
  298.      *
  299.      * @param float $subtotalRangeBegin
  300.      * @return VolumeDiscount
  301.      */
  302.     public function setSubtotalRangeBegin($subtotalRangeBegin)
  303.     {
  304.         $this->subtotalRangeBegin = $subtotalRangeBegin;
  305.         return $this;
  306.     }
  308.     /**
  309.      * Get subtotalRangeBegin
  310.      *
  311.      * @return float
  312.      */
  313.     public function getSubtotalRangeBegin()
  314.     {
  315.         return $this->subtotalRangeBegin;
  316.     }
  318.     /**
  319.      * Set dateRangeBegin
  320.      *
  321.      * @param integer $dateRangeBegin
  322.      * @return VolumeDiscount
  323.      */
  324.     public function setDateRangeBegin($dateRangeBegin)
  325.     {
  326.         $this->dateRangeBegin = $dateRangeBegin;
  327.         return $this;
  328.     }
  330.     /**
  331.      * Get dateRangeBegin
  332.      *
  333.      * @return integer
  334.      */
  335.     public function getDateRangeBegin()
  336.     {
  337.         return $this->dateRangeBegin;
  338.     }
  340.     /**
  341.      * Set dateRangeEnd
  342.      *
  343.      * @param integer $dateRangeEnd
  344.      * @return VolumeDiscount
  345.      */
  346.     public function setDateRangeEnd($dateRangeEnd)
  347.     {
  348.         $this->dateRangeEnd = $dateRangeEnd;
  349.         return $this;
  350.     }
  352.     /**
  353.      * Get dateRangeEnd
  354.      *
  355.      * @return integer
  356.      */
  357.     public function getDateRangeEnd()
  358.     {
  359.         return $this->dateRangeEnd;
  360.     }
  362.     /**
  363.      * Get real dateRangeEnd ()
  364.      *
  365.      * @return integer
  366.      */
  367.     public function getRealDateRangeEnd()
  368.     {
  369.         return $this->dateRangeEnd == 0
  370.             ? PHP_INT_MAX
  371.             : $this->dateRangeEnd;
  372.     }
  374.     /**
  375.      * Add zone
  376.      *
  377.      * @param Zone $zone
  378.      *
  379.      * @return VolumeDiscount
  380.      */
  381.     public function addZone(Zone $zone)
  382.     {
  383.         $this->zones[] = $zone;
  384.         return $this;
  385.     }
  387.     /**
  388.      * Get zones
  389.      *
  390.      * @return \Doctrine\Common\Collections\Collection
  391.      */
  392.     public function getZones()
  393.     {
  394.         return $this->zones;
  395.     }
  397.     /**
  398.      * Clear zones
  399.      */
  400.     public function clearZones(): void
  401.     {
  402.         if ($this->getZones()) {
  403.             $this->getZones()->clear();
  404.         }
  405.     }
  407.     /**
  408.      * Set membership
  409.      *
  410.      * @param string|null|Membership $membership
  411.      * @return VolumeDiscount
  412.      */
  413.     public function setMembership($membership)
  414.     {
  415.         if (is_string($membership)) {
  416.             $this->membership = Database::getRepo(Membership::class)->find($membership);
  417.             return $this;
  418.         }
  420.         $this->membership = $membership;
  421.         return $this;
  422.     }
  424.     /**
  425.      * Get membership
  426.      *
  427.      * @return Membership|null
  428.      */
  429.     public function getMembership(): ?Membership
  430.     {
  431.         return $this->membership;
  432.     }
  434.     /**
  435.      * Check - volume discount is expired or not
  436.      *
  437.      * @return boolean
  438.      */
  439.     public function isExpired(): bool
  440.     {
  441.         return 0 < $this->getDateRangeEnd() && $this->getDateRangeEnd() < \XLite\Core\Converter::time();
  442.     }
  443. }