modules/QSL/AbandonedCartReminder/src/Model/Email.php line 27

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 QSL\AbandonedCartReminder\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * E-mail notification for an abandoned cart.
  14.  *
  15.  * @ORM\Entity (repositoryClass="\QSL\AbandonedCartReminder\Model\Repo\Email")
  16.  * @ORM\Table  (name="cart_reminder_emails",
  17.  *      indexes={
  18.  *          @ORM\Index (name="dateSent", columns={"dateSent"}),
  19.  *          @ORM\Index (name="dateClicked", columns={"dateClicked"}),
  20.  *          @ORM\Index (name="datePlaced", columns={"datePlaced"}),
  21.  *          @ORM\Index (name="datePaid", columns={"datePaid"}),
  22.  *          @ORM\Index (name="orderHash", columns={"orderHash"}),
  23.  *          @ORM\Index (name="profileHash", columns={"profileHash"})
  24.  *      }
  25.  * )
  26.  */
  27. class Email extends \XLite\Model\AEntity
  28. {
  29.     /**
  30.      * Primary key
  31.      *
  32.      * @var integer
  33.      *
  34.      * @ORM\Id
  35.      * @ORM\GeneratedValue (strategy="AUTO")
  36.      * @ORM\Column         (type="integer")
  37.      */
  38.     protected $email_id;
  40.     /**
  41.      * Abandoned cart / recovered order
  42.      *
  43.      * Due to the default "cart ttl" set to 7 days, we have to make the relation
  44.      * optional and provide a function to clear past statistics (otherwise XC5
  45.      * will auto-delete e-mails sent more than 7 days ago).
  46.      *
  47.      * @var \XLite\Model\Order
  48.      *
  49.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Order", inversedBy="cartReminderEmails")
  50.      * @ORM\JoinColumn (name="order_id", referencedColumnName="order_id", nullable=true, onDelete="SET NULL")
  51.      */
  52.     protected $order;
  54.     /**
  55.      * Unique identifier of the associated order.
  56.      *
  57.      * Orders can be deleted (and will be deleted during the garbage clean-up
  58.      * routine!). So, in order to keep the statistics consistent, we have to
  59.      * store some kind of a cached identifier that doesn't depend on
  60.      * the associated order model.
  61.      *
  62.      * @var string
  63.      * @ORM\Column (type="string", length=255, nullable=false, options={ "default": "" })
  64.      */
  65.     protected $orderHash = '';
  67.     /**
  68.      * Unique identifier of the associated profile.
  69.      *
  70.      * Profiles can be deleted. So, in order to keep the statistics consistent,
  71.      * we have to store some kind of a cached identifier that doesn't depend on
  72.      * the associated profile model.
  73.      *
  74.      * @var string
  75.      * @ORM\Column (type="string", length=255, nullable=false, options={ "default": "" })
  76.      */
  77.     protected $profileHash = '';
  79.     /**
  80.      * Date when the e-mail was sent (timestamp).
  81.      *
  82.      * @var integer
  83.      *
  84.      * @ORM\Column (type="integer", nullable=false, options={ "default": 0 })
  85.      */
  86.     protected $dateSent = 0;
  88.     /**
  89.      * Date when the e-mail was clicked by the customer the last time (timestamp).
  90.      *
  91.      * @var integer
  92.      *
  93.      * @ORM\Column (type="integer", nullable=false, options={ "default": 0 })
  94.      */
  95.     protected $dateClicked = 0;
  97.     /**
  98.      * Date when the customer placed the order (timestamp).
  99.      *
  100.      * @var integer
  101.      *
  102.      * @ORM\Column (type="integer", nullable=false, options={ "default": 0 })
  103.      */
  104.     protected $datePlaced = 0;
  106.     /**
  107.      * Date when the customer paid the order (timestamp).
  108.      *
  109.      * @var integer
  110.      *
  111.      * @ORM\Column (type="integer", nullable=false, options={ "default": 0 })
  112.      */
  113.     protected $datePaid = 0;
  115.     /**
  116.      * @var integer
  117.      *
  118.      * @ORM\Column (type="integer", nullable=false)
  119.      */
  120.     protected $reminderId;
  122.     /**
  123.      * Returns a unique string that identifies an order.
  124.      *
  125.      * @param \XLite\Model\Order $order Order or cart model
  126.      *
  127.      * @return string
  128.      */
  129.     public static function getHashForOrder(\XLite\Model\Order $order)
  130.     {
  131.         $email = $order->getLastCartReminderEmail();
  133.         return $email ? $email->getOrderHash() : ($order->getDate() . '-' . $order->getOrderId());
  134.     }
  136.     /**
  137.      * Returns a unique string that identifies a user.
  138.      *
  139.      * @param \XLite\Model\Profile $profile User profile
  140.      *
  141.      * @return string
  142.      */
  143.     public static function getHashForProfile(\XLite\Model\Profile $profile)
  144.     {
  145.         return $profile->getAdded() . '-' . $profile->getProfileId();
  146.     }
  148.     /**
  149.      * Updates the date when the e-mail was sent to the user.
  150.      *
  151.      * @param int $timestamp Date (UNIX timestamp)
  152.      *
  153.      * @return void
  154.      */
  155.     public function setDateSent($timestamp)
  156.     {
  157.         $this->dateSent = $timestamp;
  158.     }
  160.     /**
  161.      * Returns the date when the e-mail was sent to the user.
  162.      *
  163.      * @return int
  164.      */
  165.     public function getDateSent()
  166.     {
  167.         return $this->dateSent;
  168.     }
  170.     /**
  171.      * Updates the date when user followed the cart recovery link in the e-mail
  172.      * the last time.
  173.      *
  174.      * @param int $timestamp Date (UNIX timestamp)
  175.      *
  176.      * @return void
  177.      */
  178.     public function setDateClicked($timestamp)
  179.     {
  180.         $this->dateClicked = $timestamp;
  181.     }
  183.     /**
  184.      * Returns the date when user followed the cart recovery link in the e-mail
  185.      * the last time.
  186.      *
  187.      * @return int
  188.      */
  189.     public function getDateClicked()
  190.     {
  191.         return $this->dateClicked;
  192.     }
  194.     /**
  195.      * Updates the date when user placed an order after following the cart
  196.      * recovery link from the e-mail.
  197.      *
  198.      * @param int $timestamp Date (UNIX timestamp)
  199.      *
  200.      * @return void
  201.      */
  202.     public function setDatePlaced($timestamp)
  203.     {
  204.         $this->datePlaced = $timestamp;
  205.     }
  207.     /**
  208.      * Returns the date when user placed an order after following the cart
  209.      * recovery link from the e-mail.
  210.      *
  211.      * @return int
  212.      */
  213.     public function getDatePlaced()
  214.     {
  215.         return $this->datePlaced;
  216.     }
  218.     /**
  219.      * Updates the date when user paid an an order, placed after following
  220.      * the cart recovery link from the e-mail.
  221.      *
  222.      * @param int $timestamp Date (UNIX timestamp)
  223.      *
  224.      * @return void
  225.      */
  226.     public function setDatePaid($timestamp)
  227.     {
  228.         $this->datePaid = $timestamp;
  229.     }
  231.     /**
  232.      * Returns the date when user paid an an order, placed after following
  233.      * the cart recovery link from the e-mail.
  234.      *
  235.      * @return int
  236.      */
  237.     public function getDatePaid()
  238.     {
  239.         return $this->datePaid;
  240.     }
  242.     /**
  243.      * Associated the e-mail model with the abandoned cart that the e-mail was
  244.      * sent for.
  245.      *
  246.      * @param \XLite\Model\Order $order
  247.      */
  248.     public function setOrder(\XLite\Model\Order $order)
  249.     {
  250.         $this->order = $order;
  252.         $this->setOrderHash(self::getHashForOrder($order));
  254.         $this->setProfileHash(self::getHashForProfile(
  255.             $order->getOrigProfile() ?: $order->getProfile()
  256.         ));
  257.     }
  259.     /**
  260.      * Returns the abandoned cart / order that the e-mail was sent for.
  261.      *
  262.      * @return \XLite\Model\Order
  263.      */
  264.     public function getOrder()
  265.     {
  266.         return $this->order;
  267.     }
  269.     /**
  270.      * Updates the unique string identifying the order that the e-mail was sent
  271.      * for.
  272.      *
  273.      * @param string $hash Unique identifier
  274.      *
  275.      * @return void
  276.      */
  277.     public function setOrderHash($hash)
  278.     {
  279.         $this->orderHash = $hash;
  280.     }
  282.     /**
  283.      * Returns the unique string identifying the order that the e-mail was sent
  284.      * for.
  285.      *
  286.      * @return string
  287.      */
  288.     public function getOrderHash()
  289.     {
  290.         return $this->orderHash;
  291.     }
  293.     /**
  294.      * Updates the unique string identifying the user that the e-mail was sent
  295.      * for.
  296.      *
  297.      * @param string $hash Unique identifier
  298.      *
  299.      * @return void
  300.      */
  301.     public function setProfileHash($hash)
  302.     {
  303.         $this->profileHash = $hash;
  304.     }
  306.     /**
  307.      * Returns the unique string identifying the user that the e-mail was sent
  308.      * for.
  309.      *
  310.      * @return string
  311.      */
  312.     public function getProfileHash()
  313.     {
  314.         return $this->profileHash;
  315.     }
  317.     /**
  318.      * @param integer $id
  319.      *
  320.      * @return $this
  321.      */
  322.     public function setReminderId($id)
  323.     {
  324.         $this->reminderId = $id;
  326.         return $this;
  327.     }
  329.     /**
  330.      * @return int
  331.      */
  332.     public function getReminderId()
  333.     {
  334.         return $this->reminderId;
  335.     }
  336. }