WhereInWalker::convertWhereInIdentifiersToDatabaseValue() - Code Metrics - Inspection of "Bug: #7820 paginator ignores dbal type conversions..." - doctrine/orm - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 2.6 (#7821)

by Marco

created 2019-09-20 13:04 UTC

convertWhereInIdentifiersToDatabaseValue() A

↳ Parent: WhereInWalker

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	11
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	18
ccs	11
cts	11
cp	1
crap	1
rs	9.9

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\ORM\Tools\Pagination;

use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Query\AST\ArithmeticExpression;
use Doctrine\ORM\Query\AST\ConditionalExpression;
use Doctrine\ORM\Query\AST\ConditionalFactor;
use Doctrine\ORM\Query\AST\ConditionalPrimary;
use Doctrine\ORM\Query\AST\ConditionalTerm;
use Doctrine\ORM\Query\AST\InExpression;
use Doctrine\ORM\Query\AST\InputParameter;
use Doctrine\ORM\Query\AST\NullComparisonExpression;
use Doctrine\ORM\Query\AST\PathExpression;
use Doctrine\ORM\Query\AST\SelectStatement;
use Doctrine\ORM\Query\AST\SimpleArithmeticExpression;
use Doctrine\ORM\Query\AST\WhereClause;
use Doctrine\ORM\Query\TreeWalkerAdapter;
use Doctrine\ORM\Utility\PersisterHelper;
use function array_map;
use function assert;
use function is_array;

/**
 * Replaces the whereClause of the AST with a WHERE id IN (:foo_1, :foo_2) equivalent.
 *
 * @category    DoctrineExtensions
 * @package     DoctrineExtensions\Paginate
 * @author      David Abdemoulaie <[email protected]>
 * @copyright   Copyright (c) 2010 David Abdemoulaie (http://hobodave.com/)
 * @license     http://hobodave.com/license.txt New BSD License
 */
class WhereInWalker extends TreeWalkerAdapter
{
    /**
     * ID Count hint name.
     */
    const HINT_PAGINATOR_ID_COUNT = 'doctrine.id.count';

    /**
     * Primary key alias for query.
     */
    const PAGINATOR_ID_ALIAS = 'dpid';

    /**
     * Replaces the whereClause in the AST.
     *
     * Generates a clause equivalent to WHERE IN (:dpid_1, :dpid_2, ...)
     *
     * The parameter namespace (dpid) is defined by
     * the PAGINATOR_ID_ALIAS
     *
     * The total number of parameters is retrieved from
     * the HINT_PAGINATOR_ID_COUNT query hint.
     *
     * @param SelectStatement $AST
     *
     * @return void
     *
     * @throws \RuntimeException
     */
    public function walkSelectStatement(SelectStatement $AST)
    {
        $queryComponents = $this->_getQueryComponents();
        // Get the root entity and alias from the AST fromClause
        $from = $AST->fromClause->identificationVariableDeclarations;

        if (count($from) > 1) {
            throw new \RuntimeException("Cannot count query which selects two FROM components, cannot make distinction");
        }

        $fromRoot            = reset($from);
        $rootAlias           = $fromRoot->rangeVariableDeclaration->aliasIdentificationVariable;
        /** @var ClassMetadata $rootClass */
        $rootClass           = $queryComponents[$rootAlias]['metadata'];
        $identifierFieldName = $rootClass->getSingleIdentifierFieldName();

        $pathType = PathExpression::TYPE_STATE_FIELD;
        if (isset($rootClass->associationMappings[$identifierFieldName])) {
            $pathType = PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION;
        }

        $pathExpression       = new PathExpression(PathExpression::TYPE_STATE_FIELD | PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION, $rootAlias, $identifierFieldName);
        $pathExpression->type = $pathType;

        $count = $this->_getQuery()->getHint(self::HINT_PAGINATOR_ID_COUNT);

        if ($count > 0) {
            $arithmeticExpression = new ArithmeticExpression();
            $arithmeticExpression->simpleArithmeticExpression = new SimpleArithmeticExpression(
                [$pathExpression]
            );
            $expression = new InExpression($arithmeticExpression);
            $expression->literals[] = new InputParameter(":" . self::PAGINATOR_ID_ALIAS);

            $this->convertWhereInIdentifiersToDatabaseValue(
                PersisterHelper::getTypeOfField(
                    $identifierFieldName,
                    $rootClass,
                    $this->_getQuery()
                        ->getEntityManager()
                )[0]
            );
        } else {
            $expression = new NullComparisonExpression($pathExpression);
            $expression->not = false;
        }

        $conditionalPrimary = new ConditionalPrimary;
        $conditionalPrimary->simpleConditionalExpression = $expression;
        if ($AST->whereClause) {
            if ($AST->whereClause->conditionalExpression instanceof ConditionalTerm) {

                $AST->whereClause->conditionalExpression->conditionalFactors[] = $conditionalPrimary;
            } elseif ($AST->whereClause->conditionalExpression instanceof ConditionalPrimary) {

                $AST->whereClause->conditionalExpression = new ConditionalExpression(
                    [
                        new ConditionalTerm(
                            [
                                $AST->whereClause->conditionalExpression,
                                $conditionalPrimary
                            ]
                        )
                    ]
                );
            } elseif ($AST->whereClause->conditionalExpression instanceof ConditionalExpression

                || $AST->whereClause->conditionalExpression instanceof ConditionalFactor
            ) {
                $tmpPrimary = new ConditionalPrimary;
                $tmpPrimary->conditionalExpression = $AST->whereClause->conditionalExpression;
                $AST->whereClause->conditionalExpression = new ConditionalTerm(

                    [
                        $tmpPrimary,
                        $conditionalPrimary
                    ]
                );
            }
        } else {
            $AST->whereClause = new WhereClause(
                new ConditionalExpression(
                    [
                        new ConditionalTerm([$conditionalPrimary])
                    ]
                )
            );
        }
    }

    private function convertWhereInIdentifiersToDatabaseValue(string $type) : void
    {
        $query                = $this->_getQuery();
        $identifiersParameter = $query->getParameter(self::PAGINATOR_ID_ALIAS);

        assert($identifiersParameter !== null);

        $identifiers = $identifiersParameter->getValue();

        assert(is_array($identifiers));

        $connection = $this->_getQuery()
            ->getEntityManager()
            ->getConnection();

        $query->setParameter(self::PAGINATOR_ID_ALIAS, array_map(static function ($id) use ($connection, $type) {
            return $connection->convertToDatabaseValue($id, $type);
        }, $identifiers));
    }
}


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\Tools\Pagination;
21
22		use Doctrine\ORM\Mapping\ClassMetadata;
23		use Doctrine\ORM\Query\AST\ArithmeticExpression;
24		use Doctrine\ORM\Query\AST\ConditionalExpression;
25		use Doctrine\ORM\Query\AST\ConditionalFactor;
26		use Doctrine\ORM\Query\AST\ConditionalPrimary;
27		use Doctrine\ORM\Query\AST\ConditionalTerm;
28		use Doctrine\ORM\Query\AST\InExpression;
29		use Doctrine\ORM\Query\AST\InputParameter;
30		use Doctrine\ORM\Query\AST\NullComparisonExpression;
31		use Doctrine\ORM\Query\AST\PathExpression;
32		use Doctrine\ORM\Query\AST\SelectStatement;
33		use Doctrine\ORM\Query\AST\SimpleArithmeticExpression;
34		use Doctrine\ORM\Query\AST\WhereClause;
35		use Doctrine\ORM\Query\TreeWalkerAdapter;
36		use Doctrine\ORM\Utility\PersisterHelper;
37		use function array_map;
38		use function assert;
39		use function is_array;
40
41		/**
42		* Replaces the whereClause of the AST with a WHERE id IN (:foo_1, :foo_2) equivalent.
43		*
44		* @category DoctrineExtensions
45		* @package DoctrineExtensions\Paginate
46		* @author David Abdemoulaie <[email protected]>
47		* @copyright Copyright (c) 2010 David Abdemoulaie (http://hobodave.com/)
48		* @license http://hobodave.com/license.txt New BSD License
49		*/
50		class WhereInWalker extends TreeWalkerAdapter
51		{
52		/**
53		* ID Count hint name.
54		*/
55		const HINT_PAGINATOR_ID_COUNT = 'doctrine.id.count';
56
57		/**
58		* Primary key alias for query.
59		*/
60		const PAGINATOR_ID_ALIAS = 'dpid';
61
62		/**
63		* Replaces the whereClause in the AST.
64		*
65		* Generates a clause equivalent to WHERE IN (:dpid_1, :dpid_2, ...)
66		*
67		* The parameter namespace (dpid) is defined by
68		* the PAGINATOR_ID_ALIAS
69		*
70		* The total number of parameters is retrieved from
71		* the HINT_PAGINATOR_ID_COUNT query hint.
72		*
73		* @param SelectStatement $AST
74		*
75		* @return void
76		*
77		* @throws \RuntimeException
78		*/
79	63	public function walkSelectStatement(SelectStatement $AST)
80		{
81	63	$queryComponents = $this->_getQueryComponents();
82		// Get the root entity and alias from the AST fromClause
83	63	$from = $AST->fromClause->identificationVariableDeclarations;
84
85	63	if (count($from) > 1) {
86		throw new \RuntimeException("Cannot count query which selects two FROM components, cannot make distinction");
87		}
88
89	63	$fromRoot = reset($from);
90	63	$rootAlias = $fromRoot->rangeVariableDeclaration->aliasIdentificationVariable;
91		/** @var ClassMetadata $rootClass */
92	63	$rootClass = $queryComponents[$rootAlias]['metadata'];
93	63	$identifierFieldName = $rootClass->getSingleIdentifierFieldName();
94
95	63	$pathType = PathExpression::TYPE_STATE_FIELD;
96	63	if (isset($rootClass->associationMappings[$identifierFieldName])) {
97	2	$pathType = PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION;
98		}
99
100	63	$pathExpression = new PathExpression(PathExpression::TYPE_STATE_FIELD \| PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION, $rootAlias, $identifierFieldName);
101	63	$pathExpression->type = $pathType;
102
103	63	$count = $this->_getQuery()->getHint(self::HINT_PAGINATOR_ID_COUNT);
104
105	63	if ($count > 0) {
106	63	$arithmeticExpression = new ArithmeticExpression();
107	63	$arithmeticExpression->simpleArithmeticExpression = new SimpleArithmeticExpression(
108	63	[$pathExpression]
109		);
110	63	$expression = new InExpression($arithmeticExpression);
111	63	$expression->literals[] = new InputParameter(":" . self::PAGINATOR_ID_ALIAS);
112
113	63	$this->convertWhereInIdentifiersToDatabaseValue(
114	63	PersisterHelper::getTypeOfField(
115	63	$identifierFieldName,
116	63	$rootClass,
117	63	$this->_getQuery()
118	63	->getEntityManager()
119	63	)[0]
120		);
121		} else {
122		$expression = new NullComparisonExpression($pathExpression);
123		$expression->not = false;
124		}
125
126	63	$conditionalPrimary = new ConditionalPrimary;
127	63	$conditionalPrimary->simpleConditionalExpression = $expression;
128	63	if ($AST->whereClause) {
129	10	if ($AST->whereClause->conditionalExpression instanceof ConditionalTerm) {
		0 ignored issues – show introduced 2018-10-19 14:42 UTC by Report Bug Copy Issue Report `$AST->whereClause->conditionalExpression` is never a sub-type of `Doctrine\ORM\Query\AST\ConditionalTerm`. Loading history...
130	2	$AST->whereClause->conditionalExpression->conditionalFactors[] = $conditionalPrimary;
131	8	} elseif ($AST->whereClause->conditionalExpression instanceof ConditionalPrimary) {
		0 ignored issues – show introduced 2018-10-19 14:42 UTC by Report Bug Copy Issue Report `$AST->whereClause->conditionalExpression` is never a sub-type of `Doctrine\ORM\Query\AST\ConditionalPrimary`. Loading history...
132	5	$AST->whereClause->conditionalExpression = new ConditionalExpression(
133		[
134	5	new ConditionalTerm(
135		[
136	5	$AST->whereClause->conditionalExpression,
137	5	$conditionalPrimary
138		]
139		)
140		]
141		);
142	3	} elseif ($AST->whereClause->conditionalExpression instanceof ConditionalExpression
		0 ignored issues – show introduced 2018-10-19 14:42 UTC by Report Bug Copy Issue Report `$AST->whereClause->conditionalExpression` is always a sub-type of `Doctrine\ORM\Query\AST\ConditionalExpression`. Loading history...
143	3	\|\| $AST->whereClause->conditionalExpression instanceof ConditionalFactor
144		) {
145	3	$tmpPrimary = new ConditionalPrimary;
146	3	$tmpPrimary->conditionalExpression = $AST->whereClause->conditionalExpression;
147	3	$AST->whereClause->conditionalExpression = new ConditionalTerm(
		0 ignored issues – show Documentation Bug introduced 2017-11-23 09:45 UTC by Report Bug Copy Issue Report It seems like `new Doctrine\ORM\Query\A..., $conditionalPrimary))` of type `Doctrine\ORM\Query\AST\ConditionalTerm` is incompatible with the declared type `Doctrine\ORM\Query\AST\ConditionalExpression` of property `$conditionalExpression`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
148		[
149	3	$tmpPrimary,
150	10	$conditionalPrimary
151		]
152		);
153		}
154		} else {
155	53	$AST->whereClause = new WhereClause(
156	53	new ConditionalExpression(
157		[
158	53	new ConditionalTerm([$conditionalPrimary])
159		]
160		)
161		);
162		}
163	63	}
164
165	63	private function convertWhereInIdentifiersToDatabaseValue(string $type) : void
166		{
167	63	$query = $this->_getQuery();
168	63	$identifiersParameter = $query->getParameter(self::PAGINATOR_ID_ALIAS);
169
170	63	assert($identifiersParameter !== null);
171
172	63	$identifiers = $identifiersParameter->getValue();
173
174	63	assert(is_array($identifiers));
175
176	63	$connection = $this->_getQuery()
177	63	->getEntityManager()
178	63	->getConnection();
179
180		$query->setParameter(self::PAGINATOR_ID_ALIAS, array_map(static function ($id) use ($connection, $type) {
181	63	return $connection->convertToDatabaseValue($id, $type);
182	63	}, $identifiers));
183	63	}
184		}
185

doctrine / orm

Pull Request — 2.6 (#7821)

convertWhereInIdentifiersToDatabaseValue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like