Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix parameter name comparison in AbstractQuery regarding different types (fixes #6699) #6705

Merged
merged 3 commits into from
Nov 24, 2017
Merged

Fix parameter name comparison in AbstractQuery regarding different types (fixes #6699) #6705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bbb106
Add failing test for #6699
Majkl578 Sep 16, 2017
6cb5a9c
Fix parameter name comparison in AbstractQuery#setParameter() with di…
Majkl578 Nov 24, 2017
b8fd708
Fix parameter name comparison in QueryBuilder#setParameter() with dif…
lcobucci Nov 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions lib/Doctrine/ORM/AbstractQuery.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,14 +321,14 @@ public function getParameters()
public function getParameter($key)
{
$filteredParameters = $this->parameters->filter(
function ($parameter) use ($key)
{
// Must not be identical because of string to integer conversion
return ($key == $parameter->getName());
function (Query\Parameter $parameter) use ($key) : bool {
$parameterName = $parameter->getName();

return $key === $parameterName || (string) $key === (string) $parameterName;
}
);

return count($filteredParameters) ? $filteredParameters->first() : null;
return ! $filteredParameters->isEmpty() ? $filteredParameters->first() : null;
}

/**
Expand Down Expand Up @@ -369,17 +369,10 @@ public function setParameters($parameters)
*/
public function setParameter($key, $value, $type = null)
{
$filteredParameters = $this->parameters->filter(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice simplification here, do we have any impact on performance (due to the additional method call)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just tested, the answer is: we have no performance impact

function ($parameter) use ($key)
{
// Must not be identical because of string to integer conversion
return ($key == $parameter->getName());
}
);
$existingParameter = $this->getParameter($key);

if (count($filteredParameters)) {
$parameter = $filteredParameters->first();
$parameter->setValue($value, $type);
if ($existingParameter !== null) {
$existingParameter->setValue($value, $type);

return $this;
}
Expand Down
30 changes: 9 additions & 21 deletions lib/Doctrine/ORM/QueryBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,26 +532,15 @@ public function getRootEntities()
*/
public function setParameter($key, $value, $type = null)
{
$filteredParameters = $this->parameters->filter(
function ($parameter) use ($key)
{
/* @var Query\Parameter $parameter */
// Must not be identical because of string to integer conversion
return ($key == $parameter->getName());
}
);
$existingParameter = $this->getParameter($key);

if (count($filteredParameters)) {
/* @var Query\Parameter $parameter */
$parameter = $filteredParameters->first();
$parameter->setValue($value, $type);
if ($existingParameter !== null) {
$existingParameter->setValue($value, $type);

return $this;
}

$parameter = new Query\Parameter($key, $value, $type);

$this->parameters->add($parameter);
$this->parameters->add(new Query\Parameter($key, $value, $type));

return $this;
}
Expand Down Expand Up @@ -614,15 +603,14 @@ public function getParameters()
public function getParameter($key)
{
$filteredParameters = $this->parameters->filter(
function ($parameter) use ($key)
{
/* @var Query\Parameter $parameter */
// Must not be identical because of string to integer conversion
return ($key == $parameter->getName());
function (Query\Parameter $parameter) use ($key) : bool {
$parameterName = $parameter->getName();

return $key === $parameterName || (string) $key === (string) $parameterName;
}
);

return count($filteredParameters) ? $filteredParameters->first() : null;
return ! $filteredParameters->isEmpty() ? $filteredParameters->first() : null;
}

/**
Expand Down
56 changes: 56 additions & 0 deletions tests/Doctrine/Tests/ORM/Functional/Ticket/GH6699Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<?php

namespace Doctrine\Tests\ORM\Functional\Ticket;

use Doctrine\Tests\Models\CMS\CmsUser;
use Doctrine\Tests\OrmFunctionalTestCase;

/**
* @group 6699
*/
final class GH6699Test extends OrmFunctionalTestCase
{
protected function setUp() : void
{
$this->useModelSet('cms');

parent::setUp();
}

public function testMixedParametersWithZeroNumber() : void
{
$query = $this->_em->createQueryBuilder()
->select('u')
->from(CmsUser::class, 'u')
->andWhere('u.username = :username')
->andWhere('u.id = ?0')
->getQuery();

$query->setParameter('username', 'bar');
$query->setParameter(0, 0);

$query->execute();

self::assertCount(2, $query->getParameters());
self::assertSame(0, $query->getParameter(0)->getValue());
self::assertSame('bar', $query->getParameter('username')->getValue());
}

public function testMixedParametersWithZeroNumberOnQueryBuilder() : void
{
$query = $this->_em->createQueryBuilder()
->select('u')
->from(CmsUser::class, 'u')
->andWhere('u.username = :username')
->andWhere('u.id = ?0')
->setParameter('username', 'bar')
->setParameter(0, 0)
->getQuery();

$query->execute();

self::assertCount(2, $query->getParameters());
self::assertSame(0, $query->getParameter(0)->getValue());
self::assertSame('bar', $query->getParameter('username')->getValue());
}
}
63 changes: 63 additions & 0 deletions tests/Doctrine/Tests/ORM/Query/QueryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Doctrine\Tests\Mocks\DriverConnectionMock;
use Doctrine\Tests\Mocks\StatementArrayMock;
use Doctrine\Tests\Models\CMS\CmsAddress;
use Doctrine\Tests\Models\CMS\CmsUser;
use Doctrine\Tests\OrmTestCase;

class QueryTest extends OrmTestCase
Expand Down Expand Up @@ -303,4 +304,66 @@ public function testSelectFromSubquery()
$this->expectExceptionMessage('Subquery');
$query->getSQL();
}

/**
* @group 6699
*/
public function testGetParameterTypeJuggling() : void
{
$query = $this->_em->createQuery('select u from ' . CmsUser::class . ' u where u.id = ?0');

$query->setParameter(0, 0);

self::assertCount(1, $query->getParameters());
self::assertSame(0, $query->getParameter(0)->getValue());
self::assertSame(0, $query->getParameter('0')->getValue());
}

/**
* @group 6699
*/
public function testSetParameterWithNameZeroIsNotOverridden() : void
{
$query = $this->_em->createQuery('select u from ' . CmsUser::class . ' u where u.id != ?0 and u.username = :name');

$query->setParameter(0, 0);
$query->setParameter('name', 'Doctrine');

self::assertCount(2, $query->getParameters());
self::assertSame(0, $query->getParameter('0')->getValue());
self::assertSame('Doctrine', $query->getParameter('name')->getValue());
}

/**
* @group 6699
*/
public function testSetParameterWithNameZeroDoesNotOverrideAnotherParameter() : void
{
$query = $this->_em->createQuery('select u from ' . CmsUser::class . ' u where u.id != ?0 and u.username = :name');

$query->setParameter('name', 'Doctrine');
$query->setParameter(0, 0);

self::assertCount(2, $query->getParameters());
self::assertSame(0, $query->getParameter(0)->getValue());
self::assertSame('Doctrine', $query->getParameter('name')->getValue());
}

/**
* @group 6699
*/
public function testSetParameterWithTypeJugglingWorks() : void
{
$query = $this->_em->createQuery('select u from ' . CmsUser::class . ' u where u.id != ?0 and u.username = :name');

$query->setParameter('0', 1);
$query->setParameter('name', 'Doctrine');
$query->setParameter(0, 2);
$query->setParameter('0', 3);

self::assertCount(2, $query->getParameters());
self::assertSame(3, $query->getParameter(0)->getValue());
self::assertSame(3, $query->getParameter('0')->getValue());
self::assertSame('Doctrine', $query->getParameter('name')->getValue());
}
}
77 changes: 77 additions & 0 deletions tests/Doctrine/Tests/ORM/QueryBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,4 +1158,81 @@ public function testGetAllAliasesWithJoins()

$this->assertEquals(['u', 'g'], $aliases);
}

/**
* @group 6699
*/
public function testGetParameterTypeJuggling() : void
{
$builder = $this->_em->createQueryBuilder()
->select('u')
->from(CmsUser::class, 'u')
->where('u.id = ?0');

$builder->setParameter(0, 0);

self::assertCount(1, $builder->getParameters());
self::assertSame(0, $builder->getParameter(0)->getValue());
self::assertSame(0, $builder->getParameter('0')->getValue());
}

/**
* @group 6699
*/
public function testSetParameterWithNameZeroIsNotOverridden() : void
{
$builder = $this->_em->createQueryBuilder()
->select('u')
->from(CmsUser::class, 'u')
->where('u.id != ?0')
->andWhere('u.username = :name');

$builder->setParameter(0, 0);
$builder->setParameter('name', 'Doctrine');

self::assertCount(2, $builder->getParameters());
self::assertSame(0, $builder->getParameter('0')->getValue());
self::assertSame('Doctrine', $builder->getParameter('name')->getValue());
}

/**
* @group 6699
*/
public function testSetParameterWithNameZeroDoesNotOverrideAnotherParameter() : void
{
$builder = $this->_em->createQueryBuilder()
->select('u')
->from(CmsUser::class, 'u')
->where('u.id != ?0')
->andWhere('u.username = :name');

$builder->setParameter('name', 'Doctrine');
$builder->setParameter(0, 0);

self::assertCount(2, $builder->getParameters());
self::assertSame(0, $builder->getParameter(0)->getValue());
self::assertSame('Doctrine', $builder->getParameter('name')->getValue());
}

/**
* @group 6699
*/
public function testSetParameterWithTypeJugglingWorks() : void
{
$builder = $this->_em->createQueryBuilder()
->select('u')
->from(CmsUser::class, 'u')
->where('u.id != ?0')
->andWhere('u.username = :name');

$builder->setParameter('0', 1);
$builder->setParameter('name', 'Doctrine');
$builder->setParameter(0, 2);
$builder->setParameter('0', 3);

self::assertCount(2, $builder->getParameters());
self::assertSame(3, $builder->getParameter(0)->getValue());
self::assertSame(3, $builder->getParameter('0')->getValue());
self::assertSame('Doctrine', $builder->getParameter('name')->getValue());
}
}