src/Eccube/Entity/TaxRule.php line 28

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;
  18. if (!class_exists('\Eccube\Entity\TaxRule')) {
  19.     /**
  20.      * TaxRule
  21.      *
  22.      * @ORM\Table(name="dtb_tax_rule")
  23.      * @ORM\InheritanceType("SINGLE_TABLE")
  24.      * @ORM\DiscriminatorColumn(name="discriminator_type", type="string", length=255)
  25.      * @ORM\HasLifecycleCallbacks()
  26.      * @ORM\Entity(repositoryClass="Eccube\Repository\TaxRuleRepository")
  27.      */
  28.     class TaxRule extends \Eccube\Entity\AbstractEntity
  29.     {
  30.         /**
  31.          * @var integer
  32.          */
  33.         public const DEFAULT_TAX_RULE_ID = 1;
  35.         /**
  36.          * @var integer
  37.          */
  38.         private $sort_no;
  40.         /**
  41.          * is default
  42.          *
  43.          * @return bool
  44.          */
  45.         public function isDefaultTaxRule()
  46.         {
  47.             return self::DEFAULT_TAX_RULE_ID === $this->getId();
  48.         }
  50.         /**
  51.          * Set sortNo
  52.          *
  53.          * @param  integer $sortNo
  54.          *
  55.          * @return TaxRule
  56.          */
  57.         public function setSortNo($sortNo)
  58.         {
  59.             $this->sort_no = $sortNo;
  61.             return $this;
  62.         }
  64.         /**
  65.          * Get sortNo
  66.          *
  67.          * @return integer
  68.          */
  69.         public function getSortNo()
  70.         {
  71.             return $this->sort_no;
  72.         }
  74.         /**
  75.          * @var int
  76.          *
  77.          * @ORM\Column(name="id", type="integer", options={"unsigned":true})
  78.          * @ORM\Id
  79.          * @ORM\GeneratedValue(strategy="IDENTITY")
  80.          */
  81.         private $id;
  83.         /**
  84.          * @var string
  85.          *
  86.          * @ORM\Column(name="tax_rate", type="decimal", precision=10, scale=0, options={"unsigned":true,"default":0})
  87.          */
  88.         private $tax_rate = 0;
  90.         /**
  91.          * @var string
  92.          *
  93.          * @ORM\Column(name="tax_adjust", type="decimal", precision=10, scale=0, options={"unsigned":true,"default":0})
  94.          */
  95.         private $tax_adjust = 0;
  97.         /**
  98.          * @var \DateTime
  99.          *
  100.          * @ORM\Column(name="apply_date", type="datetimetz")
  101.          */
  102.         private $apply_date;
  104.         /**
  105.          * @var \DateTime
  106.          *
  107.          * @ORM\Column(name="create_date", type="datetimetz")
  108.          */
  109.         private $create_date;
  111.         /**
  112.          * @var \DateTime
  113.          *
  114.          * @ORM\Column(name="update_date", type="datetimetz")
  115.          */
  116.         private $update_date;
  118.         /**
  119.          * @var \Eccube\Entity\ProductClass
  120.          *
  121.          * @ORM\OneToOne(targetEntity="Eccube\Entity\ProductClass", inversedBy="TaxRule")
  122.          * @ORM\JoinColumns({
  123.          *   @ORM\JoinColumn(name="product_class_id", referencedColumnName="id")
  124.          * })
  125.          */
  126.         private $ProductClass;
  128.         /**
  129.          * @var \Eccube\Entity\Member
  130.          *
  131.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Member")
  132.          * @ORM\JoinColumns({
  133.          *   @ORM\JoinColumn(name="creator_id", referencedColumnName="id")
  134.          * })
  135.          */
  136.         private $Creator;
  138.         /**
  139.          * @var \Eccube\Entity\Master\Country
  140.          *
  141.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\Country")
  142.          * @ORM\JoinColumns({
  143.          *   @ORM\JoinColumn(name="country_id", referencedColumnName="id")
  144.          * })
  145.          */
  146.         private $Country;
  148.         /**
  149.          * @var \Eccube\Entity\Master\Pref
  150.          *
  151.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\Pref")
  152.          * @ORM\JoinColumns({
  153.          *   @ORM\JoinColumn(name="pref_id", referencedColumnName="id")
  154.          * })
  155.          */
  156.         private $Pref;
  158.         /**
  159.          * @var \Eccube\Entity\Product
  160.          *
  161.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Product")
  162.          * @ORM\JoinColumns({
  163.          *   @ORM\JoinColumn(name="product_id", referencedColumnName="id")
  164.          * })
  165.          */
  166.         private $Product;
  168.         /**
  169.          * @var \Eccube\Entity\Master\RoundingType
  170.          *
  171.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\RoundingType")
  172.          * @ORM\JoinColumns({
  173.          *   @ORM\JoinColumn(name="rounding_type_id", referencedColumnName="id")
  174.          * })
  175.          */
  176.         private $RoundingType;
  178.         /**
  179.          * Get id.
  180.          *
  181.          * @return int
  182.          */
  183.         public function getId()
  184.         {
  185.             return $this->id;
  186.         }
  188.         /**
  189.          * Set taxRate.
  190.          *
  191.          * @param string $taxRate
  192.          *
  193.          * @return TaxRule
  194.          */
  195.         public function setTaxRate($taxRate)
  196.         {
  197.             $this->tax_rate = $taxRate;
  199.             return $this;
  200.         }
  202.         /**
  203.          * Get taxRate.
  204.          *
  205.          * @return string
  206.          */
  207.         public function getTaxRate()
  208.         {
  209.             return $this->tax_rate;
  210.         }
  212.         /**
  213.          * Set taxAdjust.
  214.          *
  215.          * @param string $taxAdjust
  216.          *
  217.          * @return TaxRule
  218.          */
  219.         public function setTaxAdjust($taxAdjust)
  220.         {
  221.             $this->tax_adjust = $taxAdjust;
  223.             return $this;
  224.         }
  226.         /**
  227.          * Get taxAdjust.
  228.          *
  229.          * @return string
  230.          */
  231.         public function getTaxAdjust()
  232.         {
  233.             return $this->tax_adjust;
  234.         }
  236.         /**
  237.          * Set applyDate.
  238.          *
  239.          * @param \DateTime $applyDate
  240.          *
  241.          * @return TaxRule
  242.          */
  243.         public function setApplyDate($applyDate)
  244.         {
  245.             $this->apply_date = $applyDate;
  247.             return $this;
  248.         }
  250.         /**
  251.          * Get applyDate.
  252.          *
  253.          * @return \DateTime
  254.          */
  255.         public function getApplyDate()
  256.         {
  257.             return $this->apply_date;
  258.         }
  260.         /**
  261.          * Set createDate.
  262.          *
  263.          * @param \DateTime $createDate
  264.          *
  265.          * @return TaxRule
  266.          */
  267.         public function setCreateDate($createDate)
  268.         {
  269.             $this->create_date = $createDate;
  271.             return $this;
  272.         }
  274.         /**
  275.          * Get createDate.
  276.          *
  277.          * @return \DateTime
  278.          */
  279.         public function getCreateDate()
  280.         {
  281.             return $this->create_date;
  282.         }
  284.         /**
  285.          * Set updateDate.
  286.          *
  287.          * @param \DateTime $updateDate
  288.          *
  289.          * @return TaxRule
  290.          */
  291.         public function setUpdateDate($updateDate)
  292.         {
  293.             $this->update_date = $updateDate;
  295.             return $this;
  296.         }
  298.         /**
  299.          * Get updateDate.
  300.          *
  301.          * @return \DateTime
  302.          */
  303.         public function getUpdateDate()
  304.         {
  305.             return $this->update_date;
  306.         }
  308.         /**
  309.          * Set productClass.
  310.          *
  311.          * @param \Eccube\Entity\ProductClass|null $productClass
  312.          *
  313.          * @return TaxRule
  314.          */
  315.         public function setProductClass(ProductClass $productClass = null)
  316.         {
  317.             $this->ProductClass = $productClass;
  319.             return $this;
  320.         }
  322.         /**
  323.          * Get productClass.
  324.          *
  325.          * @return \Eccube\Entity\ProductClass|null
  326.          */
  327.         public function getProductClass()
  328.         {
  329.             return $this->ProductClass;
  330.         }
  332.         /**
  333.          * Set creator.
  334.          *
  335.          * @param \Eccube\Entity\Member|null $creator
  336.          *
  337.          * @return TaxRule
  338.          */
  339.         public function setCreator(Member $creator = null)
  340.         {
  341.             $this->Creator = $creator;
  343.             return $this;
  344.         }
  346.         /**
  347.          * Get creator.
  348.          *
  349.          * @return \Eccube\Entity\Member|null
  350.          */
  351.         public function getCreator()
  352.         {
  353.             return $this->Creator;
  354.         }
  356.         /**
  357.          * Set country.
  358.          *
  359.          * @param \Eccube\Entity\Master\Country|null $country
  360.          *
  361.          * @return TaxRule
  362.          */
  363.         public function setCountry(Master\Country $country = null)
  364.         {
  365.             $this->Country = $country;
  367.             return $this;
  368.         }
  370.         /**
  371.          * Get country.
  372.          *
  373.          * @return \Eccube\Entity\Master\Country|null
  374.          */
  375.         public function getCountry()
  376.         {
  377.             return $this->Country;
  378.         }
  380.         /**
  381.          * Set pref.
  382.          *
  383.          * @param \Eccube\Entity\Master\Pref|null $pref
  384.          *
  385.          * @return TaxRule
  386.          */
  387.         public function setPref(Master\Pref $pref = null)
  388.         {
  389.             $this->Pref = $pref;
  391.             return $this;
  392.         }
  394.         /**
  395.          * Get pref.
  396.          *
  397.          * @return \Eccube\Entity\Master\Pref|null
  398.          */
  399.         public function getPref()
  400.         {
  401.             return $this->Pref;
  402.         }
  404.         /**
  405.          * Set product.
  406.          *
  407.          * @param \Eccube\Entity\Product|null $product
  408.          *
  409.          * @return TaxRule
  410.          */
  411.         public function setProduct(Product $product = null)
  412.         {
  413.             $this->Product = $product;
  415.             return $this;
  416.         }
  418.         /**
  419.          * Get product.
  420.          *
  421.          * @return \Eccube\Entity\Product|null
  422.          */
  423.         public function getProduct()
  424.         {
  425.             return $this->Product;
  426.         }
  428.         /**
  429.          * Set roundingType.
  430.          *
  431.          * @return TaxRule
  432.          */
  433.         public function setRoundingType(Master\RoundingType $RoundingType = null)
  434.         {
  435.             $this->RoundingType = $RoundingType;
  437.             return $this;
  438.         }
  440.         /**
  441.          * Get roundingType.
  442.          *
  443.          * @return \Eccube\Entity\Master\RoundingType|null
  444.          */
  445.         public function getRoundingType()
  446.         {
  447.             return $this->RoundingType;
  448.         }
  450.         /**
  451.          * 自分自身と Target を比較し, ソートのための数値を返す.
  452.          *
  453.          * 以下の順で比較し、
  454.          *
  455.          * 同一であれば 0
  456.          * 自分の方が大きければ正の整数
  457.          * 小さければ負の整数を返す.
  458.          *
  459.          * 1. 商品別税率が有効
  460.          * 2. apply_date
  461.          * 3. sort_no
  462.          *
  463.          * このメソッドは usort() 関数などで使用する.
  464.          *
  465.          * @param TaxRule $Target 比較対象の TaxRule
  466.          *
  467.          * @return integer
  468.          */
  469.         public function compareTo(TaxRule $Target)
  470.         {
  471.             if ($this->isProductTaxRule() && !$Target->isProductTaxRule()) {
  472.                 return -1;
  473.             } elseif (!$this->isProductTaxRule() && $Target->isProductTaxRule()) {
  474.                 return 1;
  475.             } else {
  476.                 if ($this->getApplyDate()->format('YmdHis') == $Target->getApplyDate()->format('YmdHis')) {
  477.                     if ($this->getSortNo() == $Target->getSortNo()) {
  478.                         return 0;
  479.                     }
  480.                     if ($this->getSortNo() > $Target->getSortNo()) {
  481.                         return -1;
  482.                     } else {
  483.                         return 1;
  484.                     }
  485.                 } else {
  486.                     if ($this->getApplyDate()->format('YmdHis') > $Target->getApplyDate()->format('YmdHis')) {
  487.                         return -1;
  488.                     } else {
  489.                         return 1;
  490.                     }
  491.                 }
  492.             }
  493.         }
  495.         /**
  496.          * 商品別税率設定が適用されているかどうか.
  497.          *
  498.          * @return bool 商品別税率が適用されている場合 true
  499.          */
  500.         public function isProductTaxRule()
  501.         {
  502.             return $this->getProductClass() !== null || $this->getProduct() !== null;
  503.         }
  504.     }
  505. }