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

  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\Tool\Wrapper\EntityWrapper;
  19. use Gedmo\Tree\RepositoryInterface;
  20. use Gedmo\Tree\RepositoryUtils;
  21. use Gedmo\Tree\RepositoryUtilsInterface;
  22. use Gedmo\Tree\TreeListener;
  24. abstract class AbstractTreeRepository extends EntityRepository implements RepositoryInterface
  25. {
  26.     /**
  27.      * Tree listener on event manager
  28.      *
  29.      * @var TreeListener
  30.      */
  31.     protected $listener;
  33.     /**
  34.      * Repository utils
  35.      *
  36.      * @var RepositoryUtilsInterface
  37.      */
  38.     protected $repoUtils;
  40.     public function __construct(EntityManagerInterface $em, ClassMetadata $class)
  41.     {
  42.         parent::__construct($em, $class);
  43.         $treeListener = null;
  44.         foreach ($em->getEventManager()->getAllListeners() as $listeners) {
  45.             foreach ($listeners as $listener) {
  46.                 if ($listener instanceof TreeListener) {
  47.                     $treeListener = $listener;
  49.                     break 2;
  50.                 }
  51.             }
  52.         }
  54.         if (null === $treeListener) {
  55.             throw new \Gedmo\Exception\InvalidMappingException('Tree listener was not found on your entity manager, it must be hooked into the event manager');
  56.         }
  58.         $this->listener = $treeListener;
  59.         if (!$this->validate()) {
  60.             throw new \Gedmo\Exception\InvalidMappingException('This repository cannot be used for tree type: '.$treeListener->getStrategy($em, $class->getName())->getName());
  61.         }
  63.         $this->repoUtils = new RepositoryUtils($this->_em, $this->getClassMetadata(), $this->listener, $this);
  64.     }
  66.     /**
  67.      * Sets the RepositoryUtilsInterface instance
  68.      *
  69.      * @return static
  70.      */
  71.     public function setRepoUtils(RepositoryUtilsInterface $repoUtils)
  72.     {
  73.         $this->repoUtils = $repoUtils;
  75.         return $this;
  76.     }
  78.     /**
  79.      * Returns the RepositoryUtilsInterface instance
  80.      *
  81.      * @return \Gedmo\Tree\RepositoryUtilsInterface|null
  82.      */
  83.     public function getRepoUtils()
  84.     {
  85.         return $this->repoUtils;
  86.     }
  88.     public function childCount($node = null, $direct = false)
  89.     {
  90.         $meta = $this->getClassMetadata();
  92.         if (is_object($node)) {
  93.             if (!is_a($node, $meta->getName())) {
  94.                 throw new InvalidArgumentException('Node is not related to this repository');
  95.             }
  97.             $wrapped = new EntityWrapper($node, $this->_em);
  99.             if (!$wrapped->hasValidIdentifier()) {
  100.                 throw new InvalidArgumentException('Node is not managed by UnitOfWork');
  101.             }
  102.         }
  104.         $qb = $this->getChildrenQueryBuilder($node, $direct);
  106.         // We need to remove the ORDER BY DQL part since some vendors could throw an error
  107.         // in count queries
  108.         $dqlParts = $qb->getDQLParts();
  110.         // We need to check first if there's an ORDER BY DQL part, because resetDQLPart doesn't
  111.         // check if its internal array has an "orderby" index
  112.         if (isset($dqlParts['orderBy'])) {
  113.             $qb->resetDQLPart('orderBy');
  114.         }
  116.         $aliases = $qb->getRootAliases();
  117.         $alias = $aliases[0];
  119.         $qb->select('COUNT('.$alias.')');
  121.         return (int) $qb->getQuery()->getSingleScalarResult();
  122.     }
  124.     /**
  125.      * @see \Gedmo\Tree\RepositoryUtilsInterface::childrenHierarchy
  126.      */
  127.     public function childrenHierarchy($node = null, $direct = false, array $options = [], $includeNode = false)
  128.     {
  129.         return $this->repoUtils->childrenHierarchy($node, $direct, $options, $includeNode);
  130.     }
  132.     /**
  133.      * @see \Gedmo\Tree\RepositoryUtilsInterface::buildTree
  134.      */
  135.     public function buildTree(array $nodes, array $options = [])
  136.     {
  137.         return $this->repoUtils->buildTree($nodes, $options);
  138.     }
  140.     /**
  141.      * @see \Gedmo\Tree\RepositoryUtilsInterface::buildTreeArray
  142.      */
  143.     public function buildTreeArray(array $nodes)
  144.     {
  145.         return $this->repoUtils->buildTreeArray($nodes);
  146.     }
  148.     /**
  149.      * @see \Gedmo\Tree\RepositoryUtilsInterface::setChildrenIndex
  150.      */
  151.     public function setChildrenIndex($childrenIndex)
  152.     {
  153.         $this->repoUtils->setChildrenIndex($childrenIndex);
  154.     }
  156.     /**
  157.      * @see \Gedmo\Tree\RepositoryUtilsInterface::getChildrenIndex
  158.      */
  159.     public function getChildrenIndex()
  160.     {
  161.         return $this->repoUtils->getChildrenIndex();
  162.     }
  164.     /**
  165.      * Get all root nodes query builder
  166.      *
  167.      * @param string|null $sortByField Sort by field
  168.      * @param string      $direction   Sort direction ("asc" or "desc")
  169.      *
  170.      * @return QueryBuilder QueryBuilder object
  171.      */
  172.     abstract public function getRootNodesQueryBuilder($sortByField = null, $direction = 'asc');
  174.     /**
  175.      * Get all root nodes query
  176.      *
  177.      * @param string|null $sortByField Sort by field
  178.      * @param string      $direction   Sort direction ("asc" or "desc")
  179.      *
  180.      * @return Query Query object
  181.      */
  182.     abstract public function getRootNodesQuery($sortByField = null, $direction = 'asc');
  184.     /**
  185.      * Returns a QueryBuilder configured to return an array of nodes suitable for buildTree method
  186.      *
  187.      * @param object $node        Root node
  188.      * @param bool   $direct      Obtain direct children?
  189.      * @param array  $options     Options
  190.      * @param bool   $includeNode Include node in results?
  191.      *
  192.      * @return QueryBuilder QueryBuilder object
  193.      */
  194.     abstract public function getNodesHierarchyQueryBuilder($node = null, $direct = false, array $options = [], $includeNode = false);
  196.     /**
  197.      * Returns a Query configured to return an array of nodes suitable for buildTree method
  198.      *
  199.      * @param object $node        Root node
  200.      * @param bool   $direct      Obtain direct children?
  201.      * @param array  $options     Options
  202.      * @param bool   $includeNode Include node in results?
  203.      *
  204.      * @return Query Query object
  205.      */
  206.     abstract public function getNodesHierarchyQuery($node = null, $direct = false, array $options = [], $includeNode = false);
  208.     /**
  209.      * Get list of children followed by given $node. This returns a QueryBuilder object
  210.      *
  211.      * @param object|null          $node        If null, all tree nodes will be taken
  212.      * @param bool                 $direct      True to take only direct children
  213.      * @param string|string[]|null $sortByField Field name or array of fields names to sort by
  214.      * @param string|string[]      $direction   Sort order ('ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
  215.      * @param bool                 $includeNode Include the root node in results?
  216.      *
  217.      * @return QueryBuilder QueryBuilder object
  218.      */
  219.     abstract public function getChildrenQueryBuilder($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false);
  221.     /**
  222.      * Get list of children followed by given $node. This returns a Query
  223.      *
  224.      * @param object|null          $node        If null, all tree nodes will be taken
  225.      * @param bool                 $direct      True to take only direct children
  226.      * @param string|string[]|null $sortByField Field name or array of fields names to sort by
  227.      * @param string|string[]      $direction   Sort order ('ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
  228.      * @param bool                 $includeNode Include the root node in results?
  229.      *
  230.      * @return Query Query object
  231.      */
  232.     abstract public function getChildrenQuery($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false);
  234.     /**
  235.      * @return QueryBuilder
  236.      */
  237.     protected function getQueryBuilder()
  238.     {
  239.         return $this->getEntityManager()->createQueryBuilder();
  240.     }
  242.     /**
  243.      * Checks if current repository is right
  244.      * for currently used tree strategy
  245.      *
  246.      * @return bool
  247.      */
  248.     abstract protected function validate();
  249. }