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

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 Sulu\Component\DocumentManager\Event\QueryExecuteEvent;
  16. use Sulu\Component\DocumentManager\Events;
  17. use Sulu\Component\DocumentManager\Exception\DocumentManagerException;
  18. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  20. /**
  21.  * Based heavily on the PHPCR-ODM Query object.
  22.  *
  23.  * If we can break the phpcrQuery builder from the PHPCR-ODM we should
  24.  * also be able to break-out the PhpcrQuery object too:
  25.  *
  26.  * https://github.com/doctrine/phpcr-odm/issues/627
  27.  */
  28. class Query
  29. {
  30.     public const HYDRATE_DOCUMENT = 'document';
  32.     public const HYDRATE_PHPCR = 'phpcr_node';
  34.     /**
  35.      * @var QueryInterface
  36.      */
  37.     private $phpcrQuery;
  39.     /**
  40.      * @var EventDispatcherInterface
  41.      */
  42.     private $dispatcher;
  44.     /**
  45.      * @var null|string
  46.      */
  47.     private $primarySelector;
  49.     /**
  50.      * @var null|string
  51.      */
  52.     private $locale;
  54.     /**
  55.      * @var array
  56.      */
  57.     private $options;
  59.     /**
  60.      * @var int
  61.      */
  62.     private $maxResults;
  64.     /**
  65.      * @var int
  66.      */
  67.     private $firstResult;
  69.     /**
  70.      * @param null|string $locale
  71.      * @param null|string $primarySelector
  72.      */
  73.     public function __construct(
  74.         QueryInterface $phpcrQuery,
  75.         EventDispatcherInterface $dispatcher,
  76.         $locale = null,
  77.         array $options = [],
  78.         $primarySelector = null
  79.     ) {
  80.         $this->phpcrQuery = $phpcrQuery;
  81.         $this->dispatcher = $dispatcher;
  82.         $this->locale = $locale;
  83.         $this->options = $options;
  84.         $this->primarySelector = $primarySelector;
  85.     }
  87.     /**
  88.      * @param string $hydrationMode
  89.      *
  90.      * @return mixed|\PHPCR\Query\QueryResultInterface
  91.      *
  92.      * @throws DocumentManagerException
  93.      */
  94.     public function execute(array $parameters = [], $hydrationMode = self::HYDRATE_DOCUMENT)
  95.     {
  96.         if (null !== $this->maxResults) {
  97.             $this->phpcrQuery->setLimit($this->maxResults);
  98.         }
  100.         if (null !== $this->firstResult) {
  101.             $this->phpcrQuery->setOffset($this->firstResult);
  102.         }
  104.         foreach ($parameters as $key => $value) {
  105.             $this->phpcrQuery->bindValue($key, $value);
  106.         }
  108.         if (self::HYDRATE_PHPCR === $hydrationMode) {
  109.             return $this->phpcrQuery->execute();
  110.         }
  112.         if (self::HYDRATE_DOCUMENT !== $hydrationMode) {
  113.             throw new DocumentManagerException(\sprintf(
  114.                 'Unknown hydration mode "%s", should be either "document" or "phpcr_node"',
  115.                 $hydrationMode
  116.             ));
  117.         }
  119.         $event = new QueryExecuteEvent($this, $this->options);
  120.         $this->dispatcher->dispatch($event, Events::QUERY_EXECUTE);
  122.         return $event->getResult();
  123.     }
  125.     /**
  126.      * @return int
  127.      */
  128.     public function getMaxResults()
  129.     {
  130.         return $this->maxResults;
  131.     }
  133.     /**
  134.      * @param int $maxResults
  135.      */
  136.     public function setMaxResults($maxResults)
  137.     {
  138.         $this->maxResults = $maxResults;
  139.     }
  141.     /**
  142.      * @return int
  143.      */
  144.     public function getFirstResult()
  145.     {
  146.         return $this->firstResult;
  147.     }
  149.     /**
  150.      * @param int $firstResult
  151.      */
  152.     public function setFirstResult($firstResult)
  153.     {
  154.         $this->firstResult = $firstResult;
  155.     }
  157.     /**
  158.      * @return null|string
  159.      */
  160.     public function getLocale()
  161.     {
  162.         return $this->locale;
  163.     }
  165.     /**
  166.      * @param string $locale
  167.      */
  168.     public function setLocale($locale)
  169.     {
  170.         $this->locale = $locale;
  171.     }
  173.     /**
  174.      * @return null|string
  175.      */
  176.     public function getPrimarySelector()
  177.     {
  178.         return $this->primarySelector;
  179.     }
  181.     /**
  182.      * @param string $primarySelector
  183.      */
  184.     public function setPrimarySelector($primarySelector)
  185.     {
  186.         $this->primarySelector = $primarySelector;
  187.     }
  189.     /**
  190.      * @return QueryInterface
  191.      */
  192.     public function getPhpcrQuery()
  193.     {
  194.         return $this->phpcrQuery;
  195.     }
  196. }