Merge pull request #14825 from marius-wieschollek/bugfix/11236
Set parameter type in QBMapper
This commit is contained in:
Morris Jobke
GitHub
commit
c57a16bb0a
2 changed files with 276 additions and 3 deletions
|
|
@ -114,7 +114,8 @@ abstract class QBMapper {
|
||||||
$getter = 'get' . ucfirst($property);
|
$getter = 'get' . ucfirst($property);
|
||||||
$value = $entity->$getter();
|
$value = $entity->$getter();
|
||||||
|
|
||||||
$qb->setValue($column, $qb->createNamedParameter($value));
|
$type = $this->getParameterTypeForProperty($entity, $property);
|
||||||
|
$qb->setValue($column, $qb->createNamedParameter($value, $type));
|
||||||
}
|
}
|
||||||
|
|
||||||
$qb->execute();
|
$qb->execute();
|
||||||
|
|
@ -181,17 +182,48 @@ abstract class QBMapper {
|
||||||
$getter = 'get' . ucfirst($property);
|
$getter = 'get' . ucfirst($property);
|
||||||
$value = $entity->$getter();
|
$value = $entity->$getter();
|
||||||
|
|
||||||
$qb->set($column, $qb->createNamedParameter($value));
|
$type = $this->getParameterTypeForProperty($entity, $property);
|
||||||
|
$qb->set($column, $qb->createNamedParameter($value, $type));
|
||||||
}
|
}
|
||||||
|
|
||||||
$qb->where(
|
$qb->where(
|
||||||
$qb->expr()->eq('id', $qb->createNamedParameter($id))
|
$qb->expr()->eq('id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT))
|
||||||
);
|
);
|
||||||
$qb->execute();
|
$qb->execute();
|
||||||
|
|
||||||
return $entity;
|
return $entity;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the type parameter for the QueryBuilder for a specific property
|
||||||
|
* of the $entity
|
||||||
|
*
|
||||||
|
* @param Entity $entity The entity to get the types from
|
||||||
|
* @param string $property The property of $entity to get the type for
|
||||||
|
* @return int
|
||||||
|
* @since 16.0.0
|
||||||
|
*/
|
||||||
|
protected function getParameterTypeForProperty(Entity $entity, string $property): int {
|
||||||
|
$types = $entity->getFieldTypes();
|
||||||
|
|
||||||
|
if(!isset($types[ $property ])) {
|
||||||
|
return IQueryBuilder::PARAM_STR;
|
||||||
|
}
|
||||||
|
|
||||||
|
switch($types[ $property ]) {
|
||||||
|
case 'int':
|
||||||
|
case 'integer':
|
||||||
|
return IQueryBuilder::PARAM_INT;
|
||||||
|
case 'string':
|
||||||
|
return IQueryBuilder::PARAM_STR;
|
||||||
|
case 'bool':
|
||||||
|
case 'boolean':
|
||||||
|
return IQueryBuilder::PARAM_BOOL;
|
||||||
|
}
|
||||||
|
|
||||||
|
return IQueryBuilder::PARAM_STR;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns an db result and throws exceptions when there are more or less
|
* Returns an db result and throws exceptions when there are more or less
|
||||||
* results
|
* results
|
||||||
|
|
|
||||||
241
tests/lib/AppFramework/Db/QBMapperTest.php
Normal file
241
tests/lib/AppFramework/Db/QBMapperTest.php
Normal file
|
|
@ -0,0 +1,241 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* @copyright 2019, Marius David Wieschollek <git.public@mdns.eu>
|
||||||
|
*
|
||||||
|
* @author Marius David Wieschollek <git.public@mdns.eu>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Test\AppFramework\Db;
|
||||||
|
|
||||||
|
use OCP\AppFramework\Db\Entity;
|
||||||
|
use OCP\AppFramework\Db\QBMapper;
|
||||||
|
use OCP\DB\QueryBuilder\IExpressionBuilder;
|
||||||
|
use OCP\DB\QueryBuilder\IQueryBuilder;
|
||||||
|
use OCP\IDBConnection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @method bool getBoolProp()
|
||||||
|
* @method void setBoolProp(bool $boolProp)
|
||||||
|
* @method integer getIntProp()
|
||||||
|
* @method void setIntProp(integer $intProp)
|
||||||
|
* @method string getStringProp()
|
||||||
|
* @method void setStringProp(string $stringProp)
|
||||||
|
* @method bool getBooleanProp()
|
||||||
|
* @method void setBooleanProp(bool $booleanProp)
|
||||||
|
* @method integer getIntegerProp()
|
||||||
|
* @method void setIntegerProp(integer $integerProp)
|
||||||
|
*/
|
||||||
|
class QBTestEntity extends Entity {
|
||||||
|
|
||||||
|
protected $intProp;
|
||||||
|
protected $boolProp;
|
||||||
|
protected $stringProp;
|
||||||
|
protected $integerProp;
|
||||||
|
protected $booleanProp;
|
||||||
|
|
||||||
|
public function __construct() {
|
||||||
|
$this->addType('intProp', 'int');
|
||||||
|
$this->addType('boolProp', 'bool');
|
||||||
|
$this->addType('stringProp', 'string');
|
||||||
|
$this->addType('integerProp', 'integer');
|
||||||
|
$this->addType('booleanProp', 'boolean');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class QBTestMapper
|
||||||
|
*
|
||||||
|
* @package Test\AppFramework\Db
|
||||||
|
*/
|
||||||
|
class QBTestMapper extends QBMapper {
|
||||||
|
public function __construct(IDBConnection $db) {
|
||||||
|
parent::__construct($db, 'table');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getParameterTypeForPropertyForTest(Entity $entity, string $property): int {
|
||||||
|
return parent::getParameterTypeForProperty($entity, $property);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class QBMapperTest
|
||||||
|
*
|
||||||
|
* @package Test\AppFramework\Db
|
||||||
|
*/
|
||||||
|
class QBMapperTest extends \Test\TestCase {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var \PHPUnit\Framework\MockObject\MockObject|IDBConnection
|
||||||
|
*/
|
||||||
|
protected $db;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var \PHPUnit\Framework\MockObject\MockObject|IQueryBuilder
|
||||||
|
*/
|
||||||
|
protected $qb;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var \PHPUnit\Framework\MockObject\MockObject|IExpressionBuilder
|
||||||
|
*/
|
||||||
|
protected $expr;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var \Test\AppFramework\Db\QBTestMapper
|
||||||
|
*/
|
||||||
|
protected $mapper;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws \ReflectionException
|
||||||
|
*/
|
||||||
|
protected function setUp() {
|
||||||
|
|
||||||
|
$this->db = $this->getMockBuilder(IDBConnection::class)
|
||||||
|
->disableOriginalConstructor()
|
||||||
|
->getMock();
|
||||||
|
|
||||||
|
$this->qb = $this->getMockBuilder(IQueryBuilder:: class)
|
||||||
|
->disableOriginalConstructor()
|
||||||
|
->getMock();
|
||||||
|
|
||||||
|
$this->expr = $this->getMockBuilder(IExpressionBuilder:: class)
|
||||||
|
->disableOriginalConstructor()
|
||||||
|
->getMock();
|
||||||
|
|
||||||
|
|
||||||
|
$this->qb->method('expr')->willReturn($this->expr);
|
||||||
|
$this->db->method('getQueryBuilder')->willReturn($this->qb);
|
||||||
|
|
||||||
|
|
||||||
|
$this->mapper = new QBTestMapper($this->db);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
public function testInsertEntityParameterTypeMapping() {
|
||||||
|
$entity = new QBTestEntity();
|
||||||
|
$entity->setIntProp(123);
|
||||||
|
$entity->setBoolProp(true);
|
||||||
|
$entity->setStringProp('string');
|
||||||
|
$entity->setIntegerProp(456);
|
||||||
|
$entity->setBooleanProp(false);
|
||||||
|
|
||||||
|
$intParam = $this->qb->createNamedParameter('int_prop', IQueryBuilder::PARAM_INT);
|
||||||
|
$boolParam = $this->qb->createNamedParameter('bool_prop', IQueryBuilder::PARAM_BOOL);
|
||||||
|
$stringParam = $this->qb->createNamedParameter('string_prop', IQueryBuilder::PARAM_STR);
|
||||||
|
$integerParam = $this->qb->createNamedParameter('integer_prop', IQueryBuilder::PARAM_INT);
|
||||||
|
$booleanParam = $this->qb->createNamedParameter('boolean_prop', IQueryBuilder::PARAM_BOOL);
|
||||||
|
|
||||||
|
$this->qb->expects($this->exactly(5))
|
||||||
|
->method('createNamedParameter')
|
||||||
|
->withConsecutive(
|
||||||
|
[$this->equalTo(123), $this->equalTo(IQueryBuilder::PARAM_INT)],
|
||||||
|
[$this->equalTo(true), $this->equalTo(IQueryBuilder::PARAM_BOOL)],
|
||||||
|
[$this->equalTo('string'), $this->equalTo(IQueryBuilder::PARAM_STR)],
|
||||||
|
[$this->equalTo(456), $this->equalTo(IQueryBuilder::PARAM_INT)],
|
||||||
|
[$this->equalTo(false), $this->equalTo(IQueryBuilder::PARAM_BOOL)]
|
||||||
|
);
|
||||||
|
$this->qb->expects($this->exactly(5))
|
||||||
|
->method('setValue')
|
||||||
|
->withConsecutive(
|
||||||
|
[$this->equalTo('int_prop'), $this->equalTo($intParam)],
|
||||||
|
[$this->equalTo('bool_prop'), $this->equalTo($boolParam)],
|
||||||
|
[$this->equalTo('string_prop'), $this->equalTo($stringParam)],
|
||||||
|
[$this->equalTo('integer_prop'), $this->equalTo($integerParam)],
|
||||||
|
[$this->equalTo('boolean_prop'), $this->equalTo($booleanParam)]
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->mapper->insert($entity);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
public function testUpdateEntityParameterTypeMapping() {
|
||||||
|
$entity = new QBTestEntity();
|
||||||
|
$entity->setId(789);
|
||||||
|
$entity->setIntProp(123);
|
||||||
|
$entity->setBoolProp('true');
|
||||||
|
$entity->setStringProp('string');
|
||||||
|
$entity->setIntegerProp(456);
|
||||||
|
$entity->setBooleanProp(false);
|
||||||
|
|
||||||
|
$idParam = $this->qb->createNamedParameter('id', IQueryBuilder::PARAM_INT);
|
||||||
|
$intParam = $this->qb->createNamedParameter('int_prop', IQueryBuilder::PARAM_INT);
|
||||||
|
$boolParam = $this->qb->createNamedParameter('bool_prop', IQueryBuilder::PARAM_BOOL);
|
||||||
|
$stringParam = $this->qb->createNamedParameter('string_prop', IQueryBuilder::PARAM_STR);
|
||||||
|
$integerParam = $this->qb->createNamedParameter('integer_prop', IQueryBuilder::PARAM_INT);
|
||||||
|
$booleanParam = $this->qb->createNamedParameter('boolean_prop', IQueryBuilder::PARAM_BOOL);
|
||||||
|
|
||||||
|
$this->qb->expects($this->exactly(6))
|
||||||
|
->method('createNamedParameter')
|
||||||
|
->withConsecutive(
|
||||||
|
[$this->equalTo(123), $this->equalTo(IQueryBuilder::PARAM_INT)],
|
||||||
|
[$this->equalTo(true), $this->equalTo(IQueryBuilder::PARAM_BOOL)],
|
||||||
|
[$this->equalTo('string'), $this->equalTo(IQueryBuilder::PARAM_STR)],
|
||||||
|
[$this->equalTo(456), $this->equalTo(IQueryBuilder::PARAM_INT)],
|
||||||
|
[$this->equalTo(false), $this->equalTo(IQueryBuilder::PARAM_BOOL)],
|
||||||
|
[$this->equalTo(789), $this->equalTo(IQueryBuilder::PARAM_INT)]
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->qb->expects($this->exactly(5))
|
||||||
|
->method('set')
|
||||||
|
->withConsecutive(
|
||||||
|
[$this->equalTo('int_prop'), $this->equalTo($intParam)],
|
||||||
|
[$this->equalTo('bool_prop'), $this->equalTo($boolParam)],
|
||||||
|
[$this->equalTo('string_prop'), $this->equalTo($stringParam)],
|
||||||
|
[$this->equalTo('integer_prop'), $this->equalTo($integerParam)],
|
||||||
|
[$this->equalTo('boolean_prop'), $this->equalTo($booleanParam)]
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->expr->expects($this->once())
|
||||||
|
->method('eq')
|
||||||
|
->with($this->equalTo('id'), $this->equalTo($idParam));
|
||||||
|
|
||||||
|
|
||||||
|
$this->mapper->update($entity);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
public function testGetParameterTypeForProperty() {
|
||||||
|
$entity = new QBTestEntity();
|
||||||
|
|
||||||
|
$intType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'intProp');
|
||||||
|
$this->assertEquals(IQueryBuilder::PARAM_INT, $intType, 'Int type property mapping incorrect');
|
||||||
|
|
||||||
|
$integerType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'integerProp');
|
||||||
|
$this->assertEquals(IQueryBuilder::PARAM_INT, $integerType, 'Integer type property mapping incorrect');
|
||||||
|
|
||||||
|
$boolType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'boolProp');
|
||||||
|
$this->assertEquals(IQueryBuilder::PARAM_BOOL, $boolType, 'Bool type property mapping incorrect');
|
||||||
|
|
||||||
|
$booleanType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'booleanProp');
|
||||||
|
$this->assertEquals(IQueryBuilder::PARAM_BOOL, $booleanType, 'Boolean type property mapping incorrect');
|
||||||
|
|
||||||
|
$stringType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'stringProp');
|
||||||
|
$this->assertEquals(IQueryBuilder::PARAM_STR, $stringType, 'String type property mapping incorrect');
|
||||||
|
|
||||||
|
$unknownType = $this->mapper->getParameterTypeForPropertyForTest($entity, 'someProp');
|
||||||
|
$this->assertEquals(IQueryBuilder::PARAM_STR, $unknownType, 'Unknown type property mapping incorrect');
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue