vendor/sulu/sulu/src/Sulu/Component/DocumentManager/Query/Query.php line 121

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Component\DocumentManager\Query;
  14. use PHPCR\Query\QueryInterface;
  15. use PHPCR\Query\QueryResultInterface;
  16. use Sulu\Component\DocumentManager\Event\QueryExecuteEvent;
  17. use Sulu\Component\DocumentManager\Events;
  18. use Sulu\Component\DocumentManager\Exception\DocumentManagerException;
  19. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  21. /**
  22.  * Based heavily on the PHPCR-ODM Query object.
  23.  *
  24.  * If we can break the phpcrQuery builder from the PHPCR-ODM we should
  25.  * also be able to break-out the PhpcrQuery object too:
  26.  *
  27.  * https://github.com/doctrine/phpcr-odm/issues/627
  28.  */
  29. class Query
  30. {
  31.     public const HYDRATE_DOCUMENT = 'document';
  33.     public const HYDRATE_PHPCR = 'phpcr_node';
  35.     /**
  36.      * @var QueryInterface
  37.      */
  38.     private $phpcrQuery;
  40.     /**
  41.      * @var EventDispatcherInterface
  42.      */
  43.     private $dispatcher;
  45.     /**
  46.      * @var null|string
  47.      */
  48.     private $primarySelector;
  50.     /**
  51.      * @var null|string
  52.      */
  53.     private $locale;
  55.     /**
  56.      * @var array
  57.      */
  58.     private $options;
  60.     /**
  61.      * @var int
  62.      */
  63.     private $maxResults;
  65.     /**
  66.      * @var int
  67.      */
  68.     private $firstResult;
  70.     /**
  71.      * @param null|string $locale
  72.      * @param null|string $primarySelector
  73.      */
  74.     public function __construct(
  75.         QueryInterface $phpcrQuery,
  76.         EventDispatcherInterface $dispatcher,
  77.         $locale = null,
  78.         array $options = [],
  79.         $primarySelector = null
  80.     ) {
  81.         $this->phpcrQuery = $phpcrQuery;
  82.         $this->dispatcher = $dispatcher;
  83.         $this->locale = $locale;
  84.         $this->options = $options;
  85.         $this->primarySelector = $primarySelector;
  86.     }
  88.     /**
  89.      * @param string $hydrationMode
  90.      *
  91.      * @return mixed|QueryResultInterface
  92.      *
  93.      * @throws DocumentManagerException
  94.      */
  95.     public function execute(array $parameters = [], $hydrationMode = self::HYDRATE_DOCUMENT)
  96.     {
  97.         if (null !== $this->maxResults) {
  98.             $this->phpcrQuery->setLimit($this->maxResults);
  99.         }
  101.         if (null !== $this->firstResult) {
  102.             $this->phpcrQuery->setOffset($this->firstResult);
  103.         }
  105.         foreach ($parameters as $key => $value) {
  106.             $this->phpcrQuery->bindValue($key, $value);
  107.         }
  109.         if (self::HYDRATE_PHPCR === $hydrationMode) {
  110.             return $this->phpcrQuery->execute();
  111.         }
  113.         if (self::HYDRATE_DOCUMENT !== $hydrationMode) {
  114.             throw new DocumentManagerException(\sprintf(
  115.                 'Unknown hydration mode "%s", should be either "document" or "phpcr_node"',
  116.                 $hydrationMode
  117.             ));
  118.         }
  120.         $event = new QueryExecuteEvent($this, $this->options);
  121.         $this->dispatcher->dispatch($event, Events::QUERY_EXECUTE);
  123.         return $event->getResult();
  124.     }
  126.     /**
  127.      * @return int
  128.      */
  129.     public function getMaxResults()
  130.     {
  131.         return $this->maxResults;
  132.     }
  134.     /**
  135.      * @param int $maxResults
  136.      */
  137.     public function setMaxResults($maxResults)
  138.     {
  139.         $this->maxResults = $maxResults;
  140.     }
  142.     /**
  143.      * @return int
  144.      */
  145.     public function getFirstResult()
  146.     {
  147.         return $this->firstResult;
  148.     }
  150.     /**
  151.      * @param int $firstResult
  152.      */
  153.     public function setFirstResult($firstResult)
  154.     {
  155.         $this->firstResult = $firstResult;
  156.     }
  158.     /**
  159.      * @return null|string
  160.      */
  161.     public function getLocale()
  162.     {
  163.         return $this->locale;
  164.     }
  166.     /**
  167.      * @param string $locale
  168.      */
  169.     public function setLocale($locale)
  170.     {
  171.         $this->locale = $locale;
  172.     }
  174.     /**
  175.      * @return null|string
  176.      */
  177.     public function getPrimarySelector()
  178.     {
  179.         return $this->primarySelector;
  180.     }
  182.     /**
  183.      * @param string $primarySelector
  184.      */
  185.     public function setPrimarySelector($primarySelector)
  186.     {
  187.         $this->primarySelector = $primarySelector;
  188.     }
  190.     /**
  191.      * @return QueryInterface
  192.      */
  193.     public function getPhpcrQuery()
  194.     {
  195.         return $this->phpcrQuery;
  196.     }
  197. }