src/Eccube/Entity/Category.php line 29

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\Common\Collections\Criteria;
  17. use Doctrine\ORM\Mapping as ORM;
  19. if (!class_exists('\Eccube\Entity\Category')) {
  20.     /**
  21.      * Category
  22.      *
  23.      * @ORM\Table(name="dtb_category")
  24.      * @ORM\InheritanceType("SINGLE_TABLE")
  25.      * @ORM\DiscriminatorColumn(name="discriminator_type", type="string", length=255)
  26.      * @ORM\HasLifecycleCallbacks()
  27.      * @ORM\Entity(repositoryClass="Eccube\Repository\CategoryRepository")
  28.      */
  29.     class Category extends \Eccube\Entity\AbstractEntity
  30.     {
  31.         /**
  32.          * @return string
  33.          */
  34.         public function __toString()
  35.         {
  36.             return (string) $this->getName();
  37.         }
  39.         /**
  40.          * @return integer
  41.          */
  42.         public function countBranches()
  43.         {
  44.             $count = 1;
  46.             foreach ($this->getChildren() as $Child) {
  47.                 $count += $Child->countBranches();
  48.             }
  50.             return $count;
  51.         }
  53.         /**
  54.          * @param  \Doctrine\ORM\EntityManager $em
  55.          * @param  integer                     $sortNo
  56.          *
  57.          * @return \Eccube\Entity\Category
  58.          */
  59.         public function calcChildrenSortNo(\Doctrine\ORM\EntityManager $em, $sortNo)
  60.         {
  61.             $this->setSortNo($this->getSortNo() + $sortNo);
  62.             $em->persist($this);
  64.             foreach ($this->getChildren() as $Child) {
  65.                 $Child->calcChildrenSortNo($em, $sortNo);
  66.             }
  68.             return $this;
  69.         }
  71.         public function getParents()
  72.         {
  73.             $path = $this->getPath();
  74.             array_pop($path);
  76.             return $path;
  77.         }
  79.         public function getPath()
  80.         {
  81.             $path = [];
  82.             $Category = $this;
  84.             $max = 10;
  85.             while ($max--) {
  86.                 $path[] = $Category;
  88.                 $Category = $Category->getParent();
  89.                 if (!$Category || !$Category->getId()) {
  90.                     break;
  91.                 }
  92.             }
  94.             return array_reverse($path);
  95.         }
  97.         public function getNameWithLevel()
  98.         {
  99.             return str_repeat('　', $this->getHierarchy() - 1).$this->getName();
  100.         }
  102.         public function getDescendants()
  103.         {
  104.             $DescendantCategories = [];
  106.             $ChildCategories = $this->getChildren();
  107.             foreach ($ChildCategories as $ChildCategory) {
  108.                 $DescendantCategories[$ChildCategory->getId()] = $ChildCategory;
  109.                 $DescendantCategories2 = $ChildCategory->getDescendants();
  110.                 foreach ($DescendantCategories2 as $DescendantCategory) {
  111.                     $DescendantCategories[$DescendantCategory->getId()] = $DescendantCategory;
  112.                 }
  113.             }
  115.             return $DescendantCategories;
  116.         }
  118.         public function getSelfAndDescendants()
  119.         {
  120.             return array_merge([$this], $this->getDescendants());
  121.         }
  123.         /**
  124.          * カテゴリに紐づく商品があるかどうかを調べる.
  125.          *
  126.          * ProductCategoriesはExtra Lazyのため, lengthやcountで評価した際にはCOUNTのSQLが発行されるが,
  127.          * COUNT自体が重いので, LIMIT 1で取得し存在チェックを行う.
  128.          *
  129.          * @see http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/working-with-associations.html#filtering-collections
  130.          *
  131.          * @return bool
  132.          */
  133.         public function hasProductCategories()
  134.         {
  135.             $criteria = Criteria::create();
  136.             $criteria->orderBy(['category_id' => Criteria::ASC])
  137.             ->setFirstResult(0)
  138.             ->setMaxResults(1)
  139.             ->where($criteria->expr()->eq('visible', 1));
  141.             return $this->ProductCategories->matching($criteria)->count() > 0;
  142.         }
  143.         
  144.         /**
  145.          * @var int
  146.          *
  147.          * @ORM\Column(name="id", type="integer", options={"unsigned":true})
  148.          * @ORM\Id
  149.          * @ORM\GeneratedValue(strategy="IDENTITY")
  150.          */
  151.         private $id;
  153.         /**
  154.          * @var string
  155.          *
  156.          * @ORM\Column(name="category_name", type="string", length=255)
  157.          */
  158.         private $name;
  160.         /**
  161.          * @var int
  162.          *
  163.          * @ORM\Column(name="hierarchy", type="integer", options={"unsigned":true})
  164.          */
  165.         private $hierarchy;
  167.         /**
  168.          * @var int
  169.          *
  170.          * @ORM\Column(name="sort_no", type="integer")
  171.          */
  172.         private $sort_no;
  174.         /**
  175.          * @var \DateTime
  176.          *
  177.          * @ORM\Column(name="create_date", type="datetimetz")
  178.          */
  179.         private $create_date;
  181.         /**
  182.          * @var \DateTime
  183.          *
  184.          * @ORM\Column(name="update_date", type="datetimetz")
  185.          */
  186.         private $update_date;
  188.         /**
  189.          * @var \Doctrine\Common\Collections\Collection
  190.          *
  191.          * @ORM\OneToMany(targetEntity="Eccube\Entity\ProductCategory", mappedBy="Category", fetch="EXTRA_LAZY")
  192.          */
  193.         private $ProductCategories;
  195.         /**
  196.          * @var \Doctrine\Common\Collections\Collection
  197.          *
  198.          * @ORM\OneToMany(targetEntity="Eccube\Entity\Category", mappedBy="Parent")
  199.          * @ORM\OrderBy({
  200.          *     "sort_no"="DESC"
  201.          * })
  202.          */
  203.         private $Children;
  205.         /**
  206.          * @var \Eccube\Entity\Category
  207.          *
  208.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Category", inversedBy="Children")
  209.          * @ORM\JoinColumns({
  210.          *   @ORM\JoinColumn(name="parent_category_id", referencedColumnName="id")
  211.          * })
  212.          */
  213.         private $Parent;
  215.         /**
  216.          * @var \Eccube\Entity\Member
  217.          *
  218.          * @ORM\ManyToOne(targetEntity="Eccube\Entity\Member")
  219.          * @ORM\JoinColumns({
  220.          *   @ORM\JoinColumn(name="creator_id", referencedColumnName="id")
  221.          * })
  222.          */
  223.         private $Creator;
  225.         /**
  226.          * Constructor
  227.          */
  228.         public function __construct()
  229.         {
  230.             $this->ProductCategories = new \Doctrine\Common\Collections\ArrayCollection();
  231.             $this->Children = new \Doctrine\Common\Collections\ArrayCollection();
  232.         }
  234.         /**
  235.          * Get id.
  236.          *
  237.          * @return int
  238.          */
  239.         public function getId()
  240.         {
  241.             return $this->id;
  242.         }
  244.         /**
  245.          * Set name.
  246.          *
  247.          * @param string $name
  248.          *
  249.          * @return Category
  250.          */
  251.         public function setName($name)
  252.         {
  253.             $this->name = $name;
  255.             return $this;
  256.         }
  258.         /**
  259.          * Get name.
  260.          *
  261.          * @return string
  262.          */
  263.         public function getName()
  264.         {
  265.             return $this->name;
  266.         }
  268.         /**
  269.          * Set hierarchy.
  270.          *
  271.          * @param int $hierarchy
  272.          *
  273.          * @return Category
  274.          */
  275.         public function setHierarchy($hierarchy)
  276.         {
  277.             $this->hierarchy = $hierarchy;
  279.             return $this;
  280.         }
  282.         /**
  283.          * Get hierarchy.
  284.          *
  285.          * @return int
  286.          */
  287.         public function getHierarchy()
  288.         {
  289.             return $this->hierarchy;
  290.         }
  292.         /**
  293.          * Set sortNo.
  294.          *
  295.          * @param int $sortNo
  296.          *
  297.          * @return Category
  298.          */
  299.         public function setSortNo($sortNo)
  300.         {
  301.             $this->sort_no = $sortNo;
  303.             return $this;
  304.         }
  306.         /**
  307.          * Get sortNo.
  308.          *
  309.          * @return int
  310.          */
  311.         public function getSortNo()
  312.         {
  313.             return $this->sort_no;
  314.         }
  316.         /**
  317.          * Set createDate.
  318.          *
  319.          * @param \DateTime $createDate
  320.          *
  321.          * @return Category
  322.          */
  323.         public function setCreateDate($createDate)
  324.         {
  325.             $this->create_date = $createDate;
  327.             return $this;
  328.         }
  330.         /**
  331.          * Get createDate.
  332.          *
  333.          * @return \DateTime
  334.          */
  335.         public function getCreateDate()
  336.         {
  337.             return $this->create_date;
  338.         }
  340.         /**
  341.          * Set updateDate.
  342.          *
  343.          * @param \DateTime $updateDate
  344.          *
  345.          * @return Category
  346.          */
  347.         public function setUpdateDate($updateDate)
  348.         {
  349.             $this->update_date = $updateDate;
  351.             return $this;
  352.         }
  354.         /**
  355.          * Get updateDate.
  356.          *
  357.          * @return \DateTime
  358.          */
  359.         public function getUpdateDate()
  360.         {
  361.             return $this->update_date;
  362.         }
  364.         /**
  365.          * Add productCategory.
  366.          *
  367.          * @param \Eccube\Entity\ProductCategory $productCategory
  368.          *
  369.          * @return Category
  370.          */
  371.         public function addProductCategory(ProductCategory $productCategory)
  372.         {
  373.             $this->ProductCategories[] = $productCategory;
  375.             return $this;
  376.         }
  378.         /**
  379.          * Remove productCategory.
  380.          *
  381.          * @param \Eccube\Entity\ProductCategory $productCategory
  382.          *
  383.          * @return boolean TRUE if this collection contained the specified element, FALSE otherwise.
  384.          */
  385.         public function removeProductCategory(ProductCategory $productCategory)
  386.         {
  387.             return $this->ProductCategories->removeElement($productCategory);
  388.         }
  390.         /**
  391.          * Get productCategories.
  392.          *
  393.          * @return \Doctrine\Common\Collections\Collection
  394.          */
  395.         public function getProductCategories()
  396.         {
  397.             return $this->ProductCategories;
  398.         }
  399.         public function setProductCategories($ProductCategories)
  400.         {
  401.             $this->ProductCategories = $ProductCategories;
  402.         }
  404.         /**
  405.          * Add child.
  406.          *
  407.          * @param \Eccube\Entity\Category $child
  408.          *
  409.          * @return Category
  410.          */
  411.         public function addChild(Category $child)
  412.         {
  413.             $this->Children[] = $child;
  415.             return $this;
  416.         }
  418.         /**
  419.          * Remove child.
  420.          *
  421.          * @param \Eccube\Entity\Category $child
  422.          *
  423.          * @return boolean TRUE if this collection contained the specified element, FALSE otherwise.
  424.          */
  425.         public function removeChild(Category $child)
  426.         {
  427.             return $this->Children->removeElement($child);
  428.         }
  430.         /**
  431.          * Get children.
  432.          *
  433.          * @return \Doctrine\Common\Collections\Collection
  434.          */
  435.         public function getChildren()
  436.         {
  437.             return $this->Children;
  438.         }
  439.         public function setChildren($Child)
  440.         {
  441.             $this->Children = $Child;
  442.         }
  444.         /**
  445.          * Set parent.
  446.          *
  447.          * @param \Eccube\Entity\Category|null $parent
  448.          *
  449.          * @return Category
  450.          */
  451.         public function setParent(Category $parent = null)
  452.         {
  453.             $this->Parent = $parent;
  455.             return $this;
  456.         }
  458.         /**
  459.          * Get parent.
  460.          *
  461.          * @return \Eccube\Entity\Category|null
  462.          */
  463.         public function getParent()
  464.         {
  465.             return $this->Parent;
  466.         }
  468.         /**
  469.          * Set creator.
  470.          *
  471.          * @param \Eccube\Entity\Member|null $creator
  472.          *
  473.          * @return Category
  474.          */
  475.         public function setCreator(Member $creator = null)
  476.         {
  477.             $this->Creator = $creator;
  479.             return $this;
  480.         }
  482.         /**
  483.          * Get creator.
  484.          *
  485.          * @return \Eccube\Entity\Member|null
  486.          */
  487.         public function getCreator()
  488.         {
  489.             return $this->Creator;
  490.         }
  491.     }
  492. }