vendor/doctrine/orm/src/Query.php line 234

  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM;
  7. use Doctrine\Common\Cache\Cache;
  8. use Doctrine\Common\Cache\Psr6\CacheAdapter;
  9. use Doctrine\Common\Cache\Psr6\DoctrineProvider;
  10. use Doctrine\Common\Collections\ArrayCollection;
  11. use Doctrine\DBAL\Cache\QueryCacheProfile;
  12. use Doctrine\DBAL\LockMode;
  13. use Doctrine\DBAL\Types\Type;
  14. use Doctrine\Deprecations\Deprecation;
  15. use Doctrine\ORM\Internal\Hydration\IterableResult;
  16. use Doctrine\ORM\Mapping\ClassMetadata;
  17. use Doctrine\ORM\Query\AST\DeleteStatement;
  18. use Doctrine\ORM\Query\AST\SelectStatement;
  19. use Doctrine\ORM\Query\AST\UpdateStatement;
  20. use Doctrine\ORM\Query\Exec\AbstractSqlExecutor;
  21. use Doctrine\ORM\Query\Parameter;
  22. use Doctrine\ORM\Query\ParameterTypeInferer;
  23. use Doctrine\ORM\Query\Parser;
  24. use Doctrine\ORM\Query\ParserResult;
  25. use Doctrine\ORM\Query\QueryException;
  26. use Doctrine\ORM\Query\ResultSetMapping;
  27. use Doctrine\ORM\Utility\HierarchyDiscriminatorResolver;
  28. use Psr\Cache\CacheItemPoolInterface;
  30. use function array_keys;
  31. use function array_values;
  32. use function assert;
  33. use function count;
  34. use function get_debug_type;
  35. use function in_array;
  36. use function is_int;
  37. use function ksort;
  38. use function md5;
  39. use function method_exists;
  40. use function reset;
  41. use function serialize;
  42. use function sha1;
  43. use function stripos;
  45. /**
  46.  * A Query object represents a DQL query.
  47.  *
  48.  * @final
  49.  */
  50. class Query extends AbstractQuery
  51. {
  52.     /**
  53.      * A query object is in CLEAN state when it has NO unparsed/unprocessed DQL parts.
  54.      */
  55.     public const STATE_CLEAN = 1;
  57.     /**
  58.      * A query object is in state DIRTY when it has DQL parts that have not yet been
  59.      * parsed/processed. This is automatically defined as DIRTY when addDqlQueryPart
  60.      * is called.
  61.      */
  62.     public const STATE_DIRTY = 2;
  64.     /* Query HINTS */
  66.     /**
  67.      * The refresh hint turns any query into a refresh query with the result that
  68.      * any local changes in entities are overridden with the fetched values.
  69.      */
  70.     public const HINT_REFRESH = 'doctrine.refresh';
  72.     public const HINT_CACHE_ENABLED = 'doctrine.cache.enabled';
  74.     public const HINT_CACHE_EVICT = 'doctrine.cache.evict';
  76.     /**
  77.      * Internal hint: is set to the proxy entity that is currently triggered for loading
  78.      */
  79.     public const HINT_REFRESH_ENTITY = 'doctrine.refresh.entity';
  81.     /**
  82.      * The forcePartialLoad query hint forces a particular query to return
  83.      * partial objects.
  84.      *
  85.      * @todo Rename: HINT_OPTIMIZE
  86.      */
  87.     public const HINT_FORCE_PARTIAL_LOAD = 'doctrine.forcePartialLoad';
  89.     /**
  90.      * The includeMetaColumns query hint causes meta columns like foreign keys and
  91.      * discriminator columns to be selected and returned as part of the query result.
  92.      *
  93.      * This hint does only apply to non-object queries.
  94.      */
  95.     public const HINT_INCLUDE_META_COLUMNS = 'doctrine.includeMetaColumns';
  97.     /**
  98.      * An array of class names that implement \Doctrine\ORM\Query\TreeWalker and
  99.      * are iterated and executed after the DQL has been parsed into an AST.
  100.      */
  101.     public const HINT_CUSTOM_TREE_WALKERS = 'doctrine.customTreeWalkers';
  103.     /**
  104.      * A string with a class name that implements \Doctrine\ORM\Query\TreeWalker
  105.      * and is used for generating the target SQL from any DQL AST tree.
  106.      */
  107.     public const HINT_CUSTOM_OUTPUT_WALKER = 'doctrine.customOutputWalker';
  109.     /**
  110.      * Marks queries as creating only read only objects.
  111.      *
  112.      * If the object retrieved from the query is already in the identity map
  113.      * then it does not get marked as read only if it wasn't already.
  114.      */
  115.     public const HINT_READ_ONLY = 'doctrine.readOnly';
  117.     public const HINT_INTERNAL_ITERATION = 'doctrine.internal.iteration';
  119.     public const HINT_LOCK_MODE = 'doctrine.lockMode';
  121.     /**
  122.      * The current state of this query.
  123.      *
  124.      * @var int
  125.      * @psalm-var self::STATE_*
  126.      */
  127.     private $state = self::STATE_DIRTY;
  129.     /**
  130.      * A snapshot of the parameter types the query was parsed with.
  131.      *
  132.      * @var array<string,Type>
  133.      */
  134.     private $parsedTypes = [];
  136.     /**
  137.      * Cached DQL query.
  138.      *
  139.      * @var string|null
  140.      */
  141.     private $dql = null;
  143.     /**
  144.      * The parser result that holds DQL => SQL information.
  145.      *
  146.      * @var ParserResult
  147.      */
  148.     private $parserResult;
  150.     /**
  151.      * The first result to return (the "offset").
  152.      *
  153.      * @var int
  154.      */
  155.     private $firstResult = 0;
  157.     /**
  158.      * The maximum number of results to return (the "limit").
  159.      *
  160.      * @var int|null
  161.      */
  162.     private $maxResults = null;
  164.     /**
  165.      * The cache driver used for caching queries.
  166.      *
  167.      * @var CacheItemPoolInterface|null
  168.      */
  169.     private $queryCache;
  171.     /**
  172.      * Whether or not expire the query cache.
  173.      *
  174.      * @var bool
  175.      */
  176.     private $expireQueryCache = false;
  178.     /**
  179.      * The query cache lifetime.
  180.      *
  181.      * @var int|null
  182.      */
  183.     private $queryCacheTTL;
  185.     /**
  186.      * Whether to use a query cache, if available. Defaults to TRUE.
  187.      *
  188.      * @var bool
  189.      */
  190.     private $useQueryCache = true;
  192.     /**
  193.      * Gets the SQL query/queries that correspond to this DQL query.
  194.      *
  195.      * @return list<string>|string The built sql query or an array of all sql queries.
  196.      */
  197.     public function getSQL()
  198.     {
  199.         return $this->parse()->getSqlExecutor()->getSqlStatements();
  200.     }
  202.     /**
  203.      * Returns the corresponding AST for this DQL query.
  204.      *
  205.      * @return SelectStatement|UpdateStatement|DeleteStatement
  206.      */
  207.     public function getAST()
  208.     {
  209.         $parser = new Parser($this);
  211.         return $parser->getAST();
  212.     }
  214.     /**
  215.      * {@inheritDoc}
  216.      *
  217.      * @return ResultSetMapping
  218.      */
  219.     protected function getResultSetMapping()
  220.     {
  221.         // parse query or load from cache
  222.         if ($this->_resultSetMapping === null) {
  223.             $this->_resultSetMapping = $this->parse()->getResultSetMapping();
  224.         }
  226.         return $this->_resultSetMapping;
  227.     }
  229.     /**
  230.      * Parses the DQL query, if necessary, and stores the parser result.
  231.      *
  232.      * Note: Populates $this->_parserResult as a side-effect.
  233.      */
  234.     private function parse(): ParserResult
  235.     {
  236.         $types = [];
  238.         foreach ($this->parameters as $parameter) {
  239.             /** @var Query\Parameter $parameter */
  240.             $types[$parameter->getName()] = $parameter->getType();
  241.         }
  243.         // Return previous parser result if the query and the filter collection are both clean
  244.         if ($this->state === self::STATE_CLEAN && $this->parsedTypes === $types && $this->_em->isFiltersStateClean()) {
  245.             return $this->parserResult;
  246.         }
  248.         $this->state       = self::STATE_CLEAN;
  249.         $this->parsedTypes = $types;
  251.         $queryCache = $this->queryCache ?? $this->_em->getConfiguration()->getQueryCache();
  252.         // Check query cache.
  253.         if (! ($this->useQueryCache && $queryCache)) {
  254.             $parser = new Parser($this);
  256.             $this->parserResult = $parser->parse();
  258.             return $this->parserResult;
  259.         }
  261.         $cacheItem = $queryCache->getItem($this->getQueryCacheId());
  263.         if (! $this->expireQueryCache && $cacheItem->isHit()) {
  264.             $cached = $cacheItem->get();
  265.             if ($cached instanceof ParserResult) {
  266.                 // Cache hit.
  267.                 $this->parserResult = $cached;
  269.                 return $this->parserResult;
  270.             }
  271.         }
  273.         // Cache miss.
  274.         $parser = new Parser($this);
  276.         $this->parserResult = $parser->parse();
  278.         $queryCache->save($cacheItem->set($this->parserResult)->expiresAfter($this->queryCacheTTL));
  280.         return $this->parserResult;
  281.     }
  283.     /**
  284.      * {@inheritDoc}
  285.      */
  286.     protected function _doExecute()
  287.     {
  288.         $executor = $this->parse()->getSqlExecutor();
  290.         if ($this->_queryCacheProfile) {
  291.             $executor->setQueryCacheProfile($this->_queryCacheProfile);
  292.         } else {
  293.             $executor->removeQueryCacheProfile();
  294.         }
  296.         if ($this->_resultSetMapping === null) {
  297.             $this->_resultSetMapping = $this->parserResult->getResultSetMapping();
  298.         }
  300.         // Prepare parameters
  301.         $paramMappings = $this->parserResult->getParameterMappings();
  302.         $paramCount    = count($this->parameters);
  303.         $mappingCount  = count($paramMappings);
  305.         if ($paramCount > $mappingCount) {
  306.             throw QueryException::tooManyParameters($mappingCount, $paramCount);
  307.         }
  309.         if ($paramCount < $mappingCount) {
  310.             throw QueryException::tooFewParameters($mappingCount, $paramCount);
  311.         }
  313.         // evict all cache for the entity region
  314.         if ($this->hasCache && isset($this->_hints[self::HINT_CACHE_EVICT]) && $this->_hints[self::HINT_CACHE_EVICT]) {
  315.             $this->evictEntityCacheRegion();
  316.         }
  318.         [$sqlParams, $types] = $this->processParameterMappings($paramMappings);
  320.         $this->evictResultSetCache(
  321.             $executor,
  322.             $sqlParams,
  323.             $types,
  324.             $this->_em->getConnection()->getParams()
  325.         );
  327.         return $executor->execute($this->_em->getConnection(), $sqlParams, $types);
  328.     }
  330.     /**
  331.      * @param array<string,mixed> $sqlParams
  332.      * @param array<string,Type>  $types
  333.      * @param array<string,mixed> $connectionParams
  334.      */
  335.     private function evictResultSetCache(
  336.         AbstractSqlExecutor $executor,
  337.         array $sqlParams,
  338.         array $types,
  339.         array $connectionParams
  340.     ): void {
  341.         if ($this->_queryCacheProfile === null || ! $this->getExpireResultCache()) {
  342.             return;
  343.         }
  345.         $cache = method_exists(QueryCacheProfile::class, 'getResultCache')
  346.             ? $this->_queryCacheProfile->getResultCache()
  347.             : $this->_queryCacheProfile->getResultCacheDriver();
  349.         assert($cache !== null);
  351.         $statements = (array) $executor->getSqlStatements(); // Type casted since it can either be a string or an array
  353.         foreach ($statements as $statement) {
  354.             $cacheKeys = $this->_queryCacheProfile->generateCacheKeys($statement, $sqlParams, $types, $connectionParams);
  356.             $cache instanceof CacheItemPoolInterface
  357.                 ? $cache->deleteItem(reset($cacheKeys))
  358.                 : $cache->delete(reset($cacheKeys));
  359.         }
  360.     }
  362.     /**
  363.      * Evict entity cache region
  364.      */
  365.     private function evictEntityCacheRegion(): void
  366.     {
  367.         $AST = $this->getAST();
  369.         if ($AST instanceof SelectStatement) {
  370.             throw new QueryException('The hint "HINT_CACHE_EVICT" is not valid for select statements.');
  371.         }
  373.         $className = $AST instanceof DeleteStatement
  374.             ? $AST->deleteClause->abstractSchemaName
  375.             : $AST->updateClause->abstractSchemaName;
  377.         $this->_em->getCache()->evictEntityRegion($className);
  378.     }
  380.     /**
  381.      * Processes query parameter mappings.
  382.      *
  383.      * @param array<list<int>> $paramMappings
  384.      *
  385.      * @return mixed[][]
  386.      * @psalm-return array{0: list<mixed>, 1: array}
  387.      *
  388.      * @throws Query\QueryException
  389.      */
  390.     private function processParameterMappings(array $paramMappings): array
  391.     {
  392.         $sqlParams = [];
  393.         $types     = [];
  395.         foreach ($this->parameters as $parameter) {
  396.             $key = $parameter->getName();
  398.             if (! isset($paramMappings[$key])) {
  399.                 throw QueryException::unknownParameter($key);
  400.             }
  402.             [$value, $type] = $this->resolveParameterValue($parameter);
  404.             foreach ($paramMappings[$key] as $position) {
  405.                 $types[$position] = $type;
  406.             }
  408.             $sqlPositions = $paramMappings[$key];
  410.             // optimized multi value sql positions away for now,
  411.             // they are not allowed in DQL anyways.
  412.             $value      = [$value];
  413.             $countValue = count($value);
  415.             for ($i = 0, $l = count($sqlPositions); $i < $l; $i++) {
  416.                 $sqlParams[$sqlPositions[$i]] = $value[$i % $countValue];
  417.             }
  418.         }
  420.         if (count($sqlParams) !== count($types)) {
  421.             throw QueryException::parameterTypeMismatch();
  422.         }
  424.         if ($sqlParams) {
  425.             ksort($sqlParams);
  426.             $sqlParams = array_values($sqlParams);
  428.             ksort($types);
  429.             $types = array_values($types);
  430.         }
  432.         return [$sqlParams, $types];
  433.     }
  435.     /**
  436.      * @return mixed[] tuple of (value, type)
  437.      * @psalm-return array{0: mixed, 1: mixed}
  438.      */
  439.     private function resolveParameterValue(Parameter $parameter): array
  440.     {
  441.         if ($parameter->typeWasSpecified()) {
  442.             return [$parameter->getValue(), $parameter->getType()];
  443.         }
  445.         $key           = $parameter->getName();
  446.         $originalValue = $parameter->getValue();
  447.         $value         = $originalValue;
  448.         $rsm           = $this->getResultSetMapping();
  450.         if ($value instanceof ClassMetadata && isset($rsm->metadataParameterMapping[$key])) {
  451.             $value = $value->getMetadataValue($rsm->metadataParameterMapping[$key]);
  452.         }
  454.         if ($value instanceof ClassMetadata && isset($rsm->discriminatorParameters[$key])) {
  455.             $value = array_keys(HierarchyDiscriminatorResolver::resolveDiscriminatorsForClass($value, $this->_em));
  456.         }
  458.         $processedValue = $this->processParameterValue($value);
  460.         return [
  461.             $processedValue,
  462.             $originalValue === $processedValue
  463.                 ? $parameter->getType()
  464.                 : ParameterTypeInferer::inferType($processedValue),
  465.         ];
  466.     }
  468.     /**
  469.      * Defines a cache driver to be used for caching queries.
  470.      *
  471.      * @deprecated Call {@see setQueryCache()} instead.
  472.      *
  473.      * @param Cache|null $queryCache Cache driver.
  474.      *
  475.      * @return $this
  476.      */
  477.     public function setQueryCacheDriver($queryCache): self
  478.     {
  479.         Deprecation::trigger(
  480.             'doctrine/orm',
  481.             'https://github.com/doctrine/orm/pull/9004',
  482.             '%s is deprecated and will be removed in Doctrine 3.0. Use setQueryCache() instead.',
  483.             __METHOD__
  484.         );
  486.         $this->queryCache = $queryCache ? CacheAdapter::wrap($queryCache) : null;
  488.         return $this;
  489.     }
  491.     /**
  492.      * Defines a cache driver to be used for caching queries.
  493.      *
  494.      * @return $this
  495.      */
  496.     public function setQueryCache(?CacheItemPoolInterface $queryCache): self
  497.     {
  498.         $this->queryCache = $queryCache;
  500.         return $this;
  501.     }
  503.     /**
  504.      * Defines whether the query should make use of a query cache, if available.
  505.      *
  506.      * @param bool $bool
  507.      *
  508.      * @return $this
  509.      */
  510.     public function useQueryCache($bool): self
  511.     {
  512.         $this->useQueryCache = $bool;
  514.         return $this;
  515.     }
  517.     /**
  518.      * Returns the cache driver used for query caching.
  519.      *
  520.      * @deprecated
  521.      *
  522.      * @return Cache|null The cache driver used for query caching or NULL, if
  523.      * this Query does not use query caching.
  524.      */
  525.     public function getQueryCacheDriver(): ?Cache
  526.     {
  527.         Deprecation::trigger(
  528.             'doctrine/orm',
  529.             'https://github.com/doctrine/orm/pull/9004',
  530.             '%s is deprecated and will be removed in Doctrine 3.0 without replacement.',
  531.             __METHOD__
  532.         );
  534.         $queryCache = $this->queryCache ?? $this->_em->getConfiguration()->getQueryCache();
  536.         return $queryCache ? DoctrineProvider::wrap($queryCache) : null;
  537.     }
  539.     /**
  540.      * Defines how long the query cache will be active before expire.
  541.      *
  542.      * @param int|null $timeToLive How long the cache entry is valid.
  543.      *
  544.      * @return $this
  545.      */
  546.     public function setQueryCacheLifetime($timeToLive): self
  547.     {
  548.         if ($timeToLive !== null) {
  549.             $timeToLive = (int) $timeToLive;
  550.         }
  552.         $this->queryCacheTTL = $timeToLive;
  554.         return $this;
  555.     }
  557.     /**
  558.      * Retrieves the lifetime of resultset cache.
  559.      */
  560.     public function getQueryCacheLifetime(): ?int
  561.     {
  562.         return $this->queryCacheTTL;
  563.     }
  565.     /**
  566.      * Defines if the query cache is active or not.
  567.      *
  568.      * @param bool $expire Whether or not to force query cache expiration.
  569.      *
  570.      * @return $this
  571.      */
  572.     public function expireQueryCache($expire = true): self
  573.     {
  574.         $this->expireQueryCache = $expire;
  576.         return $this;
  577.     }
  579.     /**
  580.      * Retrieves if the query cache is active or not.
  581.      */
  582.     public function getExpireQueryCache(): bool
  583.     {
  584.         return $this->expireQueryCache;
  585.     }
  587.     public function free(): void
  588.     {
  589.         parent::free();
  591.         $this->dql   = null;
  592.         $this->state = self::STATE_CLEAN;
  593.     }
  595.     /**
  596.      * Sets a DQL query string.
  597.      *
  598.      * @param string|null $dqlQuery DQL Query.
  599.      */
  600.     public function setDQL($dqlQuery): self
  601.     {
  602.         if ($dqlQuery === null) {
  603.             Deprecation::trigger(
  604.                 'doctrine/orm',
  605.                 'https://github.com/doctrine/orm/pull/9784',
  606.                 'Calling %s with null is deprecated and will result in a TypeError in Doctrine 3.0',
  607.                 __METHOD__
  608.             );
  610.             return $this;
  611.         }
  613.         $this->dql   = $dqlQuery;
  614.         $this->state = self::STATE_DIRTY;
  616.         return $this;
  617.     }
  619.     /**
  620.      * Returns the DQL query that is represented by this query object.
  621.      */
  622.     public function getDQL(): ?string
  623.     {
  624.         return $this->dql;
  625.     }
  627.     /**
  628.      * Returns the state of this query object
  629.      * By default the type is Doctrine_ORM_Query_Abstract::STATE_CLEAN but if it appears any unprocessed DQL
  630.      * part, it is switched to Doctrine_ORM_Query_Abstract::STATE_DIRTY.
  631.      *
  632.      * @see AbstractQuery::STATE_CLEAN
  633.      * @see AbstractQuery::STATE_DIRTY
  634.      *
  635.      * @return int The query state.
  636.      * @psalm-return self::STATE_* The query state.
  637.      */
  638.     public function getState(): int
  639.     {
  640.         return $this->state;
  641.     }
  643.     /**
  644.      * Method to check if an arbitrary piece of DQL exists
  645.      *
  646.      * @param string $dql Arbitrary piece of DQL to check for.
  647.      */
  648.     public function contains($dql): bool
  649.     {
  650.         return stripos($this->getDQL(), $dql) !== false;
  651.     }
  653.     /**
  654.      * Sets the position of the first result to retrieve (the "offset").
  655.      *
  656.      * @param int|null $firstResult The first result to return.
  657.      *
  658.      * @return $this
  659.      */
  660.     public function setFirstResult($firstResult): self
  661.     {
  662.         if (! is_int($firstResult)) {
  663.             Deprecation::trigger(
  664.                 'doctrine/orm',
  665.                 'https://github.com/doctrine/orm/pull/9809',
  666.                 'Calling %s with %s is deprecated and will result in a TypeError in Doctrine 3.0. Pass an integer.',
  667.                 __METHOD__,
  668.                 get_debug_type($firstResult)
  669.             );
  671.             $firstResult = (int) $firstResult;
  672.         }
  674.         $this->firstResult = $firstResult;
  675.         $this->state       = self::STATE_DIRTY;
  677.         return $this;
  678.     }
  680.     /**
  681.      * Gets the position of the first result the query object was set to retrieve (the "offset").
  682.      * Returns 0 if {@link setFirstResult} was not applied to this query.
  683.      *
  684.      * @return int The position of the first result.
  685.      */
  686.     public function getFirstResult(): int
  687.     {
  688.         return $this->firstResult;
  689.     }
  691.     /**
  692.      * Sets the maximum number of results to retrieve (the "limit").
  693.      *
  694.      * @param int|null $maxResults
  695.      *
  696.      * @return $this
  697.      */
  698.     public function setMaxResults($maxResults): self
  699.     {
  700.         if ($maxResults !== null) {
  701.             $maxResults = (int) $maxResults;
  702.         }
  704.         $this->maxResults = $maxResults;
  705.         $this->state      = self::STATE_DIRTY;
  707.         return $this;
  708.     }
  710.     /**
  711.      * Gets the maximum number of results the query object was set to retrieve (the "limit").
  712.      * Returns NULL if {@link setMaxResults} was not applied to this query.
  713.      *
  714.      * @return int|null Maximum number of results.
  715.      */
  716.     public function getMaxResults(): ?int
  717.     {
  718.         return $this->maxResults;
  719.     }
  721.     /**
  722.      * Executes the query and returns an IterableResult that can be used to incrementally
  723.      * iterated over the result.
  724.      *
  725.      * @deprecated
  726.      *
  727.      * @param ArrayCollection|mixed[]|null $parameters    The query parameters.
  728.      * @param string|int                   $hydrationMode The hydration mode to use.
  729.      * @psalm-param ArrayCollection<int, Parameter>|array<string, mixed>|null $parameters
  730.      * @psalm-param string|AbstractQuery::HYDRATE_*|null                      $hydrationMode
  731.      */
  732.     public function iterate($parameters = null, $hydrationMode = self::HYDRATE_OBJECT): IterableResult
  733.     {
  734.         $this->setHint(self::HINT_INTERNAL_ITERATION, true);
  736.         return parent::iterate($parameters, $hydrationMode);
  737.     }
  739.     /** {@inheritDoc} */
  740.     public function toIterable(iterable $parameters = [], $hydrationMode = self::HYDRATE_OBJECT): iterable
  741.     {
  742.         $this->setHint(self::HINT_INTERNAL_ITERATION, true);
  744.         return parent::toIterable($parameters, $hydrationMode);
  745.     }
  747.     /**
  748.      * {@inheritDoc}
  749.      */
  750.     public function setHint($name, $value): self
  751.     {
  752.         $this->state = self::STATE_DIRTY;
  754.         return parent::setHint($name, $value);
  755.     }
  757.     /**
  758.      * {@inheritDoc}
  759.      */
  760.     public function setHydrationMode($hydrationMode): self
  761.     {
  762.         $this->state = self::STATE_DIRTY;
  764.         return parent::setHydrationMode($hydrationMode);
  765.     }
  767.     /**
  768.      * Set the lock mode for this Query.
  769.      *
  770.      * @see \Doctrine\DBAL\LockMode
  771.      *
  772.      * @param int $lockMode
  773.      * @psalm-param LockMode::* $lockMode
  774.      *
  775.      * @return $this
  776.      *
  777.      * @throws TransactionRequiredException
  778.      */
  779.     public function setLockMode($lockMode): self
  780.     {
  781.         if (in_array($lockMode, [LockMode::NONE, LockMode::PESSIMISTIC_READ, LockMode::PESSIMISTIC_WRITE], true)) {
  782.             if (! $this->_em->getConnection()->isTransactionActive()) {
  783.                 throw TransactionRequiredException::transactionRequired();
  784.             }
  785.         }
  787.         $this->setHint(self::HINT_LOCK_MODE, $lockMode);
  789.         return $this;
  790.     }
  792.     /**
  793.      * Get the current lock mode for this query.
  794.      *
  795.      * @return int|null The current lock mode of this query or NULL if no specific lock mode is set.
  796.      */
  797.     public function getLockMode(): ?int
  798.     {
  799.         $lockMode = $this->getHint(self::HINT_LOCK_MODE);
  801.         if ($lockMode === false) {
  802.             return null;
  803.         }
  805.         return $lockMode;
  806.     }
  808.     /**
  809.      * Generate a cache id for the query cache - reusing the Result-Cache-Id generator.
  810.      */
  811.     protected function getQueryCacheId(): string
  812.     {
  813.         ksort($this->_hints);
  815.         return md5(
  816.             $this->getDQL() . serialize($this->_hints) .
  817.             '&platform=' . get_debug_type($this->getEntityManager()->getConnection()->getDatabasePlatform()) .
  818.             ($this->_em->hasFilters() ? $this->_em->getFilters()->getHash() : '') .
  819.             '&firstResult=' . $this->firstResult . '&maxResult=' . $this->maxResults .
  820.             '&hydrationMode=' . $this->_hydrationMode . '&types=' . serialize($this->parsedTypes) . 'DOCTRINE_QUERY_CACHE_SALT'
  821.         );
  822.     }
  824.     protected function getHash(): string
  825.     {
  826.         return sha1(parent::getHash() . '-' . $this->firstResult . '-' . $this->maxResults);
  827.     }
  829.     /**
  830.      * Cleanup Query resource when clone is called.
  831.      */
  832.     public function __clone()
  833.     {
  834.         parent::__clone();
  836.         $this->state = self::STATE_DIRTY;
  837.     }
  838. }