Completed
Push — master ( a557c9...7c6c5d )
by Luís
09:36 queued 01:11
created

SqlWalker::getSQLColumnAlias()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
c 0
b 0
f 0
ccs 2
cts 2
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 1
crap 1
1
<?php
2
/*
3
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
 *
15
 * This software consists of voluntary contributions made by many individuals
16
 * and is licensed under the MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
18
 */
19
20
namespace Doctrine\ORM\Query;
21
22
use Doctrine\DBAL\LockMode;
23
use Doctrine\DBAL\Types\Type;
24
use Doctrine\ORM\Mapping\ClassMetadata;
25
use Doctrine\ORM\Mapping\ClassMetadataInfo;
26
use Doctrine\ORM\OptimisticLockException;
27
use Doctrine\ORM\Query;
28
use Doctrine\ORM\Utility\PersisterHelper;
29
30
/**
31
 * The SqlWalker is a TreeWalker that walks over a DQL AST and constructs
32
 * the corresponding SQL.
33
 *
34
 * @author Guilherme Blanco <[email protected]>
35
 * @author Roman Borschel <[email protected]>
36
 * @author Benjamin Eberlei <[email protected]>
37
 * @author Alexander <[email protected]>
38
 * @author Fabio B. Silva <[email protected]>
39
 * @since  2.0
40
 * @todo Rename: SQLWalker
41
 */
42
class SqlWalker implements TreeWalker
43
{
44
    /**
45
     * @var string
46
     */
47
    const HINT_DISTINCT = 'doctrine.distinct';
48
49
    /**
50
     * @var ResultSetMapping
51
     */
52
    private $rsm;
53
54
    /**
55
     * Counter for generating unique column aliases.
56
     *
57
     * @var integer
58
     */
59
    private $aliasCounter = 0;
60
61
    /**
62
     * Counter for generating unique table aliases.
63
     *
64
     * @var integer
65
     */
66
    private $tableAliasCounter = 0;
67
68
    /**
69
     * Counter for generating unique scalar result.
70
     *
71
     * @var integer
72
     */
73
    private $scalarResultCounter = 1;
74
75
    /**
76
     * Counter for generating unique parameter indexes.
77
     *
78
     * @var integer
79
     */
80
    private $sqlParamIndex = 0;
81
82
    /**
83
     * Counter for generating indexes.
84
     *
85
     * @var integer
86
     */
87
    private $newObjectCounter = 0;
88
89
    /**
90
     * @var ParserResult
91
     */
92
    private $parserResult;
93
94
    /**
95
     * @var \Doctrine\ORM\EntityManager
96
     */
97
    private $em;
98
99
    /**
100
     * @var \Doctrine\DBAL\Connection
101
     */
102
    private $conn;
103
104
    /**
105
     * @var \Doctrine\ORM\AbstractQuery
106
     */
107
    private $query;
108
109
    /**
110
     * @var array
111
     */
112
    private $tableAliasMap = [];
113
114
    /**
115
     * Map from result variable names to their SQL column alias names.
116
     *
117
     * @var array
118
     */
119
    private $scalarResultAliasMap = [];
120
121
    /**
122
     * Map from Table-Alias + Column-Name to OrderBy-Direction.
123
     *
124
     * @var array
125
     */
126
    private $orderedColumnsMap = [];
127
128
    /**
129
     * Map from DQL-Alias + Field-Name to SQL Column Alias.
130
     *
131
     * @var array
132
     */
133
    private $scalarFields = [];
134
135
    /**
136
     * Map of all components/classes that appear in the DQL query.
137
     *
138
     * @var array
139
     */
140
    private $queryComponents;
141
142
    /**
143
     * A list of classes that appear in non-scalar SelectExpressions.
144
     *
145
     * @var array
146
     */
147
    private $selectedClasses = [];
148
149
    /**
150
     * The DQL alias of the root class of the currently traversed query.
151
     *
152
     * @var array
153
     */
154
    private $rootAliases = [];
155
156
    /**
157
     * Flag that indicates whether to generate SQL table aliases in the SQL.
158
     * These should only be generated for SELECT queries, not for UPDATE/DELETE.
159
     *
160
     * @var boolean
161
     */
162
    private $useSqlTableAliases = true;
163
164
    /**
165
     * The database platform abstraction.
166
     *
167
     * @var \Doctrine\DBAL\Platforms\AbstractPlatform
168
     */
169
    private $platform;
170
171
    /**
172
     * The quote strategy.
173
     *
174
     * @var \Doctrine\ORM\Mapping\QuoteStrategy
175
     */
176
    private $quoteStrategy;
177
178
    /**
179
     * {@inheritDoc}
180
     */
181 679
    public function __construct($query, $parserResult, array $queryComponents)
182
    {
183 679
        $this->query            = $query;
184 679
        $this->parserResult     = $parserResult;
185 679
        $this->queryComponents  = $queryComponents;
186 679
        $this->rsm              = $parserResult->getResultSetMapping();
187 679
        $this->em               = $query->getEntityManager();
188 679
        $this->conn             = $this->em->getConnection();
189 679
        $this->platform         = $this->conn->getDatabasePlatform();
190 679
        $this->quoteStrategy    = $this->em->getConfiguration()->getQuoteStrategy();
191 679
    }
192
193
    /**
194
     * Gets the Query instance used by the walker.
195
     *
196
     * @return Query.
0 ignored issues
show
Documentation introduced by
The doc-type Query. could not be parsed: Unknown type name "Query." at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
197
     */
198
    public function getQuery()
199
    {
200
        return $this->query;
201
    }
202
203
    /**
204
     * Gets the Connection used by the walker.
205
     *
206
     * @return \Doctrine\DBAL\Connection
207
     */
208 35
    public function getConnection()
209
    {
210 35
        return $this->conn;
211
    }
212
213
    /**
214
     * Gets the EntityManager used by the walker.
215
     *
216
     * @return \Doctrine\ORM\EntityManager
217
     */
218 21
    public function getEntityManager()
219
    {
220 21
        return $this->em;
221
    }
222
223
    /**
224
     * Gets the information about a single query component.
225
     *
226
     * @param string $dqlAlias The DQL alias.
227
     *
228
     * @return array
229
     */
230 17
    public function getQueryComponent($dqlAlias)
231
    {
232 17
        return $this->queryComponents[$dqlAlias];
233
    }
234
235
    /**
236
     * {@inheritdoc}
237
     */
238
    public function getQueryComponents()
239
    {
240
        return $this->queryComponents;
241
    }
242
243
    /**
244
     * {@inheritdoc}
245
     */
246 1
    public function setQueryComponent($dqlAlias, array $queryComponent)
247
    {
248 1
        $requiredKeys = ['metadata', 'parent', 'relation', 'map', 'nestingLevel', 'token'];
249
250 1
        if (array_diff($requiredKeys, array_keys($queryComponent))) {
251 1
            throw QueryException::invalidQueryComponent($dqlAlias);
252
        }
253
254
        $this->queryComponents[$dqlAlias] = $queryComponent;
255
    }
256
257
    /**
258
     * {@inheritdoc}
259
     */
260 673
    public function getExecutor($AST)
261
    {
262
        switch (true) {
263 673
            case ($AST instanceof AST\DeleteStatement):
264 38
                $primaryClass = $this->em->getClassMetadata($AST->deleteClause->abstractSchemaName);
265
266 38
                return ($primaryClass->isInheritanceTypeJoined())
267 2
                    ? new Exec\MultiTableDeleteExecutor($AST, $this)
268 38
                    : new Exec\SingleTableDeleteUpdateExecutor($AST, $this);
269
270 615
            case ($AST instanceof AST\UpdateStatement):
271 27
                $primaryClass = $this->em->getClassMetadata($AST->updateClause->abstractSchemaName);
272
273 27
                return ($primaryClass->isInheritanceTypeJoined())
274 3
                    ? new Exec\MultiTableUpdateExecutor($AST, $this)
275 27
                    : new Exec\SingleTableDeleteUpdateExecutor($AST, $this);
276
277
            default:
278 615
                return new Exec\SingleSelectExecutor($AST, $this);
279
        }
280
    }
281
282
    /**
283
     * Generates a unique, short SQL table alias.
284
     *
285
     * @param string $tableName Table name
286
     * @param string $dqlAlias  The DQL alias.
287
     *
288
     * @return string Generated table alias.
289
     */
290 625
    public function getSQLTableAlias($tableName, $dqlAlias = '')
291
    {
292 625
        $tableName .= ($dqlAlias) ? '@[' . $dqlAlias . ']' : '';
293
294 625
        if ( ! isset($this->tableAliasMap[$tableName])) {
295 625
            $this->tableAliasMap[$tableName] = (preg_match('/[a-z]/i', $tableName[0]) ? strtolower($tableName[0]) : 't')
296 625
                . $this->tableAliasCounter++ . '_';
297
        }
298
299 625
        return $this->tableAliasMap[$tableName];
300
    }
301
302
    /**
303
     * Forces the SqlWalker to use a specific alias for a table name, rather than
304
     * generating an alias on its own.
305
     *
306
     * @param string $tableName
307
     * @param string $alias
308
     * @param string $dqlAlias
309
     *
310
     * @return string
311
     */
312 63
    public function setSQLTableAlias($tableName, $alias, $dqlAlias = '')
313
    {
314 63
        $tableName .= ($dqlAlias) ? '@[' . $dqlAlias . ']' : '';
315
316 63
        $this->tableAliasMap[$tableName] = $alias;
317
318 63
        return $alias;
319
    }
320
321
    /**
322
     * Gets an SQL column alias for a column name.
323
     *
324
     * @param string $columnName
325
     *
326
     * @return string
327
     */
328 615
    public function getSQLColumnAlias($columnName)
329
    {
330 615
        return $this->quoteStrategy->getColumnAlias($columnName, $this->aliasCounter++, $this->platform);
331
    }
332
333
    /**
334
     * Generates the SQL JOINs that are necessary for Class Table Inheritance
335
     * for the given class.
336
     *
337
     * @param ClassMetadata $class    The class for which to generate the joins.
338
     * @param string        $dqlAlias The DQL alias of the class.
339
     *
340
     * @return string The SQL.
341
     */
342 91
    private function _generateClassTableInheritanceJoins($class, $dqlAlias)
343
    {
344 91
        $sql = '';
345
346 91
        $baseTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
347
348
        // INNER JOIN parent class tables
349 91
        foreach ($class->parentClasses as $parentClassName) {
350 64
            $parentClass = $this->em->getClassMetadata($parentClassName);
351 64
            $tableAlias  = $this->getSQLTableAlias($parentClass->getTableName(), $dqlAlias);
352
353
            // If this is a joined association we must use left joins to preserve the correct result.
354 64
            $sql .= isset($this->queryComponents[$dqlAlias]['relation']) ? ' LEFT ' : ' INNER ';
355 64
            $sql .= 'JOIN ' . $this->quoteStrategy->getTableName($parentClass, $this->platform) . ' ' . $tableAlias . ' ON ';
356
357 64
            $sqlParts = [];
358
359 64
            foreach ($this->quoteStrategy->getIdentifierColumnNames($class, $this->platform) as $columnName) {
360 64
                $sqlParts[] = $baseTableAlias . '.' . $columnName . ' = ' . $tableAlias . '.' . $columnName;
361
            }
362
363
            // Add filters on the root class
364 64
            if ($filterSql = $this->generateFilterConditionSQL($parentClass, $tableAlias)) {
365 1
                $sqlParts[] = $filterSql;
366
            }
367
368 64
            $sql .= implode(' AND ', $sqlParts);
369
        }
370
371
        // Ignore subclassing inclusion if partial objects is disallowed
372 91
        if ($this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD)) {
373 21
            return $sql;
374
        }
375
376
        // LEFT JOIN child class tables
377 70
        foreach ($class->subClasses as $subClassName) {
378 32
            $subClass   = $this->em->getClassMetadata($subClassName);
379 32
            $tableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
380
381 32
            $sql .= ' LEFT JOIN ' . $this->quoteStrategy->getTableName($subClass, $this->platform) . ' ' . $tableAlias . ' ON ';
382
383 32
            $sqlParts = [];
384
385 32
            foreach ($this->quoteStrategy->getIdentifierColumnNames($subClass, $this->platform) as $columnName) {
386 32
                $sqlParts[] = $baseTableAlias . '.' . $columnName . ' = ' . $tableAlias . '.' . $columnName;
387
            }
388
389 32
            $sql .= implode(' AND ', $sqlParts);
390
        }
391
392 70
        return $sql;
393
    }
394
395
    /**
396
     * @return string
397
     */
398 608
    private function _generateOrderedCollectionOrderByItems()
399
    {
400 608
        $orderedColumns = [];
401
402 608
        foreach ($this->selectedClasses as $selectedClass) {
403 472
            $dqlAlias  = $selectedClass['dqlAlias'];
404 472
            $qComp     = $this->queryComponents[$dqlAlias];
405
406 472
            if ( ! isset($qComp['relation']['orderBy'])) {
407 472
                continue;
408
            }
409
410 6
            $persister = $this->em->getUnitOfWork()->getEntityPersister($qComp['metadata']->name);
411
412 6
            foreach ($qComp['relation']['orderBy'] as $fieldName => $orientation) {
413 6
                $columnName = $this->quoteStrategy->getColumnName($fieldName, $qComp['metadata'], $this->platform);
414 6
                $tableName  = ($qComp['metadata']->isInheritanceTypeJoined())
415 1
                    ? $persister->getOwningTable($fieldName)
416 6
                    : $qComp['metadata']->getTableName();
417
418 6
                $orderedColumn = $this->getSQLTableAlias($tableName, $dqlAlias) . '.' . $columnName;
419
420
                // OrderByClause should replace an ordered relation. see - DDC-2475
421 6
                if (isset($this->orderedColumnsMap[$orderedColumn])) {
422 1
                    continue;
423
                }
424
425 6
                $this->orderedColumnsMap[$orderedColumn] = $orientation;
426 6
                $orderedColumns[] = $orderedColumn . ' ' . $orientation;
427
            }
428
        }
429
430 608
        return implode(', ', $orderedColumns);
431
    }
432
433
    /**
434
     * Generates a discriminator column SQL condition for the class with the given DQL alias.
435
     *
436
     * @param array $dqlAliases List of root DQL aliases to inspect for discriminator restrictions.
437
     *
438
     * @return string
439
     */
440 667
    private function _generateDiscriminatorColumnConditionSQL(array $dqlAliases)
441
    {
442 667
        $sqlParts = [];
443
444 667
        foreach ($dqlAliases as $dqlAlias) {
445 667
            $class = $this->queryComponents[$dqlAlias]['metadata'];
446
447 667
            if ( ! $class->isInheritanceTypeSingleTable()) continue;
448
449 36
            $conn   = $this->em->getConnection();
450 36
            $values = [];
451
452 36
            if ($class->discriminatorValue !== null) { // discriminators can be 0
453 17
                $values[] = $conn->quote($class->discriminatorValue);
454
            }
455
456 36
            foreach ($class->subClasses as $subclassName) {
457 27
                $values[] = $conn->quote($this->em->getClassMetadata($subclassName)->discriminatorValue);
458
            }
459
460 36
            $sqlTableAlias = ($this->useSqlTableAliases)
461 31
                ? $this->getSQLTableAlias($class->getTableName(), $dqlAlias) . '.'
462 36
                : '';
463
464 36
            $sqlParts[] = $sqlTableAlias . $class->discriminatorColumn['name'] . ' IN (' . implode(', ', $values) . ')';
465
        }
466
467 667
        $sql = implode(' AND ', $sqlParts);
468
469 667
        return (count($sqlParts) > 1) ? '(' . $sql . ')' : $sql;
470
    }
471
472
    /**
473
     * Generates the filter SQL for a given entity and table alias.
474
     *
475
     * @param ClassMetadata $targetEntity     Metadata of the target entity.
476
     * @param string        $targetTableAlias The table alias of the joined/selected table.
477
     *
478
     * @return string The SQL query part to add to a query.
479
     */
480 315
    private function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
481
    {
482 315
        if (!$this->em->hasFilters()) {
483 277
            return '';
484
        }
485
486 43
        switch($targetEntity->inheritanceType) {
487 43
            case ClassMetadata::INHERITANCE_TYPE_NONE:
488 33
                break;
489 10
            case ClassMetadata::INHERITANCE_TYPE_JOINED:
490
                // The classes in the inheritance will be added to the query one by one,
491
                // but only the root node is getting filtered
492 6
                if ($targetEntity->name !== $targetEntity->rootEntityName) {
493 4
                    return '';
494
                }
495 6
                break;
496 4
            case ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE:
497
                // With STI the table will only be queried once, make sure that the filters
498
                // are added to the root entity
499 4
                $targetEntity = $this->em->getClassMetadata($targetEntity->rootEntityName);
500 4
                break;
501
            default:
502
                //@todo: throw exception?
503
                return '';
504
        }
505
506 43
        $filterClauses = [];
507 43
        foreach ($this->em->getFilters()->getEnabledFilters() as $filter) {
508 10
            if ('' !== $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias)) {
509 10
                $filterClauses[] = '(' . $filterExpr . ')';
510
            }
511
        }
512
513 43
        return implode(' AND ', $filterClauses);
514
    }
515
516
    /**
517
     * {@inheritdoc}
518
     */
519 615
    public function walkSelectStatement(AST\SelectStatement $AST)
520
    {
521 615
        $limit    = $this->query->getMaxResults();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Doctrine\ORM\AbstractQuery as the method getMaxResults() does only exist in the following sub-classes of Doctrine\ORM\AbstractQuery: Doctrine\ORM\Query. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
522 615
        $offset   = $this->query->getFirstResult();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Doctrine\ORM\AbstractQuery as the method getFirstResult() does only exist in the following sub-classes of Doctrine\ORM\AbstractQuery: Doctrine\ORM\Query. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
523 615
        $lockMode = $this->query->getHint(Query::HINT_LOCK_MODE);
524 615
        $sql      = $this->walkSelectClause($AST->selectClause)
525 615
            . $this->walkFromClause($AST->fromClause)
526 612
            . $this->walkWhereClause($AST->whereClause);
0 ignored issues
show
Bug introduced by
It seems like $AST->whereClause can be null; however, walkWhereClause() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
527
528 609
        if ($AST->groupByClause) {
529 23
            $sql .= $this->walkGroupByClause($AST->groupByClause);
530
        }
531
532 609
        if ($AST->havingClause) {
533 14
            $sql .= $this->walkHavingClause($AST->havingClause);
534
        }
535
536 609
        if ($AST->orderByClause) {
537 142
            $sql .= $this->walkOrderByClause($AST->orderByClause);
538
        }
539
540 608
        if ( ! $AST->orderByClause && ($orderBySql = $this->_generateOrderedCollectionOrderByItems())) {
541 6
            $sql .= ' ORDER BY ' . $orderBySql;
542
        }
543
544 608
        if ($limit !== null || $offset !== null) {
545 39
            $sql = $this->platform->modifyLimitQuery($sql, $limit, $offset);
546
        }
547
548 608
        if ($lockMode === null || $lockMode === false || $lockMode === LockMode::NONE) {
549 603
            return $sql;
550
        }
551
552 5
        if ($lockMode === LockMode::PESSIMISTIC_READ) {
553 3
            return $sql . ' ' . $this->platform->getReadLockSQL();
554
        }
555
556 2
        if ($lockMode === LockMode::PESSIMISTIC_WRITE) {
557 1
            return $sql . ' ' . $this->platform->getWriteLockSQL();
558
        }
559
560 1
        if ($lockMode !== LockMode::OPTIMISTIC) {
561
            throw QueryException::invalidLockMode();
562
        }
563
564 1
        foreach ($this->selectedClasses as $selectedClass) {
565 1
            if ( ! $selectedClass['class']->isVersioned) {
566 1
                throw OptimisticLockException::lockFailed($selectedClass['class']->name);
567
            }
568
        }
569
570
        return $sql;
571
    }
572
573
    /**
574
     * {@inheritdoc}
575
     */
576 24
    public function walkUpdateStatement(AST\UpdateStatement $AST)
577
    {
578 24
        $this->useSqlTableAliases = false;
579 24
        $this->rsm->isSelect      = false;
580
581 24
        return $this->walkUpdateClause($AST->updateClause)
582 24
            . $this->walkWhereClause($AST->whereClause);
0 ignored issues
show
Bug introduced by
It seems like $AST->whereClause can be null; however, walkWhereClause() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
583
    }
584
585
    /**
586
     * {@inheritdoc}
587
     */
588 36
    public function walkDeleteStatement(AST\DeleteStatement $AST)
589
    {
590 36
        $this->useSqlTableAliases = false;
591 36
        $this->rsm->isSelect      = false;
592
593 36
        return $this->walkDeleteClause($AST->deleteClause)
594 36
            . $this->walkWhereClause($AST->whereClause);
0 ignored issues
show
Bug introduced by
It seems like $AST->whereClause can be null; however, walkWhereClause() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
595
    }
596
597
    /**
598
     * Walks down an IdentificationVariable AST node, thereby generating the appropriate SQL.
599
     * This one differs of ->walkIdentificationVariable() because it generates the entity identifiers.
600
     *
601
     * @param string $identVariable
602
     *
603
     * @return string
604
     */
605 2
    public function walkEntityIdentificationVariable($identVariable)
606
    {
607 2
        $class      = $this->queryComponents[$identVariable]['metadata'];
608 2
        $tableAlias = $this->getSQLTableAlias($class->getTableName(), $identVariable);
609 2
        $sqlParts   = [];
610
611 2
        foreach ($this->quoteStrategy->getIdentifierColumnNames($class, $this->platform) as $columnName) {
612 2
            $sqlParts[] = $tableAlias . '.' . $columnName;
613
        }
614
615 2
        return implode(', ', $sqlParts);
616
    }
617
618
    /**
619
     * Walks down an IdentificationVariable (no AST node associated), thereby generating the SQL.
620
     *
621
     * @param string $identificationVariable
622
     * @param string $fieldName
623
     *
624
     * @return string The SQL.
625
     */
626 417
    public function walkIdentificationVariable($identificationVariable, $fieldName = null)
627
    {
628 417
        $class = $this->queryComponents[$identificationVariable]['metadata'];
629
630
        if (
631 417
            $fieldName !== null && $class->isInheritanceTypeJoined() &&
632 417
            isset($class->fieldMappings[$fieldName]['inherited'])
633
        ) {
634 37
            $class = $this->em->getClassMetadata($class->fieldMappings[$fieldName]['inherited']);
635
        }
636
637 417
        return $this->getSQLTableAlias($class->getTableName(), $identificationVariable);
638
    }
639
640
    /**
641
     * {@inheritdoc}
642
     */
643 484
    public function walkPathExpression($pathExpr)
644
    {
645 484
        $sql = '';
646
647 484
        switch ($pathExpr->type) {
648 484
            case AST\PathExpression::TYPE_STATE_FIELD:
649 464
                $fieldName = $pathExpr->field;
650 464
                $dqlAlias = $pathExpr->identificationVariable;
651 464
                $class = $this->queryComponents[$dqlAlias]['metadata'];
652
653 464
                if ($this->useSqlTableAliases) {
654 417
                    $sql .= $this->walkIdentificationVariable($dqlAlias, $fieldName) . '.';
655
                }
656
657 464
                $sql .= $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
658 464
                break;
659
660 61
            case AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION:
661
                // 1- the owning side:
662
                //    Just use the foreign key, i.e. u.group_id
663 61
                $fieldName = $pathExpr->field;
664 61
                $dqlAlias = $pathExpr->identificationVariable;
665 61
                $class = $this->queryComponents[$dqlAlias]['metadata'];
666
667 61
                if (isset($class->associationMappings[$fieldName]['inherited'])) {
668 2
                    $class = $this->em->getClassMetadata($class->associationMappings[$fieldName]['inherited']);
669
                }
670
671 61
                $assoc = $class->associationMappings[$fieldName];
672
673 61
                if ( ! $assoc['isOwningSide']) {
674 2
                    throw QueryException::associationPathInverseSideNotSupported();
675
                }
676
677
                // COMPOSITE KEYS NOT (YET?) SUPPORTED
678 59
                if (count($assoc['sourceToTargetKeyColumns']) > 1) {
679 1
                    throw QueryException::associationPathCompositeKeyNotSupported();
680
                }
681
682 58
                if ($this->useSqlTableAliases) {
683 55
                    $sql .= $this->getSQLTableAlias($class->getTableName(), $dqlAlias) . '.';
684
                }
685
686 58
                $sql .= reset($assoc['targetToSourceKeyColumns']);
687 58
                break;
688
689
            default:
690
                throw QueryException::invalidPathExpression($pathExpr);
691
        }
692
693 481
        return $sql;
694
    }
695
696
    /**
697
     * {@inheritdoc}
698
     */
699 615
    public function walkSelectClause($selectClause)
700
    {
701 615
        $sql = 'SELECT ' . (($selectClause->isDistinct) ? 'DISTINCT ' : '');
702 615
        $sqlSelectExpressions = array_filter(array_map([$this, 'walkSelectExpression'], $selectClause->selectExpressions));
703
704 615
        if ($this->query->getHint(Query::HINT_INTERNAL_ITERATION) == true && $selectClause->isDistinct) {
705
            $this->query->setHint(self::HINT_DISTINCT, true);
706
        }
707
708 615
        $addMetaColumns = ! $this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD) &&
709 452
            $this->query->getHydrationMode() == Query::HYDRATE_OBJECT
710
            ||
711 288
            $this->query->getHydrationMode() != Query::HYDRATE_OBJECT &&
712 615
            $this->query->getHint(Query::HINT_INCLUDE_META_COLUMNS);
713
714 615
        foreach ($this->selectedClasses as $selectedClass) {
715 479
            $class       = $selectedClass['class'];
716 479
            $dqlAlias    = $selectedClass['dqlAlias'];
717 479
            $resultAlias = $selectedClass['resultAlias'];
718
719
            // Register as entity or joined entity result
720 479
            if ($this->queryComponents[$dqlAlias]['relation'] === null) {
721 479
                $this->rsm->addEntityResult($class->name, $dqlAlias, $resultAlias);
722
            } else {
723 157
                $this->rsm->addJoinedEntityResult(
724 157
                    $class->name,
725
                    $dqlAlias,
726 157
                    $this->queryComponents[$dqlAlias]['parent'],
727 157
                    $this->queryComponents[$dqlAlias]['relation']['fieldName']
728
                );
729
            }
730
731 479
            if ($class->isInheritanceTypeSingleTable() || $class->isInheritanceTypeJoined()) {
732
                // Add discriminator columns to SQL
733 87
                $rootClass   = $this->em->getClassMetadata($class->rootEntityName);
734 87
                $tblAlias    = $this->getSQLTableAlias($rootClass->getTableName(), $dqlAlias);
735 87
                $discrColumn = $rootClass->discriminatorColumn;
736 87
                $columnAlias = $this->getSQLColumnAlias($discrColumn['name']);
737
738 87
                $sqlSelectExpressions[] = $tblAlias . '.' . $discrColumn['name'] . ' AS ' . $columnAlias;
739
740 87
                $this->rsm->setDiscriminatorColumn($dqlAlias, $columnAlias);
741 87
                $this->rsm->addMetaResult($dqlAlias, $columnAlias, $discrColumn['fieldName'], false, $discrColumn['type']);
742
            }
743
744
            // Add foreign key columns to SQL, if necessary
745 479
            if ( ! $addMetaColumns && ! $class->containsForeignIdentifier) {
746 180
                continue;
747
            }
748
749
            // Add foreign key columns of class and also parent classes
750 349
            foreach ($class->associationMappings as $assoc) {
751 312
                if ( ! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
752 262
                    continue;
753 280
                } else if ( !$addMetaColumns && !isset($assoc['id'])) {
754
                    continue;
755
                }
756
757 280
                $targetClass   = $this->em->getClassMetadata($assoc['targetEntity']);
758 280
                $isIdentifier  = (isset($assoc['id']) && $assoc['id'] === true);
759 280
                $owningClass   = (isset($assoc['inherited'])) ? $this->em->getClassMetadata($assoc['inherited']) : $class;
760 280
                $sqlTableAlias = $this->getSQLTableAlias($owningClass->getTableName(), $dqlAlias);
761
762 280
                foreach ($assoc['joinColumns'] as $joinColumn) {
763 280
                    $columnName  = $joinColumn['name'];
764 280
                    $columnAlias = $this->getSQLColumnAlias($columnName);
765 280
                    $columnType  = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
766
767 280
                    $quotedColumnName = $this->quoteStrategy->getJoinColumnName($joinColumn, $class, $this->platform);
768 280
                    $sqlSelectExpressions[] = $sqlTableAlias . '.' . $quotedColumnName . ' AS ' . $columnAlias;
769
770 280
                    $this->rsm->addMetaResult($dqlAlias, $columnAlias, $columnName, $isIdentifier, $columnType);
771
                }
772
            }
773
774
            // Add foreign key columns to SQL, if necessary
775 349
            if ( ! $addMetaColumns) {
776 8
                continue;
777
            }
778
779
            // Add foreign key columns of subclasses
780 344
            foreach ($class->subClasses as $subClassName) {
781 30
                $subClass      = $this->em->getClassMetadata($subClassName);
782 30
                $sqlTableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
783
784 30
                foreach ($subClass->associationMappings as $assoc) {
785
                    // Skip if association is inherited
786 26
                    if (isset($assoc['inherited'])) continue;
787
788 15
                    if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
789 13
                        $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
790
791 13
                        foreach ($assoc['joinColumns'] as $joinColumn) {
792 13
                            $columnName  = $joinColumn['name'];
793 13
                            $columnAlias = $this->getSQLColumnAlias($columnName);
794 13
                            $columnType  = PersisterHelper::getTypeOfColumn($joinColumn['referencedColumnName'], $targetClass, $this->em);
795
796 13
                            $sqlSelectExpressions[] = $sqlTableAlias . '.' . $columnName . ' AS ' . $columnAlias;
797
798 344
                            $this->rsm->addMetaResult($dqlAlias, $columnAlias, $columnName, $subClass->isIdentifier($columnName), $columnType);
799
                        }
800
                    }
801
                }
802
            }
803
        }
804
805 615
        $sql .= implode(', ', $sqlSelectExpressions);
806
807 615
        return $sql;
808
    }
809
810
    /**
811
     * {@inheritdoc}
812
     */
813 616
    public function walkFromClause($fromClause)
814
    {
815 616
        $identificationVarDecls = $fromClause->identificationVariableDeclarations;
816 616
        $sqlParts = [];
817
818 616
        foreach ($identificationVarDecls as $identificationVariableDecl) {
819 616
            $sqlParts[] = $this->walkIdentificationVariableDeclaration($identificationVariableDecl);
820
        }
821
822 613
        return ' FROM ' . implode(', ', $sqlParts);
823
    }
824
825
    /**
826
     * Walks down a IdentificationVariableDeclaration AST node, thereby generating the appropriate SQL.
827
     *
828
     * @param AST\IdentificationVariableDeclaration $identificationVariableDecl
829
     *
830
     * @return string
831
     */
832 617
    public function walkIdentificationVariableDeclaration($identificationVariableDecl)
833
    {
834 617
        $sql = $this->walkRangeVariableDeclaration($identificationVariableDecl->rangeVariableDeclaration);
0 ignored issues
show
Bug introduced by
It seems like $identificationVariableD...angeVariableDeclaration can be null; however, walkRangeVariableDeclaration() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
835
836 617
        if ($identificationVariableDecl->indexBy) {
837 5
            $this->walkIndexBy($identificationVariableDecl->indexBy);
838
        }
839
840 617
        foreach ($identificationVariableDecl->joins as $join) {
841 243
            $sql .= $this->walkJoin($join);
842
        }
843
844 614
        return $sql;
845
    }
846
847
    /**
848
     * Walks down a IndexBy AST node.
849
     *
850
     * @param AST\IndexBy $indexBy
851
     *
852
     * @return void
853
     */
854 8
    public function walkIndexBy($indexBy)
855
    {
856 8
        $pathExpression = $indexBy->simpleStateFieldPathExpression;
857 8
        $alias          = $pathExpression->identificationVariable;
858 8
        $field          = $pathExpression->field;
859
860 8
        if (isset($this->scalarFields[$alias][$field])) {
861
            $this->rsm->addIndexByScalar($this->scalarFields[$alias][$field]);
862
863
            return;
864
        }
865
866 8
        $this->rsm->addIndexBy($alias, $field);
867 8
    }
868
869
    /**
870
     * Walks down a RangeVariableDeclaration AST node, thereby generating the appropriate SQL.
871
     *
872
     * @param AST\RangeVariableDeclaration $rangeVariableDeclaration
873
     *
874
     * @return string
875
     */
876 617
    public function walkRangeVariableDeclaration($rangeVariableDeclaration)
877
    {
878 617
        $class    = $this->em->getClassMetadata($rangeVariableDeclaration->abstractSchemaName);
879 617
        $dqlAlias = $rangeVariableDeclaration->aliasIdentificationVariable;
880
881 617
        if ($rangeVariableDeclaration->isRoot) {
882 617
            $this->rootAliases[] = $dqlAlias;
883
        }
884
885 617
        $sql = $this->platform->appendLockHint(
886 617
            $this->quoteStrategy->getTableName($class, $this->platform) . ' ' .
887 617
            $this->getSQLTableAlias($class->getTableName(), $dqlAlias),
888 617
            $this->query->getHint(Query::HINT_LOCK_MODE)
889
        );
890
891 617
        if ($class->isInheritanceTypeJoined()) {
892 87
            $sql .= $this->_generateClassTableInheritanceJoins($class, $dqlAlias);
893
        }
894
895 617
        return $sql;
896
    }
897
898
    /**
899
     * Walks down a JoinAssociationDeclaration AST node, thereby generating the appropriate SQL.
900
     *
901
     * @param AST\JoinAssociationDeclaration $joinAssociationDeclaration
902
     * @param int                            $joinType
903
     * @param AST\ConditionalExpression      $condExpr
904
     *
905
     * @return string
906
     *
907
     * @throws QueryException
908
     */
909 226
    public function walkJoinAssociationDeclaration($joinAssociationDeclaration, $joinType = AST\Join::JOIN_TYPE_INNER, $condExpr = null)
910
    {
911 226
        $sql = '';
912
913 226
        $associationPathExpression = $joinAssociationDeclaration->joinAssociationPathExpression;
914 226
        $joinedDqlAlias            = $joinAssociationDeclaration->aliasIdentificationVariable;
915 226
        $indexBy                   = $joinAssociationDeclaration->indexBy;
916
917 226
        $relation        = $this->queryComponents[$joinedDqlAlias]['relation'];
918 226
        $targetClass     = $this->em->getClassMetadata($relation['targetEntity']);
919 226
        $sourceClass     = $this->em->getClassMetadata($relation['sourceEntity']);
920 226
        $targetTableName = $this->quoteStrategy->getTableName($targetClass, $this->platform);
921
922 226
        $targetTableAlias = $this->getSQLTableAlias($targetClass->getTableName(), $joinedDqlAlias);
923 226
        $sourceTableAlias = $this->getSQLTableAlias($sourceClass->getTableName(), $associationPathExpression->identificationVariable);
924
925
        // Ensure we got the owning side, since it has all mapping info
926 226
        $assoc = ( ! $relation['isOwningSide']) ? $targetClass->associationMappings[$relation['mappedBy']] : $relation;
927
928 226
        if ($this->query->getHint(Query::HINT_INTERNAL_ITERATION) == true && (!$this->query->getHint(self::HINT_DISTINCT) || isset($this->selectedClasses[$joinedDqlAlias]))) {
929 4
            if ($relation['type'] == ClassMetadata::ONE_TO_MANY || $relation['type'] == ClassMetadata::MANY_TO_MANY) {
930 3
                throw QueryException::iterateWithFetchJoinNotAllowed($assoc);
931
            }
932
        }
933
934 223
        $targetTableJoin = null;
0 ignored issues
show
Unused Code introduced by
$targetTableJoin is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
935
936
        // This condition is not checking ClassMetadata::MANY_TO_ONE, because by definition it cannot
937
        // be the owning side and previously we ensured that $assoc is always the owning side of the associations.
938
        // The owning side is necessary at this point because only it contains the JoinColumn information.
939
        switch (true) {
940 223
            case ($assoc['type'] & ClassMetadata::TO_ONE):
941 176
                $conditions = [];
942
943 176
                foreach ($assoc['joinColumns'] as $joinColumn) {
944 176
                    $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
945 176
                    $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
946
947 176
                    if ($relation['isOwningSide']) {
948 103
                        $conditions[] = $sourceTableAlias . '.' . $quotedSourceColumn . ' = ' . $targetTableAlias . '.' . $quotedTargetColumn;
949
950 103
                        continue;
951
                    }
952
953 106
                    $conditions[] = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $targetTableAlias . '.' . $quotedSourceColumn;
954
                }
955
956
                // Apply remaining inheritance restrictions
957 176
                $discrSql = $this->_generateDiscriminatorColumnConditionSQL([$joinedDqlAlias]);
958
959 176
                if ($discrSql) {
960 2
                    $conditions[] = $discrSql;
961
                }
962
963
                // Apply the filters
964 176
                $filterExpr = $this->generateFilterConditionSQL($targetClass, $targetTableAlias);
965
966 176
                if ($filterExpr) {
967 1
                    $conditions[] = $filterExpr;
968
                }
969
970
                $targetTableJoin = [
971 176
                    'table' => $targetTableName . ' ' . $targetTableAlias,
972 176
                    'condition' => implode(' AND ', $conditions),
973
                ];
974 176
                break;
975
976 57
            case ($assoc['type'] == ClassMetadata::MANY_TO_MANY):
977
                // Join relation table
978 57
                $joinTable      = $assoc['joinTable'];
979 57
                $joinTableAlias = $this->getSQLTableAlias($joinTable['name'], $joinedDqlAlias);
980 57
                $joinTableName  = $this->quoteStrategy->getJoinTableName($assoc, $sourceClass, $this->platform);
981
982 57
                $conditions      = [];
983 57
                $relationColumns = ($relation['isOwningSide'])
984 48
                    ? $assoc['joinTable']['joinColumns']
985 57
                    : $assoc['joinTable']['inverseJoinColumns'];
986
987 57
                foreach ($relationColumns as $joinColumn) {
988 57
                    $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
989 57
                    $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
990
991 57
                    $conditions[] = $sourceTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableAlias . '.' . $quotedSourceColumn;
992
                }
993
994 57
                $sql .= $joinTableName . ' ' . $joinTableAlias . ' ON ' . implode(' AND ', $conditions);
995
996
                // Join target table
997 57
                $sql .= ($joinType == AST\Join::JOIN_TYPE_LEFT || $joinType == AST\Join::JOIN_TYPE_LEFTOUTER) ? ' LEFT JOIN ' : ' INNER JOIN ';
998
999 57
                $conditions      = [];
1000 57
                $relationColumns = ($relation['isOwningSide'])
1001 48
                    ? $assoc['joinTable']['inverseJoinColumns']
1002 57
                    : $assoc['joinTable']['joinColumns'];
1003
1004 57
                foreach ($relationColumns as $joinColumn) {
1005 57
                    $quotedSourceColumn = $this->quoteStrategy->getJoinColumnName($joinColumn, $targetClass, $this->platform);
1006 57
                    $quotedTargetColumn = $this->quoteStrategy->getReferencedJoinColumnName($joinColumn, $targetClass, $this->platform);
1007
1008 57
                    $conditions[] = $targetTableAlias . '.' . $quotedTargetColumn . ' = ' . $joinTableAlias . '.' . $quotedSourceColumn;
1009
                }
1010
1011
                // Apply remaining inheritance restrictions
1012 57
                $discrSql = $this->_generateDiscriminatorColumnConditionSQL([$joinedDqlAlias]);
1013
1014 57
                if ($discrSql) {
1015 1
                    $conditions[] = $discrSql;
1016
                }
1017
1018
                // Apply the filters
1019 57
                $filterExpr = $this->generateFilterConditionSQL($targetClass, $targetTableAlias);
1020
1021 57
                if ($filterExpr) {
1022 1
                    $conditions[] = $filterExpr;
1023
                }
1024
1025
                $targetTableJoin = [
1026 57
                    'table' => $targetTableName . ' ' . $targetTableAlias,
1027 57
                    'condition' => implode(' AND ', $conditions),
1028
                ];
1029 57
                break;
1030
1031
            default:
1032
                throw new \BadMethodCallException('Type of association must be one of *_TO_ONE or MANY_TO_MANY');
1033
        }
1034
1035
        // Handle WITH clause
1036 223
        $withCondition = (null === $condExpr) ? '' : ('(' . $this->walkConditionalExpression($condExpr) . ')');
1037
1038 223
        if ($targetClass->isInheritanceTypeJoined()) {
1039 9
            $ctiJoins = $this->_generateClassTableInheritanceJoins($targetClass, $joinedDqlAlias);
1040
            // If we have WITH condition, we need to build nested joins for target class table and cti joins
1041 9
            if ($withCondition) {
1042 1
                $sql .= '(' . $targetTableJoin['table'] . $ctiJoins . ') ON ' . $targetTableJoin['condition'];
1043
            } else {
1044 9
                $sql .= $targetTableJoin['table'] . ' ON ' . $targetTableJoin['condition'] . $ctiJoins;
1045
            }
1046
        } else {
1047 214
            $sql .= $targetTableJoin['table'] . ' ON ' . $targetTableJoin['condition'];
1048
        }
1049
1050 223
        if ($withCondition) {
1051 4
            $sql .= ' AND ' . $withCondition;
1052
        }
1053
1054
        // Apply the indexes
1055 223
        if ($indexBy) {
1056
            // For Many-To-One or One-To-One associations this obviously makes no sense, but is ignored silently.
1057 5
            $this->walkIndexBy($indexBy);
1058 218
        } else if (isset($relation['indexBy'])) {
1059 2
            $this->rsm->addIndexBy($joinedDqlAlias, $relation['indexBy']);
1060
        }
1061
1062 223
        return $sql;
1063
    }
1064
1065
    /**
1066
     * {@inheritdoc}
1067
     */
1068 63
    public function walkFunction($function)
1069
    {
1070 63
        return $function->getSql($this);
1071
    }
1072
1073
    /**
1074
     * {@inheritdoc}
1075
     */
1076 153
    public function walkOrderByClause($orderByClause)
1077
    {
1078 153
        $orderByItems = array_map([$this, 'walkOrderByItem'], $orderByClause->orderByItems);
1079
1080 152
        if (($collectionOrderByItems = $this->_generateOrderedCollectionOrderByItems()) !== '') {
1081
            $orderByItems = array_merge($orderByItems, (array) $collectionOrderByItems);
1082
        }
1083
1084 152
        return ' ORDER BY ' . implode(', ', $orderByItems);
1085
    }
1086
1087
    /**
1088
     * {@inheritdoc}
1089
     */
1090 171
    public function walkOrderByItem($orderByItem)
1091
    {
1092 171
        $type = strtoupper($orderByItem->type);
1093 171
        $expr = $orderByItem->expression;
1094 171
        $sql  = ($expr instanceof AST\Node)
1095 164
            ? $expr->dispatch($this)
1096 170
            : $this->walkResultVariable($this->queryComponents[$expr]['token']['value']);
1097
1098 170
        $this->orderedColumnsMap[$sql] = $type;
1099
1100 170
        if ($expr instanceof AST\Subselect) {
1101 2
            return '(' . $sql . ') ' . $type;
1102
        }
1103
1104 168
        return $sql . ' ' . $type;
1105
    }
1106
1107
    /**
1108
     * {@inheritdoc}
1109
     */
1110 14
    public function walkHavingClause($havingClause)
1111
    {
1112 14
        return ' HAVING ' . $this->walkConditionalExpression($havingClause->conditionalExpression);
1113
    }
1114
1115
    /**
1116
     * {@inheritdoc}
1117
     */
1118 243
    public function walkJoin($join)
1119
    {
1120 243
        $joinType        = $join->joinType;
1121 243
        $joinDeclaration = $join->joinAssociationDeclaration;
1122
1123 243
        $sql = ($joinType == AST\Join::JOIN_TYPE_LEFT || $joinType == AST\Join::JOIN_TYPE_LEFTOUTER)
1124 55
            ? ' LEFT JOIN '
1125 243
            : ' INNER JOIN ';
1126
1127
        switch (true) {
1128 243
            case ($joinDeclaration instanceof \Doctrine\ORM\Query\AST\RangeVariableDeclaration):
1129 17
                $class      = $this->em->getClassMetadata($joinDeclaration->abstractSchemaName);
1130 17
                $dqlAlias   = $joinDeclaration->aliasIdentificationVariable;
1131 17
                $tableAlias = $this->getSQLTableAlias($class->table['name'], $dqlAlias);
1132 17
                $conditions = [];
1133
1134 17
                if ($join->conditionalExpression) {
1135 15
                    $conditions[] = '(' . $this->walkConditionalExpression($join->conditionalExpression) . ')';
1136
                }
1137
1138 17
                $condExprConjunction = ($class->isInheritanceTypeJoined() && $joinType != AST\Join::JOIN_TYPE_LEFT && $joinType != AST\Join::JOIN_TYPE_LEFTOUTER)
1139 3
                    ? ' AND '
1140 17
                    : ' ON ';
1141
1142 17
                $sql .= $this->walkRangeVariableDeclaration($joinDeclaration);
1143
1144
                // Apply remaining inheritance restrictions
1145 17
                $discrSql = $this->_generateDiscriminatorColumnConditionSQL([$dqlAlias]);
1146
1147 17
                if ($discrSql) {
1148 3
                    $conditions[] = $discrSql;
1149
                }
1150
1151
                // Apply the filters
1152 17
                $filterExpr = $this->generateFilterConditionSQL($class, $tableAlias);
1153
1154 17
                if ($filterExpr) {
1155
                    $conditions[] = $filterExpr;
1156
                }
1157
1158 17
                if ($conditions) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $conditions of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1159 15
                    $sql .= $condExprConjunction . implode(' AND ', $conditions);
1160
                }
1161
1162 17
                break;
1163
1164
            case ($joinDeclaration instanceof \Doctrine\ORM\Query\AST\JoinAssociationDeclaration):
1165 226
                $sql .= $this->walkJoinAssociationDeclaration($joinDeclaration, $joinType, $join->conditionalExpression);
1166 223
                break;
1167
        }
1168
1169 240
        return $sql;
1170
    }
1171
1172
    /**
1173
     * Walks down a CoalesceExpression AST node and generates the corresponding SQL.
1174
     *
1175
     * @param AST\CoalesceExpression $coalesceExpression
1176
     *
1177
     * @return string The SQL.
1178
     */
1179 2
    public function walkCoalesceExpression($coalesceExpression)
1180
    {
1181 2
        $sql = 'COALESCE(';
1182
1183 2
        $scalarExpressions = [];
1184
1185 2
        foreach ($coalesceExpression->scalarExpressions as $scalarExpression) {
1186 2
            $scalarExpressions[] = $this->walkSimpleArithmeticExpression($scalarExpression);
1187
        }
1188
1189 2
        $sql .= implode(', ', $scalarExpressions) . ')';
1190
1191 2
        return $sql;
1192
    }
1193
1194
    /**
1195
     * Walks down a NullIfExpression AST node and generates the corresponding SQL.
1196
     *
1197
     * @param AST\NullIfExpression $nullIfExpression
1198
     *
1199
     * @return string The SQL.
1200
     */
1201 3
    public function walkNullIfExpression($nullIfExpression)
1202
    {
1203 3
        $firstExpression = is_string($nullIfExpression->firstExpression)
1204
            ? $this->conn->quote($nullIfExpression->firstExpression)
1205 3
            : $this->walkSimpleArithmeticExpression($nullIfExpression->firstExpression);
1206
1207 3
        $secondExpression = is_string($nullIfExpression->secondExpression)
1208
            ? $this->conn->quote($nullIfExpression->secondExpression)
1209 3
            : $this->walkSimpleArithmeticExpression($nullIfExpression->secondExpression);
1210
1211 3
        return 'NULLIF(' . $firstExpression . ', ' . $secondExpression . ')';
1212
    }
1213
1214
    /**
1215
     * Walks down a GeneralCaseExpression AST node and generates the corresponding SQL.
1216
     *
1217
     * @param AST\GeneralCaseExpression $generalCaseExpression
1218
     *
1219
     * @return string The SQL.
1220
     */
1221 9
    public function walkGeneralCaseExpression(AST\GeneralCaseExpression $generalCaseExpression)
1222
    {
1223 9
        $sql = 'CASE';
1224
1225 9
        foreach ($generalCaseExpression->whenClauses as $whenClause) {
1226 9
            $sql .= ' WHEN ' . $this->walkConditionalExpression($whenClause->caseConditionExpression);
1227 9
            $sql .= ' THEN ' . $this->walkSimpleArithmeticExpression($whenClause->thenScalarExpression);
1228
        }
1229
1230 9
        $sql .= ' ELSE ' . $this->walkSimpleArithmeticExpression($generalCaseExpression->elseScalarExpression) . ' END';
1231
1232 9
        return $sql;
1233
    }
1234
1235
    /**
1236
     * Walks down a SimpleCaseExpression AST node and generates the corresponding SQL.
1237
     *
1238
     * @param AST\SimpleCaseExpression $simpleCaseExpression
1239
     *
1240
     * @return string The SQL.
1241
     */
1242 5
    public function walkSimpleCaseExpression($simpleCaseExpression)
1243
    {
1244 5
        $sql = 'CASE ' . $this->walkStateFieldPathExpression($simpleCaseExpression->caseOperand);
1245
1246 5
        foreach ($simpleCaseExpression->simpleWhenClauses as $simpleWhenClause) {
1247 5
            $sql .= ' WHEN ' . $this->walkSimpleArithmeticExpression($simpleWhenClause->caseScalarExpression);
1248 5
            $sql .= ' THEN ' . $this->walkSimpleArithmeticExpression($simpleWhenClause->thenScalarExpression);
1249
        }
1250
1251 5
        $sql .= ' ELSE ' . $this->walkSimpleArithmeticExpression($simpleCaseExpression->elseScalarExpression) . ' END';
1252
1253 5
        return $sql;
1254
    }
1255
1256
    /**
1257
     * {@inheritdoc}
1258
     */
1259 615
    public function walkSelectExpression($selectExpression)
1260
    {
1261 615
        $sql    = '';
1262 615
        $expr   = $selectExpression->expression;
1263 615
        $hidden = $selectExpression->hiddenAliasResultVariable;
1264
1265
        switch (true) {
1266 615
            case ($expr instanceof AST\PathExpression):
1267 101
                if ($expr->type !== AST\PathExpression::TYPE_STATE_FIELD) {
1268
                    throw QueryException::invalidPathExpression($expr);
1269
                }
1270
1271 101
                $fieldName = $expr->field;
1272 101
                $dqlAlias  = $expr->identificationVariable;
1273 101
                $qComp     = $this->queryComponents[$dqlAlias];
1274 101
                $class     = $qComp['metadata'];
1275
1276 101
                $resultAlias = $selectExpression->fieldIdentificationVariable ?: $fieldName;
1277 101
                $tableName   = ($class->isInheritanceTypeJoined())
1278 11
                    ? $this->em->getUnitOfWork()->getEntityPersister($class->name)->getOwningTable($fieldName)
1279 101
                    : $class->getTableName();
1280
1281 101
                $sqlTableAlias = $this->getSQLTableAlias($tableName, $dqlAlias);
1282 101
                $fieldMapping  = $class->fieldMappings[$fieldName];
1283 101
                $columnName    = $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
1284 101
                $columnAlias   = $this->getSQLColumnAlias($fieldMapping['columnName']);
1285 101
                $col           = $sqlTableAlias . '.' . $columnName;
1286
1287 101
                if (isset($fieldMapping['requireSQLConversion'])) {
1288 2
                    $type = Type::getType($fieldMapping['type']);
1289 2
                    $col  = $type->convertToPHPValueSQL($col, $this->conn->getDatabasePlatform());
1290
                }
1291
1292 101
                $sql .= $col . ' AS ' . $columnAlias;
1293
1294 101
                $this->scalarResultAliasMap[$resultAlias] = $columnAlias;
1295
1296 101
                if ( ! $hidden) {
1297 101
                    $this->rsm->addScalarResult($columnAlias, $resultAlias, $fieldMapping['type']);
1298 101
                    $this->scalarFields[$dqlAlias][$fieldName] = $columnAlias;
1299
                }
1300
1301 101
                break;
1302
1303
            case ($expr instanceof AST\AggregateExpression):
1304
            case ($expr instanceof AST\Functions\FunctionNode):
1305 10
            case ($expr instanceof AST\SimpleArithmeticExpression):
1306 22
            case ($expr instanceof AST\ArithmeticTerm):
1307 33
            case ($expr instanceof AST\ArithmeticFactor):
1308 28
            case ($expr instanceof AST\ParenthesisExpression):
1309
            case ($expr instanceof AST\Literal):
1310 37
            case ($expr instanceof AST\NullIfExpression):
1311 37
            case ($expr instanceof AST\CoalesceExpression):
1312 9
            case ($expr instanceof AST\GeneralCaseExpression):
1313 43
            case ($expr instanceof AST\SimpleCaseExpression):
1314 106
                $columnAlias = $this->getSQLColumnAlias('sclr');
1315 106
                $resultAlias = $selectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
1316
1317 106
                $sql .= $expr->dispatch($this) . ' AS ' . $columnAlias;
1318
1319 106
                $this->scalarResultAliasMap[$resultAlias] = $columnAlias;
1320
1321 106
                if ( ! $hidden) {
1322
                    // We cannot resolve field type here; assume 'string'.
1323 106
                    $this->rsm->addScalarResult($columnAlias, $resultAlias, 'string');
1324
                }
1325 106
                break;
1326
1327
            case ($expr instanceof AST\Subselect):
1328 15
                $columnAlias = $this->getSQLColumnAlias('sclr');
1329 15
                $resultAlias = $selectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
1330
1331 15
                $sql .= '(' . $this->walkSubselect($expr) . ') AS ' . $columnAlias;
1332
1333 15
                $this->scalarResultAliasMap[$resultAlias] = $columnAlias;
1334
1335 15
                if ( ! $hidden) {
1336
                    // We cannot resolve field type here; assume 'string'.
1337 13
                    $this->rsm->addScalarResult($columnAlias, $resultAlias, 'string');
1338
                }
1339 15
                break;
1340
1341 479
            case ($expr instanceof AST\NewObjectExpression):
1342 22
                $sql .= $this->walkNewObject($expr,$selectExpression->fieldIdentificationVariable);
1343 22
                break;
1344
1345
            default:
1346
                // IdentificationVariable or PartialObjectExpression
1347 479
                if ($expr instanceof AST\PartialObjectExpression) {
1348 16
                    $dqlAlias = $expr->identificationVariable;
1349 16
                    $partialFieldSet = $expr->partialFieldSet;
1350
                } else {
1351 474
                    $dqlAlias = $expr;
1352 474
                    $partialFieldSet = [];
1353
                }
1354
1355 479
                $queryComp   = $this->queryComponents[$dqlAlias];
1356 479
                $class       = $queryComp['metadata'];
1357 479
                $resultAlias = $selectExpression->fieldIdentificationVariable ?: null;
1358
1359 479
                if ( ! isset($this->selectedClasses[$dqlAlias])) {
1360 479
                    $this->selectedClasses[$dqlAlias] = [
1361 479
                        'class'       => $class,
1362 479
                        'dqlAlias'    => $dqlAlias,
1363 479
                        'resultAlias' => $resultAlias
1364
                    ];
1365
                }
1366
1367 479
                $sqlParts = [];
1368
1369
                // Select all fields from the queried class
1370 479
                foreach ($class->fieldMappings as $fieldName => $mapping) {
1371 478
                    if ($partialFieldSet && ! in_array($fieldName, $partialFieldSet)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $partialFieldSet of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1372 14
                        continue;
1373
                    }
1374
1375 477
                    $tableName = (isset($mapping['inherited']))
1376 50
                        ? $this->em->getClassMetadata($mapping['inherited'])->getTableName()
1377 477
                        : $class->getTableName();
1378
1379 477
                    $sqlTableAlias    = $this->getSQLTableAlias($tableName, $dqlAlias);
1380 477
                    $columnAlias      = $this->getSQLColumnAlias($mapping['columnName']);
1381 477
                    $quotedColumnName = $this->quoteStrategy->getColumnName($fieldName, $class, $this->platform);
1382
1383 477
                    $col = $sqlTableAlias . '.' . $quotedColumnName;
1384
1385 477
                    if (isset($mapping['requireSQLConversion'])) {
1386 5
                        $type = Type::getType($mapping['type']);
1387 5
                        $col = $type->convertToPHPValueSQL($col, $this->platform);
1388
                    }
1389
1390 477
                    $sqlParts[] = $col . ' AS '. $columnAlias;
1391
1392 477
                    $this->scalarResultAliasMap[$resultAlias][] = $columnAlias;
1393
1394 477
                    $this->rsm->addFieldResult($dqlAlias, $columnAlias, $fieldName, $class->name);
1395
                }
1396
1397
                // Add any additional fields of subclasses (excluding inherited fields)
1398
                // 1) on Single Table Inheritance: always, since its marginal overhead
1399
                // 2) on Class Table Inheritance only if partial objects are disallowed,
1400
                //    since it requires outer joining subtables.
1401 479
                if ($class->isInheritanceTypeSingleTable() || ! $this->query->getHint(Query::HINT_FORCE_PARTIAL_LOAD)) {
1402 385
                    foreach ($class->subClasses as $subClassName) {
1403 40
                        $subClass      = $this->em->getClassMetadata($subClassName);
1404 40
                        $sqlTableAlias = $this->getSQLTableAlias($subClass->getTableName(), $dqlAlias);
1405
1406 40
                        foreach ($subClass->fieldMappings as $fieldName => $mapping) {
1407 40
                            if (isset($mapping['inherited']) || ($partialFieldSet && !in_array($fieldName, $partialFieldSet))) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $partialFieldSet of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1408 40
                                continue;
1409
                            }
1410
1411 34
                            $columnAlias      = $this->getSQLColumnAlias($mapping['columnName']);
1412 34
                            $quotedColumnName = $this->quoteStrategy->getColumnName($fieldName, $subClass, $this->platform);
1413
1414 34
                            $col = $sqlTableAlias . '.' . $quotedColumnName;
1415
1416 34
                            if (isset($mapping['requireSQLConversion'])) {
1417
                                $type = Type::getType($mapping['type']);
1418
                                $col = $type->convertToPHPValueSQL($col, $this->platform);
1419
                            }
1420
1421 34
                            $sqlParts[] = $col . ' AS ' . $columnAlias;
1422
1423 34
                            $this->scalarResultAliasMap[$resultAlias][] = $columnAlias;
1424
1425 40
                            $this->rsm->addFieldResult($dqlAlias, $columnAlias, $fieldName, $subClassName);
1426
                        }
1427
                    }
1428
                }
1429
1430 479
                $sql .= implode(', ', $sqlParts);
1431
        }
1432
1433 615
        return $sql;
1434
    }
1435
1436
    /**
1437
     * {@inheritdoc}
1438
     */
1439
    public function walkQuantifiedExpression($qExpr)
1440
    {
1441
        return ' ' . strtoupper($qExpr->type) . '(' . $this->walkSubselect($qExpr->subselect) . ')';
1442
    }
1443
1444
    /**
1445
     * {@inheritdoc}
1446
     */
1447 33
    public function walkSubselect($subselect)
1448
    {
1449 33
        $useAliasesBefore  = $this->useSqlTableAliases;
1450 33
        $rootAliasesBefore = $this->rootAliases;
1451
1452 33
        $this->rootAliases = []; // reset the rootAliases for the subselect
1453 33
        $this->useSqlTableAliases = true;
1454
1455 33
        $sql  = $this->walkSimpleSelectClause($subselect->simpleSelectClause);
1456 33
        $sql .= $this->walkSubselectFromClause($subselect->subselectFromClause);
1457 33
        $sql .= $this->walkWhereClause($subselect->whereClause);
0 ignored issues
show
Bug introduced by
It seems like $subselect->whereClause can be null; however, walkWhereClause() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
1458
1459 33
        $sql .= $subselect->groupByClause ? $this->walkGroupByClause($subselect->groupByClause) : '';
1460 33
        $sql .= $subselect->havingClause ? $this->walkHavingClause($subselect->havingClause) : '';
1461 33
        $sql .= $subselect->orderByClause ? $this->walkOrderByClause($subselect->orderByClause) : '';
1462
1463 33
        $this->rootAliases        = $rootAliasesBefore; // put the main aliases back
1464 33
        $this->useSqlTableAliases = $useAliasesBefore;
1465
1466 33
        return $sql;
1467
    }
1468
1469
    /**
1470
     * {@inheritdoc}
1471
     */
1472 33
    public function walkSubselectFromClause($subselectFromClause)
1473
    {
1474 33
        $identificationVarDecls = $subselectFromClause->identificationVariableDeclarations;
1475 33
        $sqlParts               = [];
1476
1477 33
        foreach ($identificationVarDecls as $subselectIdVarDecl) {
1478 33
            $sqlParts[] = $this->walkIdentificationVariableDeclaration($subselectIdVarDecl);
1479
        }
1480
1481 33
        return ' FROM ' . implode(', ', $sqlParts);
1482
    }
1483
1484
    /**
1485
     * {@inheritdoc}
1486
     */
1487 33
    public function walkSimpleSelectClause($simpleSelectClause)
1488
    {
1489 33
        return 'SELECT' . ($simpleSelectClause->isDistinct ? ' DISTINCT' : '')
1490 33
            . $this->walkSimpleSelectExpression($simpleSelectClause->simpleSelectExpression);
1491
    }
1492
1493
    /**
1494
     * @param \Doctrine\ORM\Query\AST\ParenthesisExpression $parenthesisExpression
1495
     *
1496
     * @return string.
0 ignored issues
show
Documentation introduced by
The doc-type string. could not be parsed: Unknown type name "string." at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
1497
     */
1498 22
    public function walkParenthesisExpression(AST\ParenthesisExpression $parenthesisExpression)
1499
    {
1500 22
        return sprintf('(%s)', $parenthesisExpression->expression->dispatch($this));
1501
    }
1502
1503
    /**
1504
     * @param AST\NewObjectExpression $newObjectExpression
1505
     *
1506
     * @return string The SQL.
1507
     */
1508 22
    public function walkNewObject($newObjectExpression, $newObjectResultAlias=null)
1509
    {
1510 22
        $sqlSelectExpressions = [];
1511 22
        $objIndex             = $newObjectResultAlias?:$this->newObjectCounter++;
1512
1513 22
        foreach ($newObjectExpression->args as $argIndex => $e) {
1514 22
            $resultAlias = $this->scalarResultCounter++;
1515 22
            $columnAlias = $this->getSQLColumnAlias('sclr');
1516 22
            $fieldType   = 'string';
1517
1518
            switch (true) {
1519 22
                case ($e instanceof AST\NewObjectExpression):
1520
                    $sqlSelectExpressions[] = $e->dispatch($this);
1521
                    break;
1522
1523
                case ($e instanceof AST\Subselect):
1524 1
                    $sqlSelectExpressions[] = '(' . $e->dispatch($this) . ') AS ' . $columnAlias;
1525 1
                    break;
1526
1527
                case ($e instanceof AST\PathExpression):
1528 22
                    $dqlAlias  = $e->identificationVariable;
1529 22
                    $qComp     = $this->queryComponents[$dqlAlias];
1530 22
                    $class     = $qComp['metadata'];
1531 22
                    $fieldType = $class->fieldMappings[$e->field]['type'];
1532
1533 22
                    $sqlSelectExpressions[] = trim($e->dispatch($this)) . ' AS ' . $columnAlias;
1534 22
                    break;
1535
1536 5
                case ($e instanceof AST\Literal):
1537 1
                    switch ($e->type) {
1538 1
                        case AST\Literal::BOOLEAN:
1539 1
                            $fieldType = 'boolean';
1540 1
                            break;
1541
1542 1
                        case AST\Literal::NUMERIC:
1543 1
                            $fieldType = is_float($e->value) ? 'float' : 'integer';
1544 1
                            break;
1545
                    }
1546
1547 1
                    $sqlSelectExpressions[] = trim($e->dispatch($this)) . ' AS ' . $columnAlias;
1548 1
                    break;
1549
1550
                default:
1551 5
                    $sqlSelectExpressions[] = trim($e->dispatch($this)) . ' AS ' . $columnAlias;
1552 5
                    break;
1553
            }
1554
1555 22
            $this->scalarResultAliasMap[$resultAlias] = $columnAlias;
1556 22
            $this->rsm->addScalarResult($columnAlias, $resultAlias, $fieldType);
1557
1558 22
            $this->rsm->newObjectMappings[$columnAlias] = [
1559 22
                'className' => $newObjectExpression->className,
1560 22
                'objIndex'  => $objIndex,
1561 22
                'argIndex'  => $argIndex
1562
            ];
1563
        }
1564
1565 22
        return implode(', ', $sqlSelectExpressions);
1566
    }
1567
1568
    /**
1569
     * {@inheritdoc}
1570
     */
1571 33
    public function walkSimpleSelectExpression($simpleSelectExpression)
1572
    {
1573 33
        $expr = $simpleSelectExpression->expression;
1574 33
        $sql  = ' ';
1575
1576
        switch (true) {
1577 33
            case ($expr instanceof AST\PathExpression):
1578 9
                $sql .= $this->walkPathExpression($expr);
1579 9
                break;
1580
1581
            case ($expr instanceof AST\AggregateExpression):
1582 14
                $alias = $simpleSelectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
1583
1584 14
                $sql .= $this->walkAggregateExpression($expr) . ' AS dctrn__' . $alias;
1585 14
                break;
1586
1587
            case ($expr instanceof AST\Subselect):
1588
                $alias = $simpleSelectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
1589
1590
                $columnAlias = 'sclr' . $this->aliasCounter++;
1591
                $this->scalarResultAliasMap[$alias] = $columnAlias;
1592
1593
                $sql .= '(' . $this->walkSubselect($expr) . ') AS ' . $columnAlias;
1594
                break;
1595
1596
            case ($expr instanceof AST\Functions\FunctionNode):
1597
            case ($expr instanceof AST\SimpleArithmeticExpression):
1598
            case ($expr instanceof AST\ArithmeticTerm):
1599
            case ($expr instanceof AST\ArithmeticFactor):
1600
            case ($expr instanceof AST\Literal):
1601
            case ($expr instanceof AST\NullIfExpression):
1602
            case ($expr instanceof AST\CoalesceExpression):
1603
            case ($expr instanceof AST\GeneralCaseExpression):
1604
            case ($expr instanceof AST\SimpleCaseExpression):
1605 8
                $alias = $simpleSelectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++;
1606
1607 8
                $columnAlias = $this->getSQLColumnAlias('sclr');
1608 8
                $this->scalarResultAliasMap[$alias] = $columnAlias;
1609
1610 8
                $sql .= $expr->dispatch($this) . ' AS ' . $columnAlias;
1611 8
                break;
1612
1613 2
            case ($expr instanceof AST\ParenthesisExpression):
1614 1
                $sql .= $this->walkParenthesisExpression($expr);
1615 1
                break;
1616
1617
            default: // IdentificationVariable
1618 2
                $sql .= $this->walkEntityIdentificationVariable($expr);
1619 2
                break;
1620
        }
1621
1622 33
        return $sql;
1623
    }
1624
1625
    /**
1626
     * {@inheritdoc}
1627
     */
1628 75
    public function walkAggregateExpression($aggExpression)
1629
    {
1630 75
        return $aggExpression->functionName . '(' . ($aggExpression->isDistinct ? 'DISTINCT ' : '')
1631 75
            . $this->walkSimpleArithmeticExpression($aggExpression->pathExpression) . ')';
0 ignored issues
show
Bug introduced by
It seems like $aggExpression->pathExpression can also be of type object<Doctrine\ORM\Query\AST\PathExpression>; however, Doctrine\ORM\Query\SqlWa...eArithmeticExpression() does only seem to accept object<Doctrine\ORM\Quer...leArithmeticExpression>, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
1632
    }
1633
1634
    /**
1635
     * {@inheritdoc}
1636
     */
1637 23
    public function walkGroupByClause($groupByClause)
1638
    {
1639 23
        $sqlParts = [];
1640
1641 23
        foreach ($groupByClause->groupByItems as $groupByItem) {
1642 23
            $sqlParts[] = $this->walkGroupByItem($groupByItem);
1643
        }
1644
1645 23
        return ' GROUP BY ' . implode(', ', $sqlParts);
1646
    }
1647
1648
    /**
1649
     * {@inheritdoc}
1650
     */
1651 23
    public function walkGroupByItem($groupByItem)
1652
    {
1653
        // StateFieldPathExpression
1654 23
        if ( ! is_string($groupByItem)) {
1655 10
            return $this->walkPathExpression($groupByItem);
1656
        }
1657
1658
        // ResultVariable
1659 13
        if (isset($this->queryComponents[$groupByItem]['resultVariable'])) {
1660 2
            $resultVariable = $this->queryComponents[$groupByItem]['resultVariable'];
1661
1662 2
            if ($resultVariable instanceof AST\PathExpression) {
1663 1
                return $this->walkPathExpression($resultVariable);
1664
            }
1665
1666 1
            if (isset($resultVariable->pathExpression)) {
1667
                return $this->walkPathExpression($resultVariable->pathExpression);
1668
            }
1669
1670 1
            return $this->walkResultVariable($groupByItem);
1671
        }
1672
1673
        // IdentificationVariable
1674 11
        $sqlParts = [];
1675
1676 11
        foreach ($this->queryComponents[$groupByItem]['metadata']->fieldNames as $field) {
1677 11
            $item       = new AST\PathExpression(AST\PathExpression::TYPE_STATE_FIELD, $groupByItem, $field);
1678 11
            $item->type = AST\PathExpression::TYPE_STATE_FIELD;
1679
1680 11
            $sqlParts[] = $this->walkPathExpression($item);
1681
        }
1682
1683 11
        foreach ($this->queryComponents[$groupByItem]['metadata']->associationMappings as $mapping) {
1684 11
            if ($mapping['isOwningSide'] && $mapping['type'] & ClassMetadataInfo::TO_ONE) {
1685 7
                $item       = new AST\PathExpression(AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION, $groupByItem, $mapping['fieldName']);
1686 7
                $item->type = AST\PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION;
1687
1688 11
                $sqlParts[] = $this->walkPathExpression($item);
1689
            }
1690
        }
1691
1692 11
        return implode(', ', $sqlParts);
1693
    }
1694
1695
    /**
1696
     * {@inheritdoc}
1697
     */
1698 36
    public function walkDeleteClause(AST\DeleteClause $deleteClause)
1699
    {
1700 36
        $class     = $this->em->getClassMetadata($deleteClause->abstractSchemaName);
1701 36
        $tableName = $class->getTableName();
1702 36
        $sql       = 'DELETE FROM ' . $this->quoteStrategy->getTableName($class, $this->platform);
1703
1704 36
        $this->setSQLTableAlias($tableName, $tableName, $deleteClause->aliasIdentificationVariable);
1705 36
        $this->rootAliases[] = $deleteClause->aliasIdentificationVariable;
1706
1707 36
        return $sql;
1708
    }
1709
1710
    /**
1711
     * {@inheritdoc}
1712
     */
1713 24
    public function walkUpdateClause($updateClause)
1714
    {
1715 24
        $class     = $this->em->getClassMetadata($updateClause->abstractSchemaName);
1716 24
        $tableName = $class->getTableName();
1717 24
        $sql       = 'UPDATE ' . $this->quoteStrategy->getTableName($class, $this->platform);
1718
1719 24
        $this->setSQLTableAlias($tableName, $tableName, $updateClause->aliasIdentificationVariable);
1720 24
        $this->rootAliases[] = $updateClause->aliasIdentificationVariable;
1721
1722 24
        $sql .= ' SET ' . implode(', ', array_map([$this, 'walkUpdateItem'], $updateClause->updateItems));
1723
1724 24
        return $sql;
1725
    }
1726
1727
    /**
1728
     * {@inheritdoc}
1729
     */
1730 27
    public function walkUpdateItem($updateItem)
1731
    {
1732 27
        $useTableAliasesBefore = $this->useSqlTableAliases;
1733 27
        $this->useSqlTableAliases = false;
1734
1735 27
        $sql      = $this->walkPathExpression($updateItem->pathExpression) . ' = ';
1736 27
        $newValue = $updateItem->newValue;
1737
1738
        switch (true) {
1739 27
            case ($newValue instanceof AST\Node):
1740 26
                $sql .= $newValue->dispatch($this);
1741 26
                break;
1742
1743 1
            case ($newValue === null):
1744 1
                $sql .= 'NULL';
1745 1
                break;
1746
1747
            default:
1748
                $sql .= $this->conn->quote($newValue);
1749
                break;
1750
        }
1751
1752 27
        $this->useSqlTableAliases = $useTableAliasesBefore;
1753
1754 27
        return $sql;
1755
    }
1756
1757
    /**
1758
     * {@inheritdoc}
1759
     */
1760 670
    public function walkWhereClause($whereClause)
1761
    {
1762 670
        $condSql  = null !== $whereClause ? $this->walkConditionalExpression($whereClause->conditionalExpression) : '';
1763 667
        $discrSql = $this->_generateDiscriminatorColumnConditionSql($this->rootAliases);
1764
1765 667
        if ($this->em->hasFilters()) {
1766 43
            $filterClauses = [];
1767 43
            foreach ($this->rootAliases as $dqlAlias) {
1768 43
                $class = $this->queryComponents[$dqlAlias]['metadata'];
1769 43
                $tableAlias = $this->getSQLTableAlias($class->table['name'], $dqlAlias);
1770
1771 43
                if ($filterExpr = $this->generateFilterConditionSQL($class, $tableAlias)) {
1772 43
                    $filterClauses[] = $filterExpr;
1773
                }
1774
            }
1775
1776 43
            if (count($filterClauses)) {
1777 6
                if ($condSql) {
1778 2
                    $condSql = '(' . $condSql . ') AND ';
1779
                }
1780
1781 6
                $condSql .= implode(' AND ', $filterClauses);
1782
            }
1783
        }
1784
1785 667
        if ($condSql) {
1786 327
            return ' WHERE ' . (( ! $discrSql) ? $condSql : '(' . $condSql . ') AND ' . $discrSql);
1787
        }
1788
1789 415
        if ($discrSql) {
1790 21
            return ' WHERE ' . $discrSql;
1791
        }
1792
1793 395
        return '';
1794
    }
1795
1796
    /**
1797
     * {@inheritdoc}
1798
     */
1799 357
    public function walkConditionalExpression($condExpr)
1800
    {
1801
        // Phase 2 AST optimization: Skip processing of ConditionalExpression
1802
        // if only one ConditionalTerm is defined
1803 357
        if ( ! ($condExpr instanceof AST\ConditionalExpression)) {
1804 302
            return $this->walkConditionalTerm($condExpr);
1805
        }
1806
1807 72
        return implode(' OR ', array_map([$this, 'walkConditionalTerm'], $condExpr->conditionalTerms));
1808
    }
1809
1810
    /**
1811
     * {@inheritdoc}
1812
     */
1813 357
    public function walkConditionalTerm($condTerm)
1814
    {
1815
        // Phase 2 AST optimization: Skip processing of ConditionalTerm
1816
        // if only one ConditionalFactor is defined
1817 357
        if ( ! ($condTerm instanceof AST\ConditionalTerm)) {
1818 291
            return $this->walkConditionalFactor($condTerm);
1819
        }
1820
1821 89
        return implode(' AND ', array_map([$this, 'walkConditionalFactor'], $condTerm->conditionalFactors));
1822
    }
1823
1824
    /**
1825
     * {@inheritdoc}
1826
     */
1827 357
    public function walkConditionalFactor($factor)
1828
    {
1829
        // Phase 2 AST optimization: Skip processing of ConditionalFactor
1830
        // if only one ConditionalPrimary is defined
1831 357
        return ( ! ($factor instanceof AST\ConditionalFactor))
1832 354
            ? $this->walkConditionalPrimary($factor)
1833 354
            : ($factor->not ? 'NOT ' : '') . $this->walkConditionalPrimary($factor->conditionalPrimary);
1834
    }
1835
1836
    /**
1837
     * {@inheritdoc}
1838
     */
1839 357
    public function walkConditionalPrimary($primary)
1840
    {
1841 357
        if ($primary->isSimpleConditionalExpression()) {
1842 357
            return $primary->simpleConditionalExpression->dispatch($this);
1843
        }
1844
1845 25
        if ($primary->isConditionalExpression()) {
1846 25
            $condExpr = $primary->conditionalExpression;
1847
1848 25
            return '(' . $this->walkConditionalExpression($condExpr) . ')';
0 ignored issues
show
Bug introduced by
It seems like $condExpr defined by $primary->conditionalExpression on line 1846 can be null; however, Doctrine\ORM\Query\SqlWa...ConditionalExpression() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
1849
        }
1850
    }
1851
1852
    /**
1853
     * {@inheritdoc}
1854
     */
1855 5
    public function walkExistsExpression($existsExpr)
1856
    {
1857 5
        $sql = ($existsExpr->not) ? 'NOT ' : '';
1858
1859 5
        $sql .= 'EXISTS (' . $this->walkSubselect($existsExpr->subselect) . ')';
1860
1861 5
        return $sql;
1862
    }
1863
1864
    /**
1865
     * {@inheritdoc}
1866
     */
1867 6
    public function walkCollectionMemberExpression($collMemberExpr)
1868
    {
1869 6
        $sql = $collMemberExpr->not ? 'NOT ' : '';
1870 6
        $sql .= 'EXISTS (SELECT 1 FROM ';
1871
1872 6
        $entityExpr   = $collMemberExpr->entityExpression;
1873 6
        $collPathExpr = $collMemberExpr->collectionValuedPathExpression;
1874
1875 6
        $fieldName = $collPathExpr->field;
1876 6
        $dqlAlias  = $collPathExpr->identificationVariable;
1877
1878 6
        $class = $this->queryComponents[$dqlAlias]['metadata'];
1879
1880
        switch (true) {
1881
            // InputParameter
1882 6
            case ($entityExpr instanceof AST\InputParameter):
1883 4
                $dqlParamKey = $entityExpr->name;
1884 4
                $entitySql   = '?';
1885 4
                break;
1886
1887
            // SingleValuedAssociationPathExpression | IdentificationVariable
1888
            case ($entityExpr instanceof AST\PathExpression):
1889 2
                $entitySql = $this->walkPathExpression($entityExpr);
1890 2
                break;
1891
1892
            default:
1893
                throw new \BadMethodCallException("Not implemented");
1894
        }
1895
1896 6
        $assoc = $class->associationMappings[$fieldName];
1897
1898 6
        if ($assoc['type'] == ClassMetadata::ONE_TO_MANY) {
1899 1
            $targetClass      = $this->em->getClassMetadata($assoc['targetEntity']);
1900 1
            $targetTableAlias = $this->getSQLTableAlias($targetClass->getTableName());
1901 1
            $sourceTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
1902
1903 1
            $sql .= $this->quoteStrategy->getTableName($targetClass, $this->platform) . ' ' . $targetTableAlias . ' WHERE ';
1904
1905 1
            $owningAssoc = $targetClass->associationMappings[$assoc['mappedBy']];
1906 1
            $sqlParts    = [];
1907
1908 1
            foreach ($owningAssoc['targetToSourceKeyColumns'] as $targetColumn => $sourceColumn) {
1909 1
                $targetColumn = $this->quoteStrategy->getColumnName($class->fieldNames[$targetColumn], $class, $this->platform);
1910
1911 1
                $sqlParts[] = $sourceTableAlias . '.' . $targetColumn . ' = ' . $targetTableAlias . '.' . $sourceColumn;
1912
            }
1913
1914 1
            foreach ($this->quoteStrategy->getIdentifierColumnNames($targetClass, $this->platform) as $targetColumnName) {
1915 1
                if (isset($dqlParamKey)) {
1916 1
                    $this->parserResult->addParameterMapping($dqlParamKey, $this->sqlParamIndex++);
1917
                }
1918
1919 1
                $sqlParts[] = $targetTableAlias . '.'  . $targetColumnName . ' = ' . $entitySql;
1920
            }
1921
1922 1
            $sql .= implode(' AND ', $sqlParts);
1923
        } else { // many-to-many
1924 5
            $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
1925
1926 5
            $owningAssoc = $assoc['isOwningSide'] ? $assoc : $targetClass->associationMappings[$assoc['mappedBy']];
1927 5
            $joinTable = $owningAssoc['joinTable'];
1928
1929
            // SQL table aliases
1930 5
            $joinTableAlias   = $this->getSQLTableAlias($joinTable['name']);
1931 5
            $targetTableAlias = $this->getSQLTableAlias($targetClass->getTableName());
1932 5
            $sourceTableAlias = $this->getSQLTableAlias($class->getTableName(), $dqlAlias);
1933
1934
            // join to target table
1935 5
            $sql .= $this->quoteStrategy->getJoinTableName($owningAssoc, $targetClass, $this->platform) . ' ' . $joinTableAlias
1936 5
                . ' INNER JOIN ' . $this->quoteStrategy->getTableName($targetClass, $this->platform) . ' ' . $targetTableAlias . ' ON ';
1937
1938
            // join conditions
1939 5
            $joinColumns  = $assoc['isOwningSide'] ? $joinTable['inverseJoinColumns'] : $joinTable['joinColumns'];
1940 5
            $joinSqlParts = [];
1941
1942 5
            foreach ($joinColumns as $joinColumn) {
1943 5
                $targetColumn = $this->quoteStrategy->getColumnName($targetClass->fieldNames[$joinColumn['referencedColumnName']], $targetClass, $this->platform);
1944
1945 5
                $joinSqlParts[] = $joinTableAlias . '.' . $joinColumn['name'] . ' = ' . $targetTableAlias . '.' . $targetColumn;
1946
            }
1947
1948 5
            $sql .= implode(' AND ', $joinSqlParts);
1949 5
            $sql .= ' WHERE ';
1950
1951 5
            $joinColumns = $assoc['isOwningSide'] ? $joinTable['joinColumns'] : $joinTable['inverseJoinColumns'];
1952 5
            $sqlParts    = [];
1953
1954 5
            foreach ($joinColumns as $joinColumn) {
1955 5
                $targetColumn = $this->quoteStrategy->getColumnName($class->fieldNames[$joinColumn['referencedColumnName']], $class, $this->platform);
1956
1957 5
                $sqlParts[] = $joinTableAlias . '.' . $joinColumn['name'] . ' = ' . $sourceTableAlias . '.' . $targetColumn;
1958
            }
1959
1960 5
            foreach ($this->quoteStrategy->getIdentifierColumnNames($targetClass, $this->platform) as $targetColumnName) {
1961 5
                if (isset($dqlParamKey)) {
1962 3
                    $this->parserResult->addParameterMapping($dqlParamKey, $this->sqlParamIndex++);
1963
                }
1964
1965 5
                $sqlParts[] = $targetTableAlias . '.' . $targetColumnName . ' IN (' . $entitySql . ')';
1966
            }
1967
1968 5
            $sql .= implode(' AND ', $sqlParts);
1969
        }
1970
1971 6
        return $sql . ')';
1972
    }
1973
1974
    /**
1975
     * {@inheritdoc}
1976
     */
1977 3
    public function walkEmptyCollectionComparisonExpression($emptyCollCompExpr)
1978
    {
1979 3
        $sizeFunc = new AST\Functions\SizeFunction('size');
1980 3
        $sizeFunc->collectionPathExpression = $emptyCollCompExpr->expression;
1981
1982 3
        return $sizeFunc->getSql($this) . ($emptyCollCompExpr->not ? ' > 0' : ' = 0');
1983
    }
1984
1985
    /**
1986
     * {@inheritdoc}
1987
     */
1988 11
    public function walkNullComparisonExpression($nullCompExpr)
1989
    {
1990 11
        $expression = $nullCompExpr->expression;
1991 11
        $comparison = ' IS' . ($nullCompExpr->not ? ' NOT' : '') . ' NULL';
1992
1993
        // Handle ResultVariable
1994 11
        if (is_string($expression) && isset($this->queryComponents[$expression]['resultVariable'])) {
1995 2
            return $this->walkResultVariable($expression) . $comparison;
1996
        }
1997
1998
        // Handle InputParameter mapping inclusion to ParserResult
1999 9
        if ($expression instanceof AST\InputParameter) {
2000
            return $this->walkInputParameter($expression) . $comparison;
2001
        }
2002
2003 9
        return $expression->dispatch($this) . $comparison;
2004
    }
2005
2006
    /**
2007
     * {@inheritdoc}
2008
     */
2009 85
    public function walkInExpression($inExpr)
2010
    {
2011 85
        $sql = $this->walkArithmeticExpression($inExpr->expression) . ($inExpr->not ? ' NOT' : '') . ' IN (';
2012
2013 84
        $sql .= ($inExpr->subselect)
2014 7
            ? $this->walkSubselect($inExpr->subselect)
2015 84
            : implode(', ', array_map([$this, 'walkInParameter'], $inExpr->literals));
2016
2017 84
        $sql .= ')';
2018
2019 84
        return $sql;
2020
    }
2021
2022
    /**
2023
     * {@inheritdoc}
2024
     */
2025 9
    public function walkInstanceOfExpression($instanceOfExpr)
2026
    {
2027 9
        $sql = '';
2028
2029 9
        $dqlAlias = $instanceOfExpr->identificationVariable;
2030 9
        $discrClass = $class = $this->queryComponents[$dqlAlias]['metadata'];
2031
2032 9
        if ($class->discriminatorColumn) {
2033 9
            $discrClass = $this->em->getClassMetadata($class->rootEntityName);
2034
        }
2035
2036 9
        if ($this->useSqlTableAliases) {
2037 9
            $sql .= $this->getSQLTableAlias($discrClass->getTableName(), $dqlAlias) . '.';
2038
        }
2039
2040 9
        $sql .= $class->discriminatorColumn['name'] . ($instanceOfExpr->not ? ' NOT IN ' : ' IN ');
2041
2042 9
        $sqlParameterList = [];
2043
2044 9
        foreach ($instanceOfExpr->value as $parameter) {
2045 9
            if ($parameter instanceof AST\InputParameter) {
2046 3
                $this->rsm->addMetadataParameterMapping($parameter->name, 'discriminatorValue');
2047
2048 3
                $sqlParameterList[] = $this->walkInputParameter($parameter);
2049
2050 3
                continue;
2051
            }
2052
2053
            // Get name from ClassMetadata to resolve aliases.
2054 6
            $entityClassName    = $this->em->getClassMetadata($parameter)->name;
2055 6
            $discriminatorValue = $class->discriminatorValue;
2056
2057 6
            if ($entityClassName !== $class->name) {
2058 5
                $discrMap = array_flip($class->discriminatorMap);
2059
2060 5
                if ( ! isset($discrMap[$entityClassName])) {
2061 1
                    throw QueryException::instanceOfUnrelatedClass($entityClassName, $class->rootEntityName);
2062
                }
2063
2064 4
                $discriminatorValue = $discrMap[$entityClassName];
2065
            }
2066
2067 5
            $sqlParameterList[] = $this->conn->quote($discriminatorValue);
2068
        }
2069
2070 8
        $sql .= '(' . implode(', ', $sqlParameterList) . ')';
2071
2072 8
        return $sql;
2073
    }
2074
2075
    /**
2076
     * {@inheritdoc}
2077
     */
2078 77
    public function walkInParameter($inParam)
2079
    {
2080 77
        return $inParam instanceof AST\InputParameter
2081 68
            ? $this->walkInputParameter($inParam)
2082 77
            : $this->walkLiteral($inParam);
2083
    }
2084
2085
    /**
2086
     * {@inheritdoc}
2087
     */
2088 148
    public function walkLiteral($literal)
2089
    {
2090 148
        switch ($literal->type) {
2091 148
            case AST\Literal::STRING:
2092 50
                return $this->conn->quote($literal->value);
2093
2094 111
            case AST\Literal::BOOLEAN:
2095 8
                return $this->conn->getDatabasePlatform()->convertBooleans('true' === strtolower($literal->value));
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->conn->getD...ower($literal->value)); (object|integer|double|string|null|array) is incompatible with the return type declared by the interface Doctrine\ORM\Query\TreeWalker::walkLiteral of type string.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
2096
2097 104
            case AST\Literal::NUMERIC:
2098 104
                return $literal->value;
2099
2100
            default:
2101
                throw QueryException::invalidLiteral($literal);
2102
        }
2103
    }
2104
2105
    /**
2106
     * {@inheritdoc}
2107
     */
2108 6
    public function walkBetweenExpression($betweenExpr)
2109
    {
2110 6
        $sql = $this->walkArithmeticExpression($betweenExpr->expression);
2111
2112 6
        if ($betweenExpr->not) {
2113 2
            $sql .= ' NOT';
2114
        }
2115
2116 6
        $sql .= ' BETWEEN ' . $this->walkArithmeticExpression($betweenExpr->leftBetweenExpression)
2117 6
            . ' AND ' . $this->walkArithmeticExpression($betweenExpr->rightBetweenExpression);
2118
2119 6
        return $sql;
2120
    }
2121
2122
    /**
2123
     * {@inheritdoc}
2124
     */
2125 9
    public function walkLikeExpression($likeExpr)
2126
    {
2127 9
        $stringExpr = $likeExpr->stringExpression;
2128 9
        $leftExpr   = (is_string($stringExpr) && isset($this->queryComponents[$stringExpr]['resultVariable']))
2129 1
            ? $this->walkResultVariable($stringExpr)
2130 9
            : $stringExpr->dispatch($this);
2131
2132 9
        $sql = $leftExpr . ($likeExpr->not ? ' NOT' : '') . ' LIKE ';
2133
2134 9
        if ($likeExpr->stringPattern instanceof AST\InputParameter) {
2135 4
            $sql .= $this->walkInputParameter($likeExpr->stringPattern);
2136 6
        } elseif ($likeExpr->stringPattern instanceof AST\Functions\FunctionNode) {
2137 2
            $sql .= $this->walkFunction($likeExpr->stringPattern);
2138 6
        } elseif ($likeExpr->stringPattern instanceof AST\PathExpression) {
2139 2
            $sql .= $this->walkPathExpression($likeExpr->stringPattern);
2140
        } else {
2141 6
            $sql .= $this->walkLiteral($likeExpr->stringPattern);
2142
        }
2143
2144 9
        if ($likeExpr->escapeChar) {
2145 1
            $sql .= ' ESCAPE ' . $this->walkLiteral($likeExpr->escapeChar);
2146
        }
2147
2148 9
        return $sql;
2149
    }
2150
2151
    /**
2152
     * {@inheritdoc}
2153
     */
2154 5
    public function walkStateFieldPathExpression($stateFieldPathExpression)
2155
    {
2156 5
        return $this->walkPathExpression($stateFieldPathExpression);
2157
    }
2158
2159
    /**
2160
     * {@inheritdoc}
2161
     */
2162 254
    public function walkComparisonExpression($compExpr)
2163
    {
2164 254
        $leftExpr  = $compExpr->leftExpression;
2165 254
        $rightExpr = $compExpr->rightExpression;
2166 254
        $sql       = '';
2167
2168 254
        $sql .= ($leftExpr instanceof AST\Node)
2169 254
            ? $leftExpr->dispatch($this)
2170 253
            : (is_numeric($leftExpr) ? $leftExpr : $this->conn->quote($leftExpr));
2171
2172 253
        $sql .= ' ' . $compExpr->operator . ' ';
2173
2174 253
        $sql .= ($rightExpr instanceof AST\Node)
2175 251
            ? $rightExpr->dispatch($this)
2176 253
            : (is_numeric($rightExpr) ? $rightExpr : $this->conn->quote($rightExpr));
2177
2178 253
        return $sql;
2179
    }
2180
2181
    /**
2182
     * {@inheritdoc}
2183
     */
2184 209
    public function walkInputParameter($inputParam)
2185
    {
2186 209
        $this->parserResult->addParameterMapping($inputParam->name, $this->sqlParamIndex++);
2187
2188 209
        $parameter = $this->query->getParameter($inputParam->name);
2189
2190 209
        if ($parameter && Type::hasType($type = $parameter->getType())) {
2191 51
            return Type::getType($type)->convertToDatabaseValueSQL('?', $this->platform);
2192
        }
2193
2194 163
        return '?';
2195
    }
2196
2197
    /**
2198
     * {@inheritdoc}
2199
     */
2200 320
    public function walkArithmeticExpression($arithmeticExpr)
2201
    {
2202 320
        return ($arithmeticExpr->isSimpleArithmeticExpression())
2203 320
            ? $this->walkSimpleArithmeticExpression($arithmeticExpr->simpleArithmeticExpression)
0 ignored issues
show
Bug introduced by
It seems like $arithmeticExpr->simpleArithmeticExpression can be null; however, walkSimpleArithmeticExpression() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
2204 318
            : '(' . $this->walkSubselect($arithmeticExpr->subselect) . ')';
0 ignored issues
show
Bug introduced by
It seems like $arithmeticExpr->subselect can be null; however, walkSubselect() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
2205
    }
2206
2207
    /**
2208
     * {@inheritdoc}
2209
     */
2210 382
    public function walkSimpleArithmeticExpression($simpleArithmeticExpr)
2211
    {
2212 382
        if ( ! ($simpleArithmeticExpr instanceof AST\SimpleArithmeticExpression)) {
2213 332
            return $this->walkArithmeticTerm($simpleArithmeticExpr);
2214
        }
2215
2216 75
        return implode(' ', array_map([$this, 'walkArithmeticTerm'], $simpleArithmeticExpr->arithmeticTerms));
2217
    }
2218
2219
    /**
2220
     * {@inheritdoc}
2221
     */
2222 403
    public function walkArithmeticTerm($term)
2223
    {
2224 403
        if (is_string($term)) {
2225 21
            return (isset($this->queryComponents[$term]))
2226 6
                ? $this->walkResultVariable($this->queryComponents[$term]['token']['value'])
2227 21
                : $term;
2228
        }
2229
2230
        // Phase 2 AST optimization: Skip processing of ArithmeticTerm
2231
        // if only one ArithmeticFactor is defined
2232 402
        if ( ! ($term instanceof AST\ArithmeticTerm)) {
2233 380
            return $this->walkArithmeticFactor($term);
2234
        }
2235
2236 47
        return implode(' ', array_map([$this, 'walkArithmeticFactor'], $term->arithmeticFactors));
2237
    }
2238
2239
    /**
2240
     * {@inheritdoc}
2241
     */
2242 403
    public function walkArithmeticFactor($factor)
2243
    {
2244 403
        if (is_string($factor)) {
2245 47
            return (isset($this->queryComponents[$factor]))
2246 2
                ? $this->walkResultVariable($this->queryComponents[$factor]['token']['value'])
2247 47
                : $factor;
2248
        }
2249
2250
        // Phase 2 AST optimization: Skip processing of ArithmeticFactor
2251
        // if only one ArithmeticPrimary is defined
2252 403
        if ( ! ($factor instanceof AST\ArithmeticFactor)) {
2253 402
            return $this->walkArithmeticPrimary($factor);
2254
        }
2255
2256 3
        $sign = $factor->isNegativeSigned() ? '-' : ($factor->isPositiveSigned() ? '+' : '');
2257
2258 3
        return $sign . $this->walkArithmeticPrimary($factor->arithmeticPrimary);
2259
    }
2260
2261
    /**
2262
     * Walks down an ArithmeticPrimary that represents an AST node, thereby generating the appropriate SQL.
2263
     *
2264
     * @param mixed $primary
2265
     *
2266
     * @return string The SQL.
2267
     */
2268 403
    public function walkArithmeticPrimary($primary)
2269
    {
2270 403
        if ($primary instanceof AST\SimpleArithmeticExpression) {
2271
            return '(' . $this->walkSimpleArithmeticExpression($primary) . ')';
2272
        }
2273
2274 403
        if ($primary instanceof AST\Node) {
2275 403
            return $primary->dispatch($this);
2276
        }
2277
2278
        return $this->walkEntityIdentificationVariable($primary);
2279
    }
2280
2281
    /**
2282
     * {@inheritdoc}
2283
     */
2284 18
    public function walkStringPrimary($stringPrimary)
2285
    {
2286 18
        return (is_string($stringPrimary))
2287
            ? $this->conn->quote($stringPrimary)
2288 18
            : $stringPrimary->dispatch($this);
2289
    }
2290
2291
    /**
2292
     * {@inheritdoc}
2293
     */
2294 30
    public function walkResultVariable($resultVariable)
2295
    {
2296 30
        $resultAlias = $this->scalarResultAliasMap[$resultVariable];
2297
2298 30
        if (is_array($resultAlias)) {
2299 1
            return implode(', ', $resultAlias);
2300
        }
2301
2302 29
        return $resultAlias;
2303
    }
2304
}
2305