modules/QSL/CustomerSatisfaction/src/Model/Survey.php line 29

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\CustomerSatisfaction\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * Survey
  14.  *
  15.  * @ORM\Entity (repositoryClass="\QSL\CustomerSatisfaction\Model\Repo\Survey")
  16.  *
  17.  * @ORM\Table  (name="surveys",
  18.  *      uniqueConstraints={
  19.  *          @ORM\UniqueConstraint (name="pair", columns={"id","order_id"})
  20.  *      },
  21.  *      indexes={
  22.  *          @ORM\Index (name="status",     columns={"status"}),
  23.  *          @ORM\Index (name="customer",   columns={"customer_id"}),
  24.  *          @ORM\Index (name="emailDate", columns={"emailDate"}),
  25.  *          @ORM\Index (name="rating",     columns={"rating"})
  26.  *      }
  27.  * )
  28.  */
  29. class Survey extends \XLite\Model\AEntity
  30. {
  31.     public const STATUS_HIDDEN      = 'H';
  32.     public const STATUS_NEW         = 'N';
  33.     public const STATUS_IN_PROGRESS = 'P';
  34.     public const STATUS_CLOSED      = 'C';
  36.     /**
  37.      * Survey statuses labels
  38.      *
  39.      * @var array
  40.      */
  41.     protected $surveyStatuses = [
  42.         \QSL\CustomerSatisfaction\Model\Survey::STATUS_NEW         => 'New',
  43.         \QSL\CustomerSatisfaction\Model\Survey::STATUS_IN_PROGRESS => 'In progress',
  44.         \QSL\CustomerSatisfaction\Model\Survey::STATUS_CLOSED      => 'Closed',
  45.     ];
  47.     /**
  48.      * Unique survey ID
  49.      *
  50.      * @var mixed
  51.      *
  52.      * @ORM\Id
  53.      * @ORM\GeneratedValue (strategy="AUTO")
  54.      * @ORM\Column         (type="integer")
  55.      */
  56.     protected $id;
  58.     /**
  59.      * Survey Order ID
  60.      *
  61.      * @var \XLite\Model\Order
  62.      *
  63.      * @ORM\OneToOne (targetEntity="XLite\Model\Order", inversedBy="survey")
  64.      * @ORM\JoinColumn (name="order_id", referencedColumnName="order_id", onDelete="CASCADE")
  65.      */
  66.     protected $order;
  68.     /**
  69.      * Survey rating
  70.      *
  71.      * @var integer
  72.      *
  73.      * @ORM\Column (type="integer", nullable=true)
  74.      */
  75.     protected $rating;
  77.     /**
  78.      * Survey processing status
  79.      *
  80.      * @var string
  81.      *
  82.      * @ORM\Column (type="string", options={ "fixed": true }, length=1)
  83.      */
  84.     protected $status = \QSL\CustomerSatisfaction\Model\Survey::STATUS_HIDDEN;
  86.     /**
  87.      * Survey email sent date
  88.      *
  89.      * @var integer
  90.      *
  91.      * @ORM\Column (type="integer", nullable=true)
  92.      */
  93.     protected $emailDate;
  95.     /**
  96.      * Survey init date
  97.      *
  98.      * @var integer
  99.      *
  100.      * @ORM\Column (type="integer", nullable=true)
  101.      */
  102.     protected $initDate;
  104.     /**
  105.      * Survey feedback received date
  106.      *
  107.      * @var integer
  108.      *
  109.      * @ORM\Column (type="integer", nullable=true)
  110.      */
  111.     protected $feedbackDate;
  113.     /**
  114.      * Survey feedback processed date
  115.      *
  116.      * @var integer
  117.      *
  118.      * @ORM\Column (type="integer", nullable=true)
  119.      */
  120.     protected $feedbackProcessedDate;
  122.     /**
  123.      * Survey comments
  124.      *
  125.      * @var string
  126.      *
  127.      * @ORM\Column (type="text")
  128.      */
  129.     protected $comments = '';
  131.     /**
  132.      * Survey comments
  133.      *
  134.      * @var string
  135.      *
  136.      * @ORM\Column (type="text")
  137.      */
  138.     protected $customerMessage = '';
  140.     /**
  141.      * Survey assigned manager
  142.      *
  143.      * @var \XLite\Model\Profile
  144.      *
  145.      * @ORM\ManyToOne (targetEntity="XLite\Model\Profile", inversedBy="managerSurveys", cascade={"merge","detach"})
  146.      * @ORM\JoinColumn (name="manager_id", referencedColumnName="profile_id")
  147.      */
  148.     protected $manager;
  150.     /**
  151.      * Survey customer
  152.      *
  153.      * @var \XLite\Model\Profile
  154.      *
  155.      * @ORM\ManyToOne (targetEntity="XLite\Model\Profile", inversedBy="customerSurveys", cascade={"merge","detach"})
  156.      * @ORM\JoinColumn (name="customer_id", referencedColumnName="profile_id")
  157.      */
  158.     protected $customer;
  160.     /**
  161.      * Relations to a Answer entities
  162.      *
  163.      * @var \Doctrine\Common\Collections\Collection
  164.      *
  165.      * @ORM\OneToMany (targetEntity="QSL\CustomerSatisfaction\Model\Answer", mappedBy="survey", cascade={"all"})
  166.      */
  167.     protected $answers;
  169.     /**
  170.      * Relation to a TagSurvey entities
  171.      *
  172.      * @var \QSL\CustomerSatisfaction\Model\Tag
  173.      *
  174.      * @ORM\ManyToMany (targetEntity="QSL\CustomerSatisfaction\Model\Tag", mappedBy="surveys", cascade={"all"})    *
  175.      */
  176.     protected $tags;
  178.     /**
  179.      * Hash key
  180.      *
  181.      * @var string
  182.      *
  183.      * @ORM\Column (type="string", length=128, unique=true, nullable=true)
  184.      */
  185.     protected $hashKey;
  187.     /**
  188.      * Question is enabled
  189.      *
  190.      * @var boolean
  191.      *
  192.      * @ORM\Column (type="boolean")
  193.      */
  194.     protected $filled = false;
  196.     /**
  197.      * Prepare creation date
  198.      *
  199.      * @return void
  200.      *
  201.      * @ORM\PrePersist
  202.      */
  203.     public function prepareBeforeCreate()
  204.     {
  205.         if (!$this->getInitDate()) {
  206.             $this->setInitDate(\XLite\Core\Converter::time());
  207.         }
  208.     }
  210.     /**
  211.      * Return status string
  212.      *
  213.      * @return string
  214.      *
  215.      */
  216.     public function getStatusString()
  217.     {
  218.         $statuses = $this->getSurveyStatuses();
  219.         return $statuses[$this->getStatus()];
  220.     }
  222.     /**
  223.      * Return tags in one string
  224.      *
  225.      * @return string
  226.      *
  227.      */
  228.     public function getTagsString()
  229.     {
  230.         $tags = $this->tags;
  232.         $returnTags = [];
  233.         foreach ($tags as $tag) {
  234.             $returnTags[] = $tag->getName();
  235.         }
  236.         if ($returnTags) {
  237.             $tagsString = implode(',', $returnTags);
  238.         }
  240.         return (!empty($tagsString)) ? $tagsString : '';
  241.     }
  244.     /**
  245.      * Return survey statuses
  246.      *
  247.      * @return array
  248.      *
  249.      */
  250.     public static function getSurveyStatuses()
  251.     {
  252.         return [
  253.            \QSL\CustomerSatisfaction\Model\Survey::STATUS_NEW          => 'New',
  254.             \QSL\CustomerSatisfaction\Model\Survey::STATUS_IN_PROGRESS => 'In progress',
  255.             \QSL\CustomerSatisfaction\Model\Survey::STATUS_CLOSED      => 'Closed',
  256.         ];
  257.     }
  259.     /**
  260.      * Sets the Survey statuses labels.
  261.      *
  262.      * @param array $surveyStatuses the survey statuses
  263.      *
  264.      * @return self
  265.      */
  266.     public function setSurveyStatuses(array $surveyStatuses)
  267.     {
  268.         $this->surveyStatuses = $surveyStatuses;
  269.     }
  271.     /**
  272.      * Gets the Unique survey ID.
  273.      *
  274.      * @return mixed
  275.      */
  276.     public function getId()
  277.     {
  278.         return $this->id;
  279.     }
  281.     /**
  282.      * Sets the Unique survey ID.
  283.      *
  284.      * @param mixed $id the id
  285.      *
  286.      * @return self
  287.      */
  288.     public function setId($id)
  289.     {
  290.         $this->id = $id;
  291.     }
  293.     /**
  294.      * Gets the Survey Order ID.
  295.      *
  296.      * @return \XLite\Model\Order
  297.      */
  298.     public function getOrder()
  299.     {
  300.         return $this->order;
  301.     }
  303.     /**
  304.      * Sets the Survey Order ID.
  305.      *
  306.      * @param \XLite\Model\Order $order the order
  307.      *
  308.      * @return self
  309.      */
  310.     public function setOrder($order)
  311.     {
  312.         $this->order = $order;
  313.     }
  315.     /**
  316.      * Gets the Survey rating.
  317.      *
  318.      * @return integer
  319.      */
  320.     public function getRating()
  321.     {
  322.         return $this->rating;
  323.     }
  325.     /**
  326.      * Sets the Survey rating.
  327.      *
  328.      * @param integer $rating the rating
  329.      *
  330.      * @return self
  331.      */
  332.     public function setRating($rating)
  333.     {
  334.         $this->rating = $rating;
  335.     }
  337.     /**
  338.      * Gets the Survey processing status.
  339.      *
  340.      * @return string
  341.      */
  342.     public function getStatus()
  343.     {
  344.         return $this->status;
  345.     }
  347.     /**
  348.      * Sets the Survey processing status.
  349.      *
  350.      * @param string $status the status
  351.      *
  352.      * @return self
  353.      */
  354.     public function setStatus($status)
  355.     {
  356.         $this->status = $status;
  357.     }
  359.     /**
  360.      * Gets the Survey email sent date.
  361.      *
  362.      * @return integer
  363.      */
  364.     public function getEmailDate()
  365.     {
  366.         return $this->emailDate;
  367.     }
  369.     /**
  370.      * Sets the Survey email sent date.
  371.      *
  372.      * @param integer $emailDate the email date
  373.      *
  374.      * @return self
  375.      */
  376.     public function setEmailDate($emailDate)
  377.     {
  378.         $this->emailDate = $emailDate;
  379.     }
  381.     /**
  382.      * Gets the Survey init date.
  383.      *
  384.      * @return integer
  385.      */
  386.     public function getInitDate()
  387.     {
  388.         return $this->initDate;
  389.     }
  391.     /**
  392.      * Sets the Survey init date.
  393.      *
  394.      * @param integer $initDate the init date
  395.      *
  396.      * @return self
  397.      */
  398.     public function setInitDate($initDate)
  399.     {
  400.         $this->initDate = $initDate;
  401.     }
  403.     /**
  404.      * Gets the Survey feedback received date.
  405.      *
  406.      * @return integer
  407.      */
  408.     public function getFeedbackDate()
  409.     {
  410.         return $this->feedbackDate;
  411.     }
  413.     /**
  414.      * Sets the Survey feedback received date.
  415.      *
  416.      * @param integer $feedbackDate the feedback date
  417.      *
  418.      * @return self
  419.      */
  420.     public function setFeedbackDate($feedbackDate)
  421.     {
  422.         $this->feedbackDate = $feedbackDate;
  423.     }
  425.     /**
  426.      * Gets the Survey feedback processed date.
  427.      *
  428.      * @return integer
  429.      */
  430.     public function getFeedbackProcessedDate()
  431.     {
  432.         return $this->feedbackProcessedDate;
  433.     }
  435.     /**
  436.      * Sets the Survey feedback processed date.
  437.      *
  438.      * @param integer $feedbackProcessedDate the feedback processed date
  439.      *
  440.      * @return self
  441.      */
  442.     public function setFeedbackProcessedDate($feedbackProcessedDate)
  443.     {
  444.         $this->feedbackProcessedDate = $feedbackProcessedDate;
  445.     }
  447.     /**
  448.      * Gets the Survey comments.
  449.      *
  450.      * @return string
  451.      */
  452.     public function getComments()
  453.     {
  454.         return $this->comments;
  455.     }
  457.     /**
  458.      * Sets the Survey comments.
  459.      *
  460.      * @param string $comments the comments
  461.      *
  462.      * @return self
  463.      */
  464.     public function setComments($comments)
  465.     {
  466.         $this->comments = $comments;
  467.     }
  469.     /**
  470.      * Gets the Survey comments.
  471.      *
  472.      * @return string
  473.      */
  474.     public function getCustomerMessage()
  475.     {
  476.         return $this->customerMessage;
  477.     }
  479.     /**
  480.      * Sets the Survey comments.
  481.      *
  482.      * @param string $customerMessage the customer message
  483.      *
  484.      * @return self
  485.      */
  486.     public function setCustomerMessage($customerMessage)
  487.     {
  488.         $this->customerMessage = $customerMessage;
  489.     }
  491.     /**
  492.      * Gets the Survey assigned manager.
  493.      *
  494.      * @return \XLite\Model\Profile
  495.      */
  496.     public function getManager()
  497.     {
  498.         return $this->manager;
  499.     }
  501.     /**
  502.      * Sets the Survey assigned manager.
  503.      *
  504.      * @param \XLite\Model\Profile $manager the manager
  505.      *
  506.      * @return self
  507.      */
  508.     public function setManager(\XLite\Model\Profile $manager)
  509.     {
  510.         $this->manager = $manager;
  511.     }
  513.     /**
  514.      * Gets the Survey customer.
  515.      *
  516.      * @return \XLite\Model\Profile
  517.      */
  518.     public function getCustomer()
  519.     {
  520.         return $this->customer;
  521.     }
  523.     /**
  524.      * Sets the Survey customer.
  525.      *
  526.      * @param \XLite\Model\Profile $customer the customer
  527.      *
  528.      * @return self
  529.      */
  530.     public function setCustomer($customer)
  531.     {
  532.         $this->customer = $customer;
  533.     }
  535.     /**
  536.      * Gets the Relations to a Answer entities.
  537.      *
  538.      * @return \Doctrine\Common\Collections\Collection
  539.      */
  540.     public function getAnswers()
  541.     {
  542.         return $this->answers;
  543.     }
  545.     /**
  546.      * Sets the Relations to a Answer entities.
  547.      *
  548.      * @param \Doctrine\Common\Collections\Collection $answers the answers
  549.      *
  550.      * @return self
  551.      */
  552.     public function setAnswers($answers)
  553.     {
  554.         $this->answers = $answers;
  555.     }
  557.     /**
  558.      * Gets the Relation to a TagSurvey entities.
  559.      *
  560.      * @return \QSL\CustomerSatisfaction\Model\Tag
  561.      */
  562.     public function getTags()
  563.     {
  564.         return $this->tags;
  565.     }
  567.     /**
  568.      * Sets the Relation to a TagSurvey entities.
  569.      *
  570.      * @param \QSL\CustomerSatisfaction\Model\Tag $tags the tags
  571.      *
  572.      * @return self
  573.      */
  574.     public function setTags($tags)
  575.     {
  576.         $this->tags = $tags;
  577.     }
  579.     /**
  580.      * Gets the Hash key.
  581.      *
  582.      * @return string
  583.      */
  584.     public function getHashKey()
  585.     {
  586.         return $this->hashKey;
  587.     }
  589.     /**
  590.      * Sets the Hash key.
  591.      *
  592.      * @param string $hashKey the hash key
  593.      *
  594.      * @return self
  595.      */
  596.     public function setHashKey($hashKey)
  597.     {
  598.         $this->hashKey = $hashKey;
  599.     }
  601.     /**
  602.      * Gets the Question is enabled.
  603.      *
  604.      * @return boolean
  605.      */
  606.     public function getFilled()
  607.     {
  608.         return $this->filled;
  609.     }
  611.     /**
  612.      * Sets the Question is enabled.
  613.      *
  614.      * @param boolean $filled the filled
  615.      *
  616.      * @return self
  617.      */
  618.     public function setFilled($filled)
  619.     {
  620.         $this->filled = $filled;
  621.     }
  622. }