vendor/gedmo/doctrine-extensions/src/Tree/Entity/Repository/AbstractTreeRepository.php line 45

  1. <?php
  3. /*
  4. * This file is part of the Doctrine Behavioral Extensions package.
  5. * (c) Gediminas Morkevicius <gediminas.morkevicius@gmail.com> http://www.gediminasm.org
  6. * For the full copyright and license information, please view the LICENSE
  7. * file that was distributed with this source code.
  8. */
  10. namespace Gedmo\Tree\Entity\Repository;
  12. use Doctrine\ORM\EntityManagerInterface;
  13. use Doctrine\ORM\EntityRepository;
  14. use Doctrine\ORM\Mapping\ClassMetadata;
  15. use Doctrine\ORM\Query;
  16. use Doctrine\ORM\QueryBuilder;
  17. use Gedmo\Exception\InvalidArgumentException;
  18. use Gedmo\Exception\InvalidMappingException;
  19. use Gedmo\Tool\Wrapper\EntityWrapper;
  20. use Gedmo\Tree\RepositoryInterface;
  21. use Gedmo\Tree\RepositoryUtils;
  22. use Gedmo\Tree\RepositoryUtilsInterface;
  23. use Gedmo\Tree\TreeListener;
  25. /**
  26. * @template T of object
  27. *
  28. * @template-extends EntityRepository<T>
  29. *
  30. * @template-implements RepositoryInterface<T>
  31. */
  32. abstract class AbstractTreeRepository extends EntityRepository implements RepositoryInterface
  33. {
  34. /**
  35. * Tree listener on event manager
  36. *
  37. * @var TreeListener
  38. */
  39. protected $listener;
  41. /**
  42. * Repository utils
  43. *
  44. * @var RepositoryUtilsInterface
  45. */
  46. protected $repoUtils;
  48. /** @param ClassMetadata<T> $class */
  49. public function __construct(EntityManagerInterface $em, ClassMetadata $class)
  50. {
  51. parent::__construct($em, $class);
  52. $treeListener = null;
  53. foreach ($em->getEventManager()->getAllListeners() as $listeners) {
  54. foreach ($listeners as $listener) {
  55. if ($listener instanceof TreeListener) {
  56. $treeListener = $listener;
  58. break 2;
  59. }
  60. }
  61. }
  63. if (null === $treeListener) {
  64. throw new InvalidMappingException('Tree listener was not found on your entity manager, it must be hooked into the event manager');
  65. }
  67. $this->listener = $treeListener;
  68. if (!$this->validate()) {
  69. throw new InvalidMappingException('This repository cannot be used for tree type: '.$treeListener->getStrategy($em, $class->getName())->getName());
  70. }
  72. $this->repoUtils = new RepositoryUtils($this->getEntityManager(), $this->getClassMetadata(), $this->listener, $this);
  73. }
  75. /**
  76. * Sets the RepositoryUtilsInterface instance
  77. *
  78. * @return static
  79. */
  80. public function setRepoUtils(RepositoryUtilsInterface $repoUtils)
  81. {
  82. $this->repoUtils = $repoUtils;
  84. return $this;
  85. }
  87. /**
  88. * Returns the RepositoryUtilsInterface instance
  89. *
  90. * @return RepositoryUtilsInterface|null
  91. */
  92. public function getRepoUtils()
  93. {
  94. return $this->repoUtils;
  95. }
  97. public function childCount($node = null, $direct = false)
  98. {
  99. $meta = $this->getClassMetadata();
  101. if (is_object($node)) {
  102. if (!is_a($node, $meta->getName())) {
  103. throw new InvalidArgumentException('Node is not related to this repository');
  104. }
  106. $wrapped = new EntityWrapper($node, $this->getEntityManager());
  108. if (!$wrapped->hasValidIdentifier()) {
  109. throw new InvalidArgumentException('Node is not managed by UnitOfWork');
  110. }
  111. }
  113. $qb = $this->getChildrenQueryBuilder($node, $direct);
  115. // We need to remove the ORDER BY DQL part since some vendors could throw an error
  116. // in count queries
  117. $dqlParts = $qb->getDQLParts();
  119. // We need to check first if there's an ORDER BY DQL part, because resetDQLPart doesn't
  120. // check if its internal array has an "orderby" index
  121. if (isset($dqlParts['orderBy'])) {
  122. $qb->resetDQLPart('orderBy');
  123. }
  125. $aliases = $qb->getRootAliases();
  126. $alias = $aliases[0];
  128. $qb->select('COUNT('.$alias.')');
  130. return (int) $qb->getQuery()->getSingleScalarResult();
  131. }
  133. /**
  134. * @see RepositoryUtilsInterface::childrenHierarchy
  135. */
  136. public function childrenHierarchy($node = null, $direct = false, array $options = [], $includeNode = false)
  137. {
  138. return $this->repoUtils->childrenHierarchy($node, $direct, $options, $includeNode);
  139. }
  141. /**
  142. * @see RepositoryUtilsInterface::buildTree
  143. */
  144. public function buildTree(array $nodes, array $options = [])
  145. {
  146. return $this->repoUtils->buildTree($nodes, $options);
  147. }
  149. /**
  150. * @see RepositoryUtilsInterface::buildTreeArray
  151. */
  152. public function buildTreeArray(array $nodes)
  153. {
  154. return $this->repoUtils->buildTreeArray($nodes);
  155. }
  157. /**
  158. * @see RepositoryUtilsInterface::setChildrenIndex
  159. */
  160. public function setChildrenIndex($childrenIndex)
  161. {
  162. $this->repoUtils->setChildrenIndex($childrenIndex);
  163. }
  165. /**
  166. * @see RepositoryUtilsInterface::getChildrenIndex
  167. */
  168. public function getChildrenIndex()
  169. {
  170. return $this->repoUtils->getChildrenIndex();
  171. }
  173. /**
  174. * Get all root nodes query builder
  175. *
  176. * @param string|string[]|null $sortByField Sort by field
  177. * @param string|string[] $direction Sort direction ("asc" or "desc")
  178. *
  179. * @return QueryBuilder QueryBuilder object
  180. */
  181. abstract public function getRootNodesQueryBuilder($sortByField = null, $direction = 'asc');
  183. /**
  184. * Get all root nodes query
  185. *
  186. * @param string|string[]|null $sortByField Sort by field
  187. * @param string|string[] $direction Sort direction ("asc" or "desc")
  188. *
  189. * @return Query Query object
  190. */
  191. abstract public function getRootNodesQuery($sortByField = null, $direction = 'asc');
  193. /**
  194. * Returns a QueryBuilder configured to return an array of nodes suitable for buildTree method
  195. *
  196. * @param object $node Root node
  197. * @param bool $direct Obtain direct children?
  198. * @param array<string, mixed> $options Options
  199. * @param bool $includeNode Include node in results?
  200. *
  201. * @return QueryBuilder QueryBuilder object
  202. */
  203. abstract public function getNodesHierarchyQueryBuilder($node = null, $direct = false, array $options = [], $includeNode = false);
  205. /**
  206. * Returns a Query configured to return an array of nodes suitable for buildTree method
  207. *
  208. * @param object $node Root node
  209. * @param bool $direct Obtain direct children?
  210. * @param array<string, mixed> $options Options
  211. * @param bool $includeNode Include node in results?
  212. *
  213. * @return Query Query object
  214. */
  215. abstract public function getNodesHierarchyQuery($node = null, $direct = false, array $options = [], $includeNode = false);
  217. /**
  218. * Get list of children followed by given $node. This returns a QueryBuilder object
  219. *
  220. * @param object|null $node If null, all tree nodes will be taken
  221. * @param bool $direct True to take only direct children
  222. * @param string|string[]|null $sortByField Field name or array of fields names to sort by
  223. * @param string|string[] $direction Sort order ('asc'|'desc'|'ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
  224. * @param bool $includeNode Include the root node in results?
  225. *
  226. * @return QueryBuilder QueryBuilder object
  227. *
  228. * @phpstan-param 'asc'|'desc'|'ASC'|'DESC'|array<int, 'asc'|'desc'|'ASC'|'DESC'> $direction
  229. */
  230. abstract public function getChildrenQueryBuilder($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false);
  232. /**
  233. * Get list of children followed by given $node. This returns a Query
  234. *
  235. * @param object|null $node If null, all tree nodes will be taken
  236. * @param bool $direct True to take only direct children
  237. * @param string|string[]|null $sortByField Field name or array of fields names to sort by
  238. * @param string|string[] $direction Sort order ('asc'|'desc'|'ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
  239. * @param bool $includeNode Include the root node in results?
  240. *
  241. * @return Query Query object
  242. *
  243. * @phpstan-param 'asc'|'desc'|'ASC'|'DESC'|array<int, 'asc'|'desc'|'ASC'|'DESC'> $direction
  244. */
  245. abstract public function getChildrenQuery($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false);
  247. /**
  248. * @return QueryBuilder
  249. */
  250. protected function getQueryBuilder()
  251. {
  252. return $this->getEntityManager()->createQueryBuilder();
  253. }
  255. /**
  256. * Checks if current repository is right
  257. * for currently used tree strategy
  258. *
  259. * @return bool
  260. */
  261. abstract protected function validate();
  262. }