classes/XLite/Model/OrderHistoryEvents.php line 61

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 XLite\Model;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\Common\Collections\ArrayCollection;
  12. use Doctrine\ORM\Mapping as ORM;
  13. use XLite\API\Endpoint\OrderHistory\DTO\OrderHistoryOutput as Output;
  15. /**
  16.  * Order history events
  17.  * todo: rename to OrderHistoryEvent
  18.  *
  19.  * @ORM\Entity
  20.  * @ORM\Table (name="order_history_events")
  21.  * @ApiPlatform\ApiResource(
  22.  *     shortName="History Event",
  23.  *     output=Output::class,
  24.  *     itemOperations={},
  25.  *     collectionOperations={
  26.  *          "get"={
  27.  *              "method"="GET",
  28.  *              "path"="/orders/{id}/history.{_format}",
  29.  *              "requirements"={"id"="\d+"},
  30.  *              "openapi_context"={
  31.  *                  "summary"="Retrieve a list of order history events",
  32.  *                  "responses"={
  33.  *                      "404"={
  34.  *                          "description"="Resource not found"
  35.  *                      }
  36.  *                  },
  37.  *                  "parameters"={
  38.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  39.  *                  }
  40.  *              }
  41.  *          },
  42.  *          "get_cart_history_events"={
  43.  *              "method"="GET",
  44.  *              "path"="/carts/{id}/history.{_format}",
  45.  *              "requirements"={"id"="\d+"},
  46.  *              "openapi_context"={
  47.  *                  "summary"="Retrieve a list of cart history events",
  48.  *                  "responses"={
  49.  *                      "404"={
  50.  *                          "description"="Resource not found"
  51.  *                      }
  52.  *                  },
  53.  *                  "parameters"={
  54.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  55.  *                  }
  56.  *              }
  57.  *          }
  58.  *     }
  59.  * )
  60.  */
  61. class OrderHistoryEvents extends \XLite\Model\AEntity
  62. {
  63.     /**
  64.      * Order history event unique id
  65.      *
  66.      * @var mixed
  67.      *
  68.      * @ORM\Id
  69.      * @ORM\GeneratedValue (strategy="AUTO")
  70.      * @ORM\Column         (type="integer")
  71.      */
  72.     protected $event_id;
  74.     /**
  75.      * Event creation timestamp
  76.      *
  77.      * @var integer
  78.      *
  79.      * @ORM\Column (type="integer")
  80.      */
  81.     protected $date;
  83.     /**
  84.      * Code of event
  85.      *
  86.      * @var string
  87.      *
  88.      * @ORM\Column (type="string", length=255)
  89.      */
  90.     protected $code;
  92.     /**
  93.      * Human-readable description of event
  94.      *
  95.      * @var string
  96.      *
  97.      * @ORM\Column (type="string", length=1024, nullable=true)
  98.      */
  99.     protected $description;
  101.     /**
  102.      * Data for human-readable description
  103.      *
  104.      * @var string
  105.      *
  106.      * @ORM\Column (type="array")
  107.      */
  108.     protected $data;
  110.     /**
  111.      * Event comment
  112.      *
  113.      * @var string
  114.      *
  115.      * @ORM\Column (type="text")
  116.      */
  117.     protected $comment = '';
  119.     /**
  120.      * Event details
  121.      *
  122.      * @var \XLite\Model\OrderHistoryEventsData[]
  123.      *
  124.      * @ORM\OneToMany (targetEntity="XLite\Model\OrderHistoryEventsData", mappedBy="event", cascade={"all"})
  125.      */
  126.     protected $details;
  128.     /**
  129.      * Relation to a order entity
  130.      *
  131.      * @var \XLite\Model\Order
  132.      *
  133.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Order", inversedBy="events", fetch="LAZY")
  134.      * @ORM\JoinColumn (name="order_id", referencedColumnName="order_id", onDelete="CASCADE")
  135.      */
  136.     protected $order;
  138.     /**
  139.      * Author profile of the event
  140.      *
  141.      * @var \XLite\Model\Profile
  142.      *
  143.      * @ORM\ManyToOne   (targetEntity="XLite\Model\Profile", inversedBy="event", cascade={"merge","detach","persist"})
  144.      * @ORM\JoinColumn (name="author_id", referencedColumnName="profile_id", onDelete="SET NULL")
  145.      */
  146.     protected $author;
  148.     /**
  149.      * Author name
  150.      *
  151.      * @var string
  152.      *
  153.      * @ORM\Column (type="string", length=255, nullable=true)
  154.      */
  155.     protected $authorName;
  157.     /**
  158.      * Author IP
  159.      *
  160.      * @var string
  161.      *
  162.      * @ORM\Column (type="string", length=255, nullable=true)
  163.      */
  164.     protected $authorIp = '';
  166.     public function __construct(array $data = [])
  167.     {
  168.         parent::__construct($data);
  170.         $this->details = new ArrayCollection();
  171.     }
  173.     /**
  174.      * Description getter
  175.      *
  176.      * @return string
  177.      */
  178.     public function getDescription()
  179.     {
  180.         return static::t($this->description, (array)$this->getData());
  181.     }
  183.     /**
  184.      * Details setter
  185.      *
  186.      * @param array $details Array of event details array($name => $value)
  187.      *
  188.      * @return void
  189.      */
  190.     public function setDetails(array $details)
  191.     {
  192.         foreach ($details as $detail) {
  193.             $data = new \XLite\Model\OrderHistoryEventsData();
  194.             $data->setName($detail['name']);
  195.             $data->setValue($detail['value']);
  197.             $this->addDetails($data);
  198.             $data->setEvent($this);
  199.         }
  200.     }
  202.     /**
  203.      * Clone order and all related data
  204.      *
  205.      * @return \XLite\Model\OrderHistoryEvents
  206.      */
  207.     public function cloneEntity()
  208.     {
  209.         $entity = parent::cloneEntity();
  211.         // Clone order details
  212.         if ($this->getDetails()) {
  213.             foreach ($this->getDetails() as $detail) {
  214.                 $cloned = $detail->cloneEntity();
  215.                 $entity->addDetails($cloned);
  216.                 $cloned->setEvent($entity);
  217.             }
  218.         }
  220.         return $entity;
  221.     }
  223.     /**
  224.      * Get event_id
  225.      *
  226.      * @return integer
  227.      */
  228.     public function getEventId()
  229.     {
  230.         return $this->event_id;
  231.     }
  233.     /**
  234.      * Set date
  235.      *
  236.      * @param integer $date
  237.      * @return OrderHistoryEvents
  238.      */
  239.     public function setDate($date)
  240.     {
  241.         $this->date = $date;
  242.         return $this;
  243.     }
  245.     /**
  246.      * Get date
  247.      *
  248.      * @return integer
  249.      */
  250.     public function getDate()
  251.     {
  252.         return $this->date;
  253.     }
  255.     /**
  256.      * Set code
  257.      *
  258.      * @param string $code
  259.      * @return OrderHistoryEvents
  260.      */
  261.     public function setCode($code)
  262.     {
  263.         $this->code = $code;
  264.         return $this;
  265.     }
  267.     /**
  268.      * Get code
  269.      *
  270.      * @return string
  271.      */
  272.     public function getCode()
  273.     {
  274.         return $this->code;
  275.     }
  277.     /**
  278.      * Set description
  279.      *
  280.      * @param string $description
  281.      * @return OrderHistoryEvents
  282.      */
  283.     public function setDescription($description)
  284.     {
  285.         $this->description = $description;
  286.         return $this;
  287.     }
  289.     /**
  290.      * Set data
  291.      *
  292.      * @param array $data
  293.      * @return OrderHistoryEvents
  294.      */
  295.     public function setData($data)
  296.     {
  297.         $this->data = $data;
  298.         return $this;
  299.     }
  301.     /**
  302.      * Get data
  303.      *
  304.      * @return array
  305.      */
  306.     public function getData()
  307.     {
  308.         return $this->data;
  309.     }
  311.     /**
  312.      * Set comment
  313.      *
  314.      * @param string $comment
  315.      * @return OrderHistoryEvents
  316.      */
  317.     public function setComment($comment)
  318.     {
  319.         $this->comment = $comment;
  320.         return $this;
  321.     }
  323.     /**
  324.      * Get comment
  325.      *
  326.      * @return string
  327.      */
  328.     public function getComment()
  329.     {
  330.         return $this->comment;
  331.     }
  333.     /**
  334.      * Add details
  335.      *
  336.      * @param \XLite\Model\OrderHistoryEventsData $details
  337.      * @return OrderHistoryEvents
  338.      */
  339.     public function addDetails(\XLite\Model\OrderHistoryEventsData $details)
  340.     {
  341.         $this->details[] = $details;
  342.         return $this;
  343.     }
  345.     /**
  346.      * Get details
  347.      *
  348.      * @return \Doctrine\Common\Collections\Collection
  349.      */
  350.     public function getDetails()
  351.     {
  352.         return $this->details;
  353.     }
  355.     /**
  356.      * Set order
  357.      *
  358.      * @param \XLite\Model\Order $order
  359.      * @return OrderHistoryEvents
  360.      */
  361.     public function setOrder(\XLite\Model\Order $order = null)
  362.     {
  363.         $this->order = $order;
  364.         return $this;
  365.     }
  367.     /**
  368.      * Get order
  369.      *
  370.      * @return \XLite\Model\Order
  371.      */
  372.     public function getOrder()
  373.     {
  374.         return $this->order;
  375.     }
  377.     /**
  378.      * Set author
  379.      *
  380.      * @param \XLite\Model\Profile $author
  381.      * @return OrderHistoryEvents
  382.      */
  383.     public function setAuthor(\XLite\Model\Profile $author = null)
  384.     {
  385.         $this->author = $author;
  387.         if ($author && $author->isAdmin()) {
  388.             $this->setAuthorName($author->getLogin());
  389.         }
  391.         return $this;
  392.     }
  394.     /**
  395.      * Get author
  396.      *
  397.      * @return \XLite\Model\Profile
  398.      */
  399.     public function getAuthor()
  400.     {
  401.         return $this->author;
  402.     }
  404.     /**
  405.      * @return string
  406.      */
  407.     public function getAuthorIp()
  408.     {
  409.         return $this->authorIp;
  410.     }
  412.     /**
  413.      * @param string $authorIp
  414.      *
  415.      * @return $this
  416.      */
  417.     public function setAuthorIp($authorIp)
  418.     {
  419.         $this->authorIp = $authorIp;
  420.         return $this;
  421.     }
  423.     /**
  424.      * @return string
  425.      */
  426.     public function getAuthorName()
  427.     {
  428.         return $this->authorName;
  429.     }
  431.     /**
  432.      * @param string $authorName
  433.      *
  434.      * @return $this
  435.      */
  436.     public function setAuthorName($authorName)
  437.     {
  438.         $this->authorName = $authorName;
  439.         return $this;
  440.     }
  442.     public function showAuthor()
  443.     {
  444.         return ($this->getAuthor() && $this->getAuthor()->isAdmin())
  445.             || $this->getAuthorName()
  446.             || $this->getAuthorIp();
  447.     }
  448. }