modules/QSL/LoyaltyProgram/src/Model/RewardHistoryEvent.php line 18

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 QSL\LoyaltyProgram\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * Reward History event.
  14.  *
  15.  * @ORM\Entity
  16.  * @ORM\Table (name="reward_history_events")
  17.  */
  18. class RewardHistoryEvent extends \XLite\Model\AEntity
  19. {
  20.     /**
  21.      * Event reasons.
  22.      */
  23.     public const EVENT_REASON_ORDER_REWARD    = 'order';
  24.     public const EVENT_REASON_CANCELED_REWARD = 'refund';
  25.     public const EVENT_REASON_REDEEMED_POINTS = 'redeem';
  26.     public const EVENT_REASON_RETURNED_POINTS = 'unredeem';
  27.     public const EVENT_REASON_CUSTOM          = 'custom';
  28.     public const EVENT_REASON_IMPORT          = 'import';
  29.     public const EVENT_REASON_SIGNUP_REWARD   = 'signup';
  30.     public const EVENT_REASON_REVIEW_REWARD   = 'review';
  31.     public const EVENT_REASON_RATING_REWARD   = 'rating';
  32.     public const EVENT_REASON_CANCELED_REVIEW = '-review';
  33.     public const EVENT_REASON_CANCELED_RATING = '-rating';
  35.     /**
  36.      * User-friendly descriptions of event reasons.
  37.      *
  38.      * @var array
  39.      */
  40.     protected static $reasonDescriptions = [
  41.         self::EVENT_REASON_ORDER_REWARD    => 'Reward for purchasing products in order {{order}}',
  42.         self::EVENT_REASON_CANCELED_REWARD => 'Cancel reward for not finished order {{order}}',
  43.         self::EVENT_REASON_REDEEMED_POINTS => 'Use to checkout order {{order}}',
  44.         self::EVENT_REASON_RETURNED_POINTS => 'Return reward points redeemed for not finished order {{order}}',
  45.         self::EVENT_REASON_CUSTOM          => 'Reward points adjusted by the store administrator',
  46.         self::EVENT_REASON_IMPORT          => 'Reward points adjusted by a store administration script',
  47.         self::EVENT_REASON_SIGNUP_REWARD   => 'Reward for creating a store account',
  48.         self::EVENT_REASON_REVIEW_REWARD   => 'Reward for reviewing a product',
  49.         self::EVENT_REASON_RATING_REWARD   => 'Reward for rating a product',
  50.         self::EVENT_REASON_CANCELED_REVIEW => 'Canceled reward for reviewing a product',
  51.         self::EVENT_REASON_CANCELED_RATING => 'Canceled reward for rating a product',
  52.     ];
  54.     /**
  55.      * Event unique ID.
  56.      *
  57.      * @var mixed
  58.      *
  59.      * @ORM\Id
  60.      * @ORM\GeneratedValue (strategy="AUTO")
  61.      * @ORM\Column         (type="integer")
  62.      */
  63.     protected $event_id;
  65.     /**
  66.      * Event creation timestamp.
  67.      *
  68.      * @var integer
  69.      *
  70.      * @ORM\Column (type="integer")
  71.      */
  72.     protected $date;
  74.     /**
  75.      * Reward points awarded to the user.
  76.      *
  77.      * @var integer
  78.      *
  79.      * @ORM\Column (type="integer")
  80.      */
  81.     protected $points;
  83.     /**
  84.      * Reason for the event.
  85.      *
  86.      * @var string
  87.      *
  88.      * @ORM\Column (type="string", length=255)
  89.      */
  90.     protected $reason;
  92.     /**
  93.      * Event comment.
  94.      *
  95.      * @var string
  96.      *
  97.      * @ORM\Column (type="text")
  98.      */
  99.     protected $comment = '';
  101.     /**
  102.      * User that the event happened for.
  103.      *
  104.      * @var \XLite\Model\Profile
  105.      *
  106.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Profile", inversedBy="rewardEvents", cascade={"merge", "detach"})
  107.      * @ORM\JoinColumn (name="user_id", referencedColumnName="profile_id", nullable=true, onDelete="CASCADE")
  108.      */
  109.     protected $user;
  111.     /**
  112.      * User that initiated the event.
  113.      *
  114.      * @var \XLite\Model\Profile
  115.      *
  116.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Profile", inversedBy="initiatedRewardEvents", cascade={"merge", "detach"})
  117.      * @ORM\JoinColumn (name="initiator_id", referencedColumnName="profile_id", nullable=true, onDelete="CASCADE")
  118.      */
  119.     protected $initiator;
  121.     /**
  122.      * Relation to a order entity.
  123.      *
  124.      * @var \XLite\Model\Order
  125.      *
  126.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Order", inversedBy="rewardEvents", cascade={"merge", "detach"})
  127.      * @ORM\JoinColumn (name="order_id", referencedColumnName="order_id", nullable=true, onDelete="CASCADE")
  128.      */
  129.     protected $order = null;
  131.     /**
  132.      * Get public notes for the event (either the admin's comments, or the event reason explained).
  133.      *
  134.      * @return string
  135.      */
  136.     public function getNotes()
  137.     {
  138.         $comment = $this->getComment();
  139.         $notes   = $comment ?: $this->getReasonDescription();
  141.         $orderNumber = $this->getOrder() ? ('#' . $this->getOrder()->getOrderNumber()) : '';
  143.         return $this->t($notes, ['order' => $orderNumber]);
  144.     }
  146.     /**
  147.      * Return a user-friendly description of the event reason.
  148.      *
  149.      * @return string
  150.      */
  151.     public function getReasonDescription()
  152.     {
  153.         return static::$reasonDescriptions[$this->getReason()] ?? '';
  154.     }
  156.     /**
  157.      * Returns the event identifier.
  158.      *
  159.      * @return integer
  160.      */
  161.     public function getEventId()
  162.     {
  163.         return $this->event_id;
  164.     }
  166.     /**
  167.      * Returns the event date.
  168.      *
  169.      * @return integer
  170.      */
  171.     public function getDate()
  172.     {
  173.         return $this->date;
  174.     }
  176.     /**
  177.      * Sets the event date.
  178.      *
  179.      * @param integer $date Timestamp
  180.      *
  181.      * @return RewardHistoryEvent
  182.      */
  183.     public function setDate($date)
  184.     {
  185.         $this->date = $date;
  187.         return $this;
  188.     }
  190.     /**
  191.      * Returns the number of points for the event.
  192.      *
  193.      * @return integer
  194.      */
  195.     public function getPoints()
  196.     {
  197.         return $this->points;
  198.     }
  200.     /**
  201.      * Sets the number of reward points for the event.
  202.      *
  203.      * @param integer $points Number of points
  204.      *
  205.      * @return RewardHistoryEvent
  206.      */
  207.     public function setPoints($points)
  208.     {
  209.         $this->points = $points;
  211.         return $this;
  212.     }
  214.     /**
  215.      * Returns the event reason.
  216.      *
  217.      * @return string
  218.      */
  219.     public function getReason()
  220.     {
  221.         return $this->reason;
  222.     }
  224.     /**
  225.      * Sets the event reason.
  226.      *
  227.      * @param string $reason Short description
  228.      *
  229.      * @return RewardHistoryEvent
  230.      */
  231.     public function setReason($reason)
  232.     {
  233.         $this->reason = $reason;
  235.         return $this;
  236.     }
  238.     /**
  239.      * Returns the event comment.
  240.      *
  241.      * @return string
  242.      */
  243.     public function getComment()
  244.     {
  245.         return $this->comment;
  246.     }
  248.     /**
  249.      * Sets comments for the event.
  250.      *
  251.      * @param string $comment Short text
  252.      *
  253.      * @return RewardHistoryEvent
  254.      */
  255.     public function setComment($comment)
  256.     {
  257.         $this->comment = $comment;
  259.         return $this;
  260.     }
  262.     /**
  263.      * Returns the user profile associated with the event.
  264.      *
  265.      * @return \XLite\Model\Profile
  266.      */
  267.     public function getUser()
  268.     {
  269.         return $this->user;
  270.     }
  272.     /**
  273.      * Associates a user profile with the event.
  274.      *
  275.      * @param \XLite\Model\Profile $user User profile
  276.      *
  277.      * @return RewardHistoryEvent
  278.      */
  279.     public function setUser(\XLite\Model\Profile $user = null)
  280.     {
  281.         $this->user = $user;
  283.         return $this;
  284.     }
  286.     /**
  287.      * Returns the profile for the user who initiated the event.
  288.      *
  289.      * @return \XLite\Model\Profile
  290.      */
  291.     public function getInitiator()
  292.     {
  293.         return $this->initiator;
  294.     }
  296.     /**
  297.      * Associates the event with the user who initiated the event.
  298.      *
  299.      * @param \XLite\Model\Profile $initiator User profile
  300.      *
  301.      * @return RewardHistoryEvent
  302.      */
  303.     public function setInitiator(\XLite\Model\Profile $initiator = null)
  304.     {
  305.         $this->initiator = $initiator;
  307.         return $this;
  308.     }
  310.     /**
  311.      * Returns the order for the event.
  312.      *
  313.      * @return \XLite\Model\Order
  314.      */
  315.     public function getOrder()
  316.     {
  317.         return $this->order;
  318.     }
  320.     /**
  321.      * Associates an order with the event.
  322.      *
  323.      * @param \XLite\Model\Order $order Order
  324.      *
  325.      * @return RewardHistoryEvent
  326.      */
  327.     public function setOrder(\XLite\Model\Order $order = null)
  328.     {
  329.         $this->order = $order;
  331.         return $this;
  332.     }
  333. }