classes/XLite/Model/OrderDetail.php line 63

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 XLite\Model;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use XLite\API\Endpoint\OrderDetail\DTO\OrderDetailOutput as Output;
  14. /**
  15.  * Order details
  16.  *
  17.  * @ORM\Entity
  18.  * @ORM\Table (name="order_details",
  19.  *      indexes={
  20.  *          @ORM\Index (name="oname", columns={"order_id","name"})
  21.  *      }
  22.  * )
  23.  * @ApiPlatform\ApiResource(
  24.  *     shortName="Detail",
  25.  *     output=Output::class,
  26.  *     itemOperations={},
  27.  *     collectionOperations={
  28.  *          "get"={
  29.  *              "method"="GET",
  30.  *              "path"="/orders/{id}/details.{_format}",
  31.  *              "requirements"={"id"="\d+"},
  32.  *              "openapi_context"={
  33.  *                  "summary"="Retrieve a list of order details",
  34.  *                  "responses"={
  35.  *                      "404"={
  36.  *                          "description"="Resource not found"
  37.  *                      }
  38.  *                  },
  39.  *                  "parameters"={
  40.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  41.  *                  }
  42.  *              }
  43.  *          },
  44.  *          "get_cart_details"={
  45.  *              "method"="GET",
  46.  *              "path"="/carts/{id}/details.{_format}",
  47.  *              "requirements"={"id"="\d+"},
  48.  *              "openapi_context"={
  49.  *                  "summary"="Retrieve a list of cart details",
  50.  *                  "responses"={
  51.  *                      "404"={
  52.  *                          "description"="Resource not found"
  53.  *                      }
  54.  *                  },
  55.  *                  "parameters"={
  56.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  57.  *                  }
  58.  *              }
  59.  *          }
  60.  *     }
  61.  * )
  62.  */
  63. class OrderDetail extends \XLite\Model\AEntity
  64. {
  65.     /**
  66.      * Order detail unique id
  67.      *
  68.      * @var mixed
  69.      *
  70.      * @ORM\Id
  71.      * @ORM\GeneratedValue (strategy="AUTO")
  72.      * @ORM\Column         (type="integer")
  73.      */
  74.     protected $detail_id;
  76.     /**
  77.      * Record name (code)
  78.      *
  79.      * @var string
  80.      *
  81.      * @ORM\Column (type="string", length=255)
  82.      */
  83.     protected $name;
  85.     /**
  86.      * Record label
  87.      *
  88.      * @var string
  89.      *
  90.      * @ORM\Column (type="string", length=255, nullable=true)
  91.      */
  92.     protected $label;
  94.     /**
  95.      * Value
  96.      *
  97.      * @var string
  98.      *
  99.      * @ORM\Column (type="text")
  100.      */
  101.     protected $value;
  103.     /**
  104.      * Relation to a order entity
  105.      *
  106.      * @var \XLite\Model\Order
  107.      *
  108.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Order", inversedBy="details", fetch="LAZY")
  109.      * @ORM\JoinColumn (name="order_id", referencedColumnName="order_id", onDelete="CASCADE")
  110.      */
  111.     protected $order;
  113.     /**
  114.      * Get display record name
  115.      *
  116.      * @return string
  117.      */
  118.     public function getDisplayName()
  119.     {
  120.         return $this->getLabel() ?: $this->getName();
  121.     }
  123.     /**
  124.      * Get detail_id
  125.      *
  126.      * @return integer
  127.      */
  128.     public function getDetailId()
  129.     {
  130.         return $this->detail_id;
  131.     }
  133.     /**
  134.      * Set name
  135.      *
  136.      * @param string $name
  137.      * @return OrderDetail
  138.      */
  139.     public function setName($name)
  140.     {
  141.         $this->name = $name;
  142.         return $this;
  143.     }
  145.     /**
  146.      * Get name
  147.      *
  148.      * @return string
  149.      */
  150.     public function getName()
  151.     {
  152.         return $this->name;
  153.     }
  155.     /**
  156.      * Set label
  157.      *
  158.      * @param string $label
  159.      * @return OrderDetail
  160.      */
  161.     public function setLabel($label)
  162.     {
  163.         $this->label = $label;
  164.         return $this;
  165.     }
  167.     /**
  168.      * Get label
  169.      *
  170.      * @return string
  171.      */
  172.     public function getLabel()
  173.     {
  174.         return $this->label;
  175.     }
  177.     /**
  178.      * Set value
  179.      *
  180.      * @param string $value
  181.      * @return OrderDetail
  182.      */
  183.     public function setValue($value)
  184.     {
  185.         $this->value = $value;
  186.         return $this;
  187.     }
  189.     /**
  190.      * Get value
  191.      *
  192.      * @return string
  193.      */
  194.     public function getValue()
  195.     {
  196.         return $this->value;
  197.     }
  199.     /**
  200.      * Set order
  201.      *
  202.      * @param \XLite\Model\Order $order
  203.      * @return OrderDetail
  204.      */
  205.     public function setOrder(\XLite\Model\Order $order = null)
  206.     {
  207.         $this->order = $order;
  208.         return $this;
  209.     }
  211.     /**
  212.      * Get order
  213.      *
  214.      * @return \XLite\Model\Order
  215.      */
  216.     public function getOrder()
  217.     {
  218.         return $this->order;
  219.     }
  220. }