app/proxy/entity/src/Eccube/Entity/OrderItem.php line 31

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of EC-CUBE
  5.  *
  6.  * Copyright(c) EC-CUBE CO.,LTD. All Rights Reserved.
  7.  *
  8.  * http://www.ec-cube.co.jp/
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Eccube\Entity;
  16. use Doctrine\ORM\Mapping as ORM;
  17. use Eccube\Entity\Master\OrderItemType;
  18. use Eccube\Entity\Master\RoundingType;
  19. use Eccube\Entity\Master\TaxDisplayType;
  22.     /**
  23.      * OrderItem
  24.      *
  25.      * @ORM\Table(name="dtb_order_item")
  26.      * @ORM\InheritanceType("SINGLE_TABLE")
  27.      * @ORM\DiscriminatorColumn(name="discriminator_type", type="string", length=255)
  28.      * @ORM\HasLifecycleCallbacks()
  29.      * @ORM\Entity(repositoryClass="Eccube\Repository\OrderItemRepository")
  30.      */
  31.     class OrderItem extends \Eccube\Entity\AbstractEntity implements ItemInterface
  32.     {
  33.         use PointRateTrait, \Customize\Entity\OrderItemTrait;
  35.         /**
  36.          * Get price IncTax
  37.          *
  38.          * @return string
  39.          */
  40.         public function getPriceIncTax()
  41.         {
  42.             // 税表示区分が税込の場合は, priceに税込金額が入っている.
  43.             if ($this->TaxDisplayType && $this->TaxDisplayType->getId() == TaxDisplayType::INCLUDED) {
  44.                 return $this->price;
  45.             }
  47.             return $this->price + $this->tax;
  48.         }
  50.         /**
  51.          * @return integer
  52.          */
  53.         public function getTotalPrice()
  54.         {
  55.             return $this->getPriceIncTax() * $this->getQuantity();
  56.         }
  58.         /**
  59.          * @return integer
  60.          */
  61.         public function getOrderItemTypeId()
  62.         {
  63.             if (is_object($this->getOrderItemType())) {
  64.                 return $this->getOrderItemType()->getId();
  65.             }
  67.             return null;
  68.         }
  70.         /**
  71.          * 商品明細かどうか.
  72.          *
  73.          * @return boolean 商品明細の場合 true
  74.          */
  75.         public function isProduct()
  76.         {
  77.             return $this->getOrderItemTypeId() === OrderItemType::PRODUCT;
  78.         }
  80.         /**
  81.          * 送料明細かどうか.
  82.          *
  83.          * @return boolean 送料明細の場合 true
  84.          */
  85.         public function isDeliveryFee()
  86.         {
  87.             return $this->getOrderItemTypeId() === OrderItemType::DELIVERY_FEE;
  88.         }
  90.         /**
  91.          * 手数料明細かどうか.
  92.          *
  93.          * @return boolean 手数料明細の場合 true
  94.          */
  95.         public function isCharge()
  96.         {
  97.             return $this->getOrderItemTypeId() === OrderItemType::CHARGE;
  98.         }
  100.         /**
  101.          * 値引き明細かどうか.
  102.          *
  103.          * @return boolean 値引き明細の場合 true
  104.          */
  105.         public function isDiscount()
  106.         {
  107.             return $this->getOrderItemTypeId() === OrderItemType::DISCOUNT;
  108.         }
  110.         /**
  111.          * 税額明細かどうか.
  112.          *
  113.          * @return boolean 税額明細の場合 true
  114.          */
  115.         public function isTax()
  116.         {
  117.             return $this->getOrderItemTypeId() === OrderItemType::TAX;
  118.         }
  120.         /**
  121.          * ポイント明細かどうか.
  122.          *
  123.          * @return boolean ポイント明細の場合 true
  124.          */
  125.         public function isPoint()
  126.         {
  127.             return $this->getOrderItemTypeId() === OrderItemType::POINT;
  128.         }
  130.         /**
  131.          * @var integer
  132.          *
  133.          * @ORM\Column(name="id", type="integer", options={"unsigned":true})
  134.          * @ORM\Id
  135.          * @ORM\GeneratedValue(strategy="IDENTITY")
  136.          */
  137.         private $id;
  139.         /**
  140.          * @var string
  141.          *
  142.          * @ORM\Column(name="product_name", type="string", length=255)
  143.          */
  144.         private $product_name;
  146.         /**
  147.          * @var string|null
  148.          *
  149.          * @ORM\Column(name="product_code", type="string", length=255, nullable=true)
  150.          */
  151.         private $product_code;
  153.         /**
  154.          * @var string|null
  155.          *
  156.          * @ORM\Column(name="class_name1", type="string", length=255, nullable=true)
  157.          */
  158.         private $class_name1;
  160.         /**
  161.          * @var string|null
  162.          *
  163.          * @ORM\Column(name="class_name2", type="string", length=255, nullable=true)
  164.          */
  165.         private $class_name2;
  167.         /**
  168.          * @var string|null
  169.          *
  170.          * @ORM\Column(name="class_category_name1", type="string", length=255, nullable=true)
  171.          */
  172.         private $class_category_name1;
  174.         /**
  175.          * @var string|null
  176.          *
  177.          * @ORM\Column(name="class_category_name2", type="string", length=255, nullable=true)
  178.          */
  179.         private $class_category_name2;
  181.         /**
  182.          * @var string
  183.          *
  184.          * @ORM\Column(name="price", type="decimal", precision=12, scale=2, options={"default":0})
  185.          */
  186.         private $price = 0;
  188.         /**
  189.          * @var string
  190.          *
  191.          * @ORM\Column(name="quantity", type="decimal", precision=10, scale=0, options={"default":0})
  192.          */
  193.         private $quantity = 0;
  195.         /**
  196.          * @var string
  197.          *
  198.          * @ORM\Column(name="tax", type="decimal", precision=10, scale=0, options={"default":0})
  199.          */
  200.         private $tax = 0;
  202.         /**
  203.          * @var string
  204.          *
  205.          * @ORM\Column(name="tax_rate", type="decimal", precision=10, scale=0, options={"unsigned":true,"default":0})
  206.          */
  207.         private $tax_rate = 0;
  209.         /**
  210.          * @var string
  211.          *
  212.          * @ORM\Column(name="tax_adjust", type="decimal", precision=10, scale=0, options={"unsigned":true,"default":0})
  213.          */
  214.         private $tax_adjust = 0;
  216.         /**
  217.          * @var int|null
  218.          *
  219.          * @ORM\Column(name="tax_rule_id", type="smallint", nullable=true, options={"unsigned":true})
  220.          */
  221.         private $tax_rule_id;
  223.         /**
  224.          * @var string|null
  225.          *
  226.          * @ORM\Column(name="currency_code", type="string", nullable=true)
  227.          */
  228.         private $currency_code;
  230.         /**
  231.          * @var string|null
  232.          *
  233.          * @ORM\Column(name="processor_name", type="string", nullable=true)
  234.          */
  235.         private $processor_name;
  237.         /**
  238.          * @var \Eccube\Entity\Order
  239.          *
  240.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Order", inversedBy="OrderItems")
  241.          * @ORM\JoinColumns({
  242.          *   @ORM\JoinColumn(name="order_id", referencedColumnName="id")
  243.          * })
  244.          */
  245.         private $Order;
  247.         /**
  248.          * @var \Eccube\Entity\Product
  249.          *
  250.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Product")
  251.          * @ORM\JoinColumns({
  252.          *   @ORM\JoinColumn(name="product_id", referencedColumnName="id")
  253.          * })
  254.          */
  255.         private $Product;
  257.         /**
  258.          * @var \Eccube\Entity\ProductClass
  259.          *
  260.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\ProductClass")
  261.          * @ORM\JoinColumns({
  262.          *   @ORM\JoinColumn(name="product_class_id", referencedColumnName="id")
  263.          * })
  264.          */
  265.         private $ProductClass;
  267.         /**
  268.          * @var \Eccube\Entity\Shipping
  269.          *
  270.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Shipping", inversedBy="OrderItems")
  271.          * @ORM\JoinColumns({
  272.          *   @ORM\JoinColumn(name="shipping_id", referencedColumnName="id")
  273.          * })
  274.          */
  275.         private $Shipping;
  277.         /**
  278.          * @var \Eccube\Entity\Master\RoundingType
  279.          *
  280.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\RoundingType")
  281.          * @ORM\JoinColumns({
  282.          *   @ORM\JoinColumn(name="rounding_type_id", referencedColumnName="id")
  283.          * })
  284.          */
  285.         private $RoundingType;
  287.         /**
  288.          * @var \Eccube\Entity\Master\TaxType
  289.          *
  290.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\TaxType")
  291.          * @ORM\JoinColumns({
  292.          *   @ORM\JoinColumn(name="tax_type_id", referencedColumnName="id")
  293.          * })
  294.          */
  295.         private $TaxType;
  297.         /**
  298.          * @var \Eccube\Entity\Master\TaxDisplayType
  299.          *
  300.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\TaxDisplayType")
  301.          * @ORM\JoinColumns({
  302.          *   @ORM\JoinColumn(name="tax_display_type_id", referencedColumnName="id")
  303.          * })
  304.          */
  305.         private $TaxDisplayType;
  307.         /**
  308.          * @var \Eccube\Entity\Master\OrderItemType
  309.          *
  310.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\OrderItemType")
  311.          * @ORM\JoinColumns({
  312.          *   @ORM\JoinColumn(name="order_item_type_id", referencedColumnName="id")
  313.          * })
  314.          */
  315.         private $OrderItemType;
  317.         /**
  318.          * Get id.
  319.          *
  320.          * @return int
  321.          */
  322.         public function getId()
  323.         {
  324.             return $this->id;
  325.         }
  327.         /**
  328.          * Set productName.
  329.          *
  330.          * @param string $productName
  331.          *
  332.          * @return OrderItem
  333.          */
  334.         public function setProductName($productName)
  335.         {
  336.             $this->product_name = $productName;
  338.             return $this;
  339.         }
  341.         /**
  342.          * Get productName.
  343.          *
  344.          * @return string
  345.          */
  346.         public function getProductName()
  347.         {
  348.             return $this->product_name;
  349.         }
  351.         /**
  352.          * Set productCode.
  353.          *
  354.          * @param string|null $productCode
  355.          *
  356.          * @return OrderItem
  357.          */
  358.         public function setProductCode($productCode = null)
  359.         {
  360.             $this->product_code = $productCode;
  362.             return $this;
  363.         }
  365.         /**
  366.          * Get productCode.
  367.          *
  368.          * @return string|null
  369.          */
  370.         public function getProductCode()
  371.         {
  372.             return $this->product_code;
  373.         }
  375.         /**
  376.          * Set className1.
  377.          *
  378.          * @param string|null $className1
  379.          *
  380.          * @return OrderItem
  381.          */
  382.         public function setClassName1($className1 = null)
  383.         {
  384.             $this->class_name1 = $className1;
  386.             return $this;
  387.         }
  389.         /**
  390.          * Get className1.
  391.          *
  392.          * @return string|null
  393.          */
  394.         public function getClassName1()
  395.         {
  396.             return $this->class_name1;
  397.         }
  399.         /**
  400.          * Set className2.
  401.          *
  402.          * @param string|null $className2
  403.          *
  404.          * @return OrderItem
  405.          */
  406.         public function setClassName2($className2 = null)
  407.         {
  408.             $this->class_name2 = $className2;
  410.             return $this;
  411.         }
  413.         /**
  414.          * Get className2.
  415.          *
  416.          * @return string|null
  417.          */
  418.         public function getClassName2()
  419.         {
  420.             return $this->class_name2;
  421.         }
  423.         /**
  424.          * Set classCategoryName1.
  425.          *
  426.          * @param string|null $classCategoryName1
  427.          *
  428.          * @return OrderItem
  429.          */
  430.         public function setClassCategoryName1($classCategoryName1 = null)
  431.         {
  432.             $this->class_category_name1 = $classCategoryName1;
  434.             return $this;
  435.         }
  437.         /**
  438.          * Get classCategoryName1.
  439.          *
  440.          * @return string|null
  441.          */
  442.         public function getClassCategoryName1()
  443.         {
  444.             return $this->class_category_name1;
  445.         }
  447.         /**
  448.          * Set classCategoryName2.
  449.          *
  450.          * @param string|null $classCategoryName2
  451.          *
  452.          * @return OrderItem
  453.          */
  454.         public function setClassCategoryName2($classCategoryName2 = null)
  455.         {
  456.             $this->class_category_name2 = $classCategoryName2;
  458.             return $this;
  459.         }
  461.         /**
  462.          * Get classCategoryName2.
  463.          *
  464.          * @return string|null
  465.          */
  466.         public function getClassCategoryName2()
  467.         {
  468.             return $this->class_category_name2;
  469.         }
  471.         /**
  472.          * Set price.
  473.          *
  474.          * @param string $price
  475.          *
  476.          * @return OrderItem
  477.          */
  478.         public function setPrice($price)
  479.         {
  480.             $this->price = $price;
  482.             return $this;
  483.         }
  485.         /**
  486.          * Get price.
  487.          *
  488.          * @return string
  489.          */
  490.         public function getPrice()
  491.         {
  492.             return $this->price;
  493.         }
  495.         /**
  496.          * Set quantity.
  497.          *
  498.          * @param string $quantity
  499.          *
  500.          * @return OrderItem
  501.          */
  502.         public function setQuantity($quantity)
  503.         {
  504.             $this->quantity = $quantity;
  506.             return $this;
  507.         }
  509.         /**
  510.          * Get quantity.
  511.          *
  512.          * @return string
  513.          */
  514.         public function getQuantity()
  515.         {
  516.             return $this->quantity;
  517.         }
  519.         /**
  520.          * @return string
  521.          */
  522.         public function getTax()
  523.         {
  524.             return $this->tax;
  525.         }
  527.         /**
  528.          * @param string $tax
  529.          *
  530.          * @return $this
  531.          */
  532.         public function setTax($tax)
  533.         {
  534.             $this->tax = $tax;
  536.             return $this;
  537.         }
  539.         /**
  540.          * Set taxRate.
  541.          *
  542.          * @param string $taxRate
  543.          *
  544.          * @return OrderItem
  545.          */
  546.         public function setTaxRate($taxRate)
  547.         {
  548.             $this->tax_rate = $taxRate;
  550.             return $this;
  551.         }
  553.         /**
  554.          * Get taxRate.
  555.          *
  556.          * @return string
  557.          */
  558.         public function getTaxRate()
  559.         {
  560.             return $this->tax_rate;
  561.         }
  563.         /**
  564.          * Set taxAdjust.
  565.          *
  566.          * @param string $tax_adjust
  567.          *
  568.          * @return OrderItem
  569.          */
  570.         public function setTaxAdjust($tax_adjust)
  571.         {
  572.             $this->tax_adjust = $tax_adjust;
  574.             return $this;
  575.         }
  577.         /**
  578.          * Get taxAdjust.
  579.          *
  580.          * @return string
  581.          */
  582.         public function getTaxAdjust()
  583.         {
  584.             return $this->tax_adjust;
  585.         }
  587.         /**
  588.          * Set taxRuleId.
  589.          *
  590.          * @deprecated 税率設定は受注作成時に決定するため廃止予定
  591.          *
  592.          * @param int|null $taxRuleId
  593.          *
  594.          * @return OrderItem
  595.          */
  596.         public function setTaxRuleId($taxRuleId = null)
  597.         {
  598.             $this->tax_rule_id = $taxRuleId;
  600.             return $this;
  601.         }
  603.         /**
  604.          * Get taxRuleId.
  605.          *
  606.          * @deprecated 税率設定は受注作成時に決定するため廃止予定
  607.          *
  608.          * @return int|null
  609.          */
  610.         public function getTaxRuleId()
  611.         {
  612.             return $this->tax_rule_id;
  613.         }
  615.         /**
  616.          * Get currencyCode.
  617.          *
  618.          * @return string
  619.          */
  620.         public function getCurrencyCode()
  621.         {
  622.             return $this->currency_code;
  623.         }
  625.         /**
  626.          * Set currencyCode.
  627.          *
  628.          * @param string|null $currencyCode
  629.          *
  630.          * @return OrderItem
  631.          */
  632.         public function setCurrencyCode($currencyCode = null)
  633.         {
  634.             $this->currency_code = $currencyCode;
  636.             return $this;
  637.         }
  639.         /**
  640.          * Get processorName.
  641.          *
  642.          * @return string
  643.          */
  644.         public function getProcessorName()
  645.         {
  646.             return $this->processor_name;
  647.         }
  649.         /**
  650.          * Set processorName.
  651.          *
  652.          * @param string|null $processorName
  653.          *
  654.          * @return $this
  655.          */
  656.         public function setProcessorName($processorName = null)
  657.         {
  658.             $this->processor_name = $processorName;
  660.             return $this;
  661.         }
  663.         /**
  664.          * Set order.
  665.          *
  666.          * @param \Eccube\Entity\Order|null $order
  667.          *
  668.          * @return OrderItem
  669.          */
  670.         public function setOrder(Order $order = null)
  671.         {
  672.             $this->Order = $order;
  674.             return $this;
  675.         }
  677.         /**
  678.          * Get order.
  679.          *
  680.          * @return \Eccube\Entity\Order|null
  681.          */
  682.         public function getOrder()
  683.         {
  684.             return $this->Order;
  685.         }
  687.         public function getOrderId()
  688.         {
  689.             if (is_object($this->getOrder())) {
  690.                 return $this->getOrder()->getId();
  691.             }
  693.             return null;
  694.         }
  696.         /**
  697.          * Set product.
  698.          *
  699.          * @param \Eccube\Entity\Product|null $product
  700.          *
  701.          * @return OrderItem
  702.          */
  703.         public function setProduct(Product $product = null)
  704.         {
  705.             $this->Product = $product;
  707.             return $this;
  708.         }
  710.         /**
  711.          * Get product.
  712.          *
  713.          * @return \Eccube\Entity\Product|null
  714.          */
  715.         public function getProduct()
  716.         {
  717.             return $this->Product;
  718.         }
  720.         /**
  721.          * Set productClass.
  722.          *
  723.          * @param \Eccube\Entity\ProductClass|null $productClass
  724.          *
  725.          * @return OrderItem
  726.          */
  727.         public function setProductClass(ProductClass $productClass = null)
  728.         {
  729.             $this->ProductClass = $productClass;
  731.             return $this;
  732.         }
  734.         /**
  735.          * Get productClass.
  736.          *
  737.          * @return \Eccube\Entity\ProductClass|null
  738.          */
  739.         public function getProductClass()
  740.         {
  741.             return $this->ProductClass;
  742.         }
  744.         /**
  745.          * Set shipping.
  746.          *
  747.          * @param \Eccube\Entity\Shipping|null $shipping
  748.          *
  749.          * @return OrderItem
  750.          */
  751.         public function setShipping(Shipping $shipping = null)
  752.         {
  753.             $this->Shipping = $shipping;
  755.             return $this;
  756.         }
  758.         /**
  759.          * Get shipping.
  760.          *
  761.          * @return \Eccube\Entity\Shipping|null
  762.          */
  763.         public function getShipping()
  764.         {
  765.             return $this->Shipping;
  766.         }
  768.         /**
  769.          * @return RoundingType
  770.          */
  771.         public function getRoundingType()
  772.         {
  773.             return $this->RoundingType;
  774.         }
  776.         /**
  777.          * @param RoundingType $RoundingType
  778.          */
  779.         public function setRoundingType(RoundingType $RoundingType = null)
  780.         {
  781.             $this->RoundingType = $RoundingType;
  783.             return $this;
  784.         }
  786.         /**
  787.          * Set taxType
  788.          *
  789.          * @param \Eccube\Entity\Master\TaxType $taxType
  790.          *
  791.          * @return OrderItem
  792.          */
  793.         public function setTaxType(Master\TaxType $taxType = null)
  794.         {
  795.             $this->TaxType = $taxType;
  797.             return $this;
  798.         }
  800.         /**
  801.          * Get taxType
  802.          *
  803.          * @return \Eccube\Entity\Master\TaxType
  804.          */
  805.         public function getTaxType()
  806.         {
  807.             return $this->TaxType;
  808.         }
  810.         /**
  811.          * Set taxDisplayType
  812.          *
  813.          * @param \Eccube\Entity\Master\TaxDisplayType $taxDisplayType
  814.          *
  815.          * @return OrderItem
  816.          */
  817.         public function setTaxDisplayType(TaxDisplayType $taxDisplayType = null)
  818.         {
  819.             $this->TaxDisplayType = $taxDisplayType;
  821.             return $this;
  822.         }
  824.         /**
  825.          * Get taxDisplayType
  826.          *
  827.          * @return \Eccube\Entity\Master\TaxDisplayType
  828.          */
  829.         public function getTaxDisplayType()
  830.         {
  831.             return $this->TaxDisplayType;
  832.         }
  834.         /**
  835.          * Set orderItemType
  836.          *
  837.          * @param \Eccube\Entity\Master\OrderItemType $orderItemType
  838.          *
  839.          * @return OrderItem
  840.          */
  841.         public function setOrderItemType(OrderItemType $orderItemType = null)
  842.         {
  843.             $this->OrderItemType = $orderItemType;
  845.             return $this;
  846.         }
  848.         /**
  849.          * Get orderItemType
  850.          *
  851.          * @return \Eccube\Entity\Master\OrderItemType
  852.          */
  853.         public function getOrderItemType()
  854.         {
  855.             return $this->OrderItemType;
  856.         }
  857.     }