app/Plugin/CouponPro42/Entity/Coupon.php line 31

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the CouponPro42 Plugin
  5. *
  6. * Copyright (C) 2022 Diezon.
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Plugin\CouponPro42\Entity;
  14. use Eccube\Entity\AbstractEntity;
  15. use Eccube\Entity\Master\OrderStatus;
  16. use Plugin\CouponPro42\Entity\Master\CouponKind;
  17. use Doctrine\Common\Collections\ArrayCollection;
  18. use Doctrine\ORM\Mapping as ORM;
  20. /**
  21. * Coupon
  22. * plg_couponはECCUBE標準のクーポンプラグインで使用されているため、命名規則に応じてベンダー名を追加
  23. * https://doc4.ec-cube.net/plugin_naming_conventions
  24. *
  25. * @ORM\Table(name="plg_diezon_coupon")
  26. * @ORM\InheritanceType("SINGLE_TABLE")
  27. * @ORM\DiscriminatorColumn(name="discriminator_type", type="string", length=255)
  28. * @ORM\HasLifecycleCallbacks()
  29. * @ORM\Entity(repositoryClass="Plugin\CouponPro42\Repository\CouponRepository")
  30. */
  31. class Coupon extends AbstractEntity
  32. {
  33. /**
  34. * @var int
  35. *
  36. * @ORM\Column(name="id", type="integer", options={"unsigned":true})
  37. * @ORM\Id
  38. * @ORM\GeneratedValue(strategy="IDENTITY")
  39. */
  40. private $id;
  42. /**
  43. * @var string
  44. *
  45. * @ORM\Column(name="coupon_code", type="string", length=255)
  46. */
  47. private $coupon_code;
  49. /**
  50. * @var string
  51. *
  52. * @ORM\Column(name="coupon_name", type="string", length=255)
  53. */
  54. private $coupon_name;
  56. /**
  57. * @var DateTime
  58. *
  59. * @ORM\Column(name="available_from", type="datetimetz")
  60. */
  61. private $available_from;
  63. /**
  64. * @var DateTime
  65. *
  66. * @ORM\Column(name="available_to", type="datetimetz")
  67. */
  68. private $available_to;
  70. /**
  71. * @var CouponKind
  72. *
  73. * @ORM\ManyToOne(targetEntity="Plugin\CouponPro42\Entity\Master\CouponKind")
  74. * @ORM\JoinColumns({
  75. * @ORM\JoinColumn(name="coupon_kind_id", referencedColumnName="id")
  76. * })
  77. */
  78. private $CouponKind;
  80. /**
  81. * @var string|null
  82. *
  83. * @ORM\Column(name="discount_price", type="decimal", precision=10, scale=0, options={"unsigned":true}, nullable=true)
  84. */
  85. private $discount_price;
  87. /**
  88. * @var string|null
  89. *
  90. * @ORM\Column(name="discount_rate", type="decimal", precision=10, scale=0, options={"unsigned":true}, nullable=true)
  91. */
  92. private $discount_rate;
  94. /**
  95. * @var string|null
  96. *
  97. * @ORM\Column(name="issued", type="decimal", precision=10, scale=0, options={"unsigned":true}, nullable=true)
  98. */
  99. private $issued;
  101. /**
  102. * @var boolean
  103. *
  104. * @ORM\Column(name="issued_unlimited", type="boolean", options={"default":false})
  105. */
  106. private $issued_unlimited;
  108. /**
  109. * @var boolean
  110. *
  111. * @ORM\Column(name="is_display_mypage", type="boolean", options={"default":false})
  112. */
  113. private $is_display_mypage = false;
  116. /**
  117. * @var boolean
  118. *
  119. * @ORM\Column(name="is_display_guest", type="boolean", options={"default":false})
  120. */
  121. private $is_display_guest = false;
  123. /**
  124. * @var string|null
  125. *
  126. * @ORM\Column(name="trans_url", type="string", length=255, nullable=true)
  127. */
  128. private $trans_url;
  130. /**
  131. * @var boolean
  132. *
  133. * @ORM\Column(name="first_time_limit", type="boolean", options={"default":false})
  134. */
  135. private $first_time_limit;
  137. /**
  138. * @var string|null
  139. *
  140. * @ORM\Column(name="min_price", type="decimal", precision=10, scale=0, options={"unsigned":true}, nullable=true)
  141. */
  142. private $min_price;
  144. /**
  145. * @var string|null
  146. *
  147. * @ORM\Column(name="customer_available", type="decimal", precision=10, scale=0, options={"unsigned":true}, nullable=true)
  148. */
  149. private $customer_available;
  151. /**
  152. * @var boolean
  153. *
  154. * @ORM\Column(name="enable", type="boolean", options={"default":false})
  155. */
  156. private $enable;
  158. /**
  159. * @var boolean
  160. *
  161. * @ORM\Column(name="deleted", type="boolean", options={"default":false})
  162. */
  163. private $deleted;
  165. /**
  166. * @var ArrayCollection
  167. *
  168. * @ORM\OneToMany(targetEntity="Plugin\CouponPro42\Entity\OrderCoupon", mappedBy="Coupon")
  169. */
  170. private $OrderCoupons;
  172. /**
  173. * @var ArrayCollection
  174. *
  175. * @ORM\OneToMany(targetEntity="Plugin\CouponPro42\Entity\CouponCategory", mappedBy="Coupon")
  176. */
  177. private $CouponCategories;
  179. /**
  180. * @var ArrayCollection
  181. *
  182. * @ORM\OneToMany(targetEntity="Plugin\CouponPro42\Entity\CouponCustomer", mappedBy="Coupon")
  183. */
  184. private $CouponCustomers;
  186. /**
  187. * @var ArrayCollection
  188. *
  189. * @ORM\OneToMany(targetEntity="Plugin\CouponPro42\Entity\CouponProduct", mappedBy="Coupon")
  190. */
  191. private $CouponProducts;
  193. /**
  194. * @var DateTime
  195. *
  196. * @ORM\Column(name="create_date", type="datetimetz")
  197. */
  198. private $create_date;
  200. /**
  201. * @var DateTime
  202. *
  203. * @ORM\Column(name="update_date", type="datetimetz")
  204. */
  205. private $update_date;
  207. public function __construct()
  208. {
  209. $this->OrderCoupons = new ArrayCollection();
  210. $this->CouponCategories = new ArrayCollection();
  211. $this->CouponCustomers = new ArrayCollection();
  212. $this->CouponProducts = new ArrayCollection();
  213. }
  215. /**
  216. * @return int|null
  217. */
  218. public function getId(): ?int
  219. {
  220. return $this->id;
  221. }
  223. /**
  224. * @param string $couponCode
  225. * @return $this
  226. */
  227. public function setCouponCode(string $couponCode): self
  228. {
  229. $this->coupon_code = $couponCode;
  231. return $this;
  232. }
  234. /**
  235. * @return string
  236. */
  237. public function getCouponCode(): string
  238. {
  239. return $this->coupon_code;
  240. }
  242. /**
  243. * @param string $couponName
  244. * @return $this
  245. */
  246. public function setCouponName(string $couponName): self
  247. {
  248. $this->coupon_name = $couponName;
  250. return $this;
  251. }
  253. /**
  254. * @return string
  255. */
  256. public function getCouponName(): string
  257. {
  258. return $this->coupon_name;
  259. }
  261. /**
  262. * @param CouponKind $CouponKind
  263. * @return $this
  264. */
  265. public function setCouponKind(CouponKind $CouponKind): self
  266. {
  267. $this->CouponKind = $CouponKind;
  269. return $this;
  270. }
  272. /**
  273. * @return CouponKind
  274. */
  275. public function getCouponKind(): CouponKind
  276. {
  277. return $this->CouponKind;
  278. }
  280. /**
  281. * @param string|null $discountPrice
  282. * @return $this
  283. */
  284. public function setDiscountPrice(?string $discountPrice): self
  285. {
  286. $this->discount_price = $discountPrice;
  288. return $this;
  289. }
  291. /**
  292. * @return string|null
  293. */
  294. public function getDiscountPrice(): ?string
  295. {
  296. return $this->discount_price;
  297. }
  299. /**
  300. * @param string|null $discountRate
  301. * @return $this
  302. */
  303. public function setDiscountRate(?string $discountRate)
  304. {
  305. $this->discount_rate = $discountRate;
  307. return $this;
  308. }
  310. /**
  311. * @return string|null
  312. */
  313. public function getDiscountRate(): ?string
  314. {
  315. return $this->discount_rate;
  316. }
  318. /**
  319. * @param string|null $issued
  320. * @return $this
  321. */
  322. public function setIssued(?string $issued): self
  323. {
  324. $this->issued = $issued;
  326. return $this;
  327. }
  329. /**
  330. * @return string|null
  331. */
  332. public function getIssued(): ?string
  333. {
  334. return $this->issued;
  335. }
  337. /**
  338. * @param bool|null $issuedUnlimited
  339. * @return $this
  340. */
  341. public function setIssuedUnlimited(?bool $issuedUnlimited = false): self
  342. {
  343. $this->issued_unlimited = $issuedUnlimited;
  345. return $this;
  346. }
  348. /**
  349. * @return bool
  350. */
  351. public function isIssuedUnlimited(): bool
  352. {
  353. return $this->issued_unlimited;
  354. }
  356. /**
  357. * @param string|null $transUrl
  358. * @return $this
  359. */
  360. public function setTransUrl(?string $transUrl): self
  361. {
  362. $this->trans_url = $transUrl;
  364. return $this;
  365. }
  367. /**
  368. * @return string|null
  369. */
  370. public function getTransUrl(): ?string
  371. {
  372. return $this->trans_url;
  373. }
  375. /**
  376. * @param bool|null $firstTimeLimit
  377. * @return $this
  378. */
  379. public function setFirstTimeLimit(?bool $firstTimeLimit = false): self
  380. {
  381. $this->first_time_limit = $firstTimeLimit;
  383. return $this;
  384. }
  386. /**
  387. * @return bool
  388. */
  389. public function isFirstTimeLimit(): bool
  390. {
  391. return $this->first_time_limit;
  392. }
  394. /**
  395. * @param string|null $minPrice
  396. * @return $this
  397. */
  398. public function setMinPrice(?string $minPrice): self
  399. {
  400. $this->min_price = $minPrice;
  402. return $this;
  403. }
  405. /**
  406. * @return string|null
  407. */
  408. public function getMinPrice(): ?string
  409. {
  410. return $this->min_price;
  411. }
  413. /**
  414. * @param string|null $customerAvailable
  415. * @return $this
  416. */
  417. public function setCustomerAvailable(?string $customerAvailable): self
  418. {
  419. $this->customer_available = $customerAvailable;
  421. return $this;
  422. }
  424. /**
  425. * @return string|null
  426. */
  427. public function getCustomerAvailable(): ?string
  428. {
  429. return $this->customer_available;
  430. }
  432. /**
  433. * @param \DateTime|null $availableFrom
  434. * @return $this
  435. */
  436. public function setAvailableFrom(?\DateTime $availableFrom): self
  437. {
  438. $this->available_from = $availableFrom;
  440. return $this;
  441. }
  443. /**
  444. * @return \DateTime
  445. */
  446. public function getAvailableFrom()
  447. {
  448. return $this->available_from;
  449. }
  451. /**
  452. * @param \DateTime|null $availableTo
  453. * @return $this
  454. */
  455. public function setAvailableTo(?\DateTime $availableTo): self
  456. {
  457. $this->available_to = $availableTo;
  459. return $this;
  460. }
  462. /**
  463. * @return \DateTime
  464. */
  465. public function getAvailableTo()
  466. {
  467. return $this->available_to;
  468. }
  470. /**
  471. * @param bool|null $enable
  472. * @return $this
  473. */
  474. public function setEnable(?bool $enable = false)
  475. {
  476. $this->enable = $enable;
  478. return $this;
  479. }
  481. /**
  482. * @return bool
  483. */
  484. public function isEnable(): bool
  485. {
  486. return $this->enable;
  487. }
  489. /**
  490. * @param bool|null $deleted
  491. * @return $this
  492. */
  493. public function setDeleted(?bool $deleted = false): self
  494. {
  495. $this->deleted = $deleted;
  497. return $this;
  498. }
  500. /**
  501. * @return bool
  502. */
  503. public function isDeleted(): bool
  504. {
  505. return $this->deleted;
  506. }
  508. /**
  509. * @param \DateTime $createDate
  510. * @return $this
  511. */
  512. public function setCreateDate(?\DateTime $createDate): self
  513. {
  514. $this->create_date = $createDate;
  516. return $this;
  517. }
  519. /**
  520. * @return \DateTime
  521. */
  522. public function getCreateDate()
  523. {
  524. return $this->create_date;
  525. }
  527. /**
  528. * @param \DateTime $updateDate
  529. * @return $this
  530. */
  531. public function setUpdateDate(?\DateTime $updateDate): self
  532. {
  533. $this->update_date = $updateDate;
  535. return $this;
  536. }
  538. /**
  539. * @return \DateTime
  540. */
  541. public function getUpdateDate()
  542. {
  543. return $this->update_date;
  544. }
  546. /**
  547. * @param bool $isDisplayMypage
  548. * @return $this
  549. */
  550. public function setIsDisplayMypage(bool $isDisplayMypage): self
  551. {
  552. $this->is_display_mypage = $isDisplayMypage;
  554. return $this;
  555. }
  557. /**
  558. * @return boolean
  559. */
  560. public function isDisplayMypage()
  561. {
  562. return $this->is_display_mypage;
  563. }
  565. /**
  566. * @param bool|null $isDisplayGuest
  567. * @return $this
  568. */
  569. public function setIsDisplayGuest(?bool $isDisplayGuest = false): self
  570. {
  571. $this->is_display_guest = $isDisplayGuest;
  573. return $this;
  574. }
  576. /**
  577. * @return boolean
  578. */
  579. public function isDisplayGuest()
  580. {
  581. return $this->is_display_guest;
  582. }
  584. /**
  585. * @param OrderCoupon $OrderCoupon
  586. * @return $this
  587. */
  588. public function addOrderCoupon(OrderCoupon $OrderCoupon)
  589. {
  590. $this->OrderCoupons[] = $OrderCoupon;
  592. return $this;
  593. }
  595. /**
  596. * @param OrderCoupon $OrderCoupon
  597. * @return boolean TRUE if this collection contained the specified element, FALSE otherwise.
  598. */
  599. public function removeOrderCoupon(OrderCoupon $OrderCoupon)
  600. {
  601. return $this->OrderCoupons->removeElement($OrderCoupon);
  602. }
  604. /**
  605. * @return ArrayCollection
  606. */
  607. public function getOrderCoupons()
  608. {
  609. return $this->OrderCoupons;
  610. }
  612. /**
  613. * @param CouponCategory $CouponCategory
  614. */
  615. public function addCouponCategory(CouponCategory $CouponCategory)
  616. {
  617. $this->CouponCategories[] = $CouponCategory;
  619. return $this;
  620. }
  622. /**
  623. * @param CouponCategory $CouponCategory
  624. * @return boolean TRUE if this collection contained the specified element, FALSE otherwise.
  625. */
  626. public function removeCouponCategory(CouponCategory $CouponCategory)
  627. {
  628. return $this->CouponCategories->removeElement($CouponCategory);
  629. }
  631. /**
  632. * @return ArrayCollection
  633. */
  634. public function getCouponCategories()
  635. {
  636. return $this->CouponCategories;
  637. }
  639. /**
  640. * @param CouponCustomer $CouponCustomer
  641. */
  642. public function addCouponCustomer(CouponCustomer $CouponCustomer)
  643. {
  644. $this->CouponCustomers[] = $CouponCustomer;
  646. return $this;
  647. }
  649. /**
  650. * @param CouponCustomer $CouponCustomer
  651. * @return boolean TRUE if this collection contained the specified element, FALSE otherwise.
  652. */
  653. public function removeCouponCustomer(CouponCustomer $CouponCustomer)
  654. {
  655. return $this->CouponCustomers->removeElement($CouponCustomer);
  656. }
  658. /**
  659. * @return ArrayCollection
  660. */
  661. public function getCouponCustomers()
  662. {
  663. return $this->CouponCustomers;
  664. }
  666. /**
  667. * @param CouponProduct $CouponProduct
  668. */
  669. public function addCouponProduct(CouponProduct $CouponProduct)
  670. {
  671. $this->CouponProducts[] = $CouponProduct;
  673. return $this;
  674. }
  676. /**
  677. * @param CouponProduct $CouponProduct
  678. * @return boolean TRUE if this collection contained the specified element, FALSE otherwise.
  679. */
  680. public function removeCouponProduct(CouponProduct $CouponProduct)
  681. {
  682. return $this->CouponProducts->removeElement($CouponProduct);
  683. }
  685. /**
  686. * Get CouponProducts.
  687. * @return ArrayCollection
  688. */
  689. public function getCouponProducts()
  690. {
  691. return $this->CouponProducts;
  692. }
  694. /**
  695. * @return string
  696. */
  697. public function getOrderCouponCount()
  698. {
  699. $OrderCoupons = $this->getOrderCoupons();
  700. $count = 0;
  701. foreach ($OrderCoupons as $OrderCoupon) {
  702. $OrderStatus = $OrderCoupon->getOrder()->getOrderStatus();
  703. if (!in_array($OrderStatus->getId(), [
  704. OrderStatus::PENDING,
  705. OrderStatus::PROCESSING,
  706. OrderStatus::CANCEL,
  707. ])) {
  708. $count++;
  709. }
  710. }
  711. return $count;
  712. }
  714. /**
  715. * @return string
  716. */
  717. public function getDiscountLabel()
  718. {
  719. if ($this->getCouponKind()->getId() == CouponKind::DISCOUNT_PRICE):
  720. $discount = '¥' . $this->getDiscountPrice();
  721. elseif ($this->getCouponKind()->getId() == CouponKind::DISCOUNT_RATE):
  722. $discount = $this->getDiscountRate() . '%';
  723. else:
  724. $discount = trans('common.coupon.free_shipping');
  725. endif;
  726. return $discount;
  727. }
  729. /**
  730. * @return array
  731. */
  732. public function getTargetProducts()
  733. {
  734. $products = [];
  735. foreach ($this->getCouponProducts() as $CouponProduct) {
  736. if ($CouponProduct->getProduct()->isEnable()) {
  737. $products[$CouponProduct->getProduct()->getId()] = $CouponProduct->getProduct()->getName();
  738. }
  739. }
  740. ksort($products);
  741. return $products;
  742. }
  744. /**
  745. * @return array
  746. */
  747. public function getTargetCategories()
  748. {
  749. $categories = [];
  750. foreach ($this->getCouponCategories() as $CouponCategory) {
  751. $categories[$CouponCategory->getCategory()->getId()] = $CouponCategory->getCategory()->getName();
  752. }
  753. ksort($categories);
  754. return $categories;
  755. }
  756. }