From 866418e40f38e33f2c5dcf16ab9bccd3cdffa563 Mon Sep 17 00:00:00 2001 From: Mathew Davies Date: Fri, 9 Jun 2017 15:09:41 +0100 Subject: [PATCH] No longer treat aggregate functions as a special case. --- lib/Doctrine/ORM/Configuration.php | 12 ---- lib/Doctrine/ORM/ORMException.php | 10 ---- .../ORM/Query/AST/Functions/AvgFunction.php | 55 +++++++++++++++++++ .../ORM/Query/AST/Functions/CountFunction.php | 55 +++++++++++++++++++ .../ORM/Query/AST/Functions/MaxFunction.php | 55 +++++++++++++++++++ .../ORM/Query/AST/Functions/MinFunction.php | 55 +++++++++++++++++++ .../ORM/Query/AST/Functions/SumFunction.php | 55 +++++++++++++++++++ lib/Doctrine/ORM/Query/Parser.php | 45 +++------------ lib/Doctrine/ORM/Query/SqlWalker.php | 8 ++- .../Doctrine/Tests/ORM/ConfigurationTest.php | 6 -- .../ORM/Functional/CustomFunctionsTest.php | 18 +++--- 11 files changed, 295 insertions(+), 79 deletions(-) create mode 100644 lib/Doctrine/ORM/Query/AST/Functions/AvgFunction.php create mode 100644 lib/Doctrine/ORM/Query/AST/Functions/CountFunction.php create mode 100644 lib/Doctrine/ORM/Query/AST/Functions/MaxFunction.php create mode 100644 lib/Doctrine/ORM/Query/AST/Functions/MinFunction.php create mode 100644 lib/Doctrine/ORM/Query/AST/Functions/SumFunction.php diff --git a/lib/Doctrine/ORM/Configuration.php b/lib/Doctrine/ORM/Configuration.php index 104a4f4b2..4af482faf 100644 --- a/lib/Doctrine/ORM/Configuration.php +++ b/lib/Doctrine/ORM/Configuration.php @@ -425,10 +425,6 @@ class Configuration extends \Doctrine\DBAL\Configuration */ public function addCustomStringFunction($name, $className) { - if (Query\Parser::isInternalFunction($name)) { - throw ORMException::overwriteInternalDQLFunctionNotAllowed($name); - } - $this->_attributes['customStringFunctions'][strtolower($name)] = $className; } @@ -483,10 +479,6 @@ class Configuration extends \Doctrine\DBAL\Configuration */ public function addCustomNumericFunction($name, $className) { - if (Query\Parser::isInternalFunction($name)) { - throw ORMException::overwriteInternalDQLFunctionNotAllowed($name); - } - $this->_attributes['customNumericFunctions'][strtolower($name)] = $className; } @@ -541,10 +533,6 @@ class Configuration extends \Doctrine\DBAL\Configuration */ public function addCustomDatetimeFunction($name, $className) { - if (Query\Parser::isInternalFunction($name)) { - throw ORMException::overwriteInternalDQLFunctionNotAllowed($name); - } - $this->_attributes['customDatetimeFunctions'][strtolower($name)] = $className; } diff --git a/lib/Doctrine/ORM/ORMException.php b/lib/Doctrine/ORM/ORMException.php index 039ef2eaa..3ce9ce9dc 100644 --- a/lib/Doctrine/ORM/ORMException.php +++ b/lib/Doctrine/ORM/ORMException.php @@ -323,16 +323,6 @@ class ORMException extends Exception ); } - /** - * @param string $functionName - * - * @return ORMException - */ - public static function overwriteInternalDQLFunctionNotAllowed($functionName) - { - return new self("It is not allowed to overwrite internal function '$functionName' in the DQL parser through user-defined functions."); - } - /** * @return ORMException */ diff --git a/lib/Doctrine/ORM/Query/AST/Functions/AvgFunction.php b/lib/Doctrine/ORM/Query/AST/Functions/AvgFunction.php new file mode 100644 index 000000000..7d9703d0d --- /dev/null +++ b/lib/Doctrine/ORM/Query/AST/Functions/AvgFunction.php @@ -0,0 +1,55 @@ +. + */ + +namespace Doctrine\ORM\Query\AST\Functions; + +use Doctrine\ORM\Query\Parser; +use Doctrine\ORM\Query\SqlWalker; +use Doctrine\ORM\Query\AST\AggregateExpression; + +/** + * "AVG" "(" ["DISTINCT"] StringPrimary ")" + * + * @link www.doctrine-project.org + * @since 2.0 + * @author Mathew Davies + */ +class AvgFunction extends FunctionNode +{ + /** + * @var AggregateExpression + */ + public $aggregateExpression; + + /** + * @inheritDoc + */ + public function getSql(SqlWalker $sqlWalker) + { + return $this->aggregateExpression->dispatch($sqlWalker); + } + + /** + * @inheritDoc + */ + public function parse(Parser $parser) + { + $this->aggregateExpression = $parser->AggregateExpression(); + } +} diff --git a/lib/Doctrine/ORM/Query/AST/Functions/CountFunction.php b/lib/Doctrine/ORM/Query/AST/Functions/CountFunction.php new file mode 100644 index 000000000..e5b7220ed --- /dev/null +++ b/lib/Doctrine/ORM/Query/AST/Functions/CountFunction.php @@ -0,0 +1,55 @@ +. + */ + +namespace Doctrine\ORM\Query\AST\Functions; + +use Doctrine\ORM\Query\Parser; +use Doctrine\ORM\Query\SqlWalker; +use Doctrine\ORM\Query\AST\AggregateExpression; + +/** + * "COUNT" "(" ["DISTINCT"] StringPrimary ")" + * + * @link www.doctrine-project.org + * @since 2.0 + * @author Mathew Davies + */ +class CountFunction extends FunctionNode +{ + /** + * @var AggregateExpression + */ + public $aggregateExpression; + + /** + * @inheritDoc + */ + public function getSql(SqlWalker $sqlWalker) + { + return $this->aggregateExpression->dispatch($sqlWalker); + } + + /** + * @inheritDoc + */ + public function parse(Parser $parser) + { + $this->aggregateExpression = $parser->AggregateExpression(); + } +} diff --git a/lib/Doctrine/ORM/Query/AST/Functions/MaxFunction.php b/lib/Doctrine/ORM/Query/AST/Functions/MaxFunction.php new file mode 100644 index 000000000..c01cc2d86 --- /dev/null +++ b/lib/Doctrine/ORM/Query/AST/Functions/MaxFunction.php @@ -0,0 +1,55 @@ +. + */ + +namespace Doctrine\ORM\Query\AST\Functions; + +use Doctrine\ORM\Query\Parser; +use Doctrine\ORM\Query\SqlWalker; +use Doctrine\ORM\Query\AST\AggregateExpression; + +/** + * "MAX" "(" ["DISTINCT"] StringPrimary ")" + * + * @link www.doctrine-project.org + * @since 2.0 + * @author Mathew Davies + */ +class MaxFunction extends FunctionNode +{ + /** + * @var AggregateExpression + */ + public $aggregateExpression; + + /** + * @inheritDoc + */ + public function getSql(SqlWalker $sqlWalker) + { + return $this->aggregateExpression->dispatch($sqlWalker); + } + + /** + * @inheritDoc + */ + public function parse(Parser $parser) + { + $this->aggregateExpression = $parser->AggregateExpression(); + } +} diff --git a/lib/Doctrine/ORM/Query/AST/Functions/MinFunction.php b/lib/Doctrine/ORM/Query/AST/Functions/MinFunction.php new file mode 100644 index 000000000..1985be2d8 --- /dev/null +++ b/lib/Doctrine/ORM/Query/AST/Functions/MinFunction.php @@ -0,0 +1,55 @@ +. + */ + +namespace Doctrine\ORM\Query\AST\Functions; + +use Doctrine\ORM\Query\Parser; +use Doctrine\ORM\Query\SqlWalker; +use Doctrine\ORM\Query\AST\AggregateExpression; + +/** + * "MIN" "(" ["DISTINCT"] StringPrimary ")" + * + * @link www.doctrine-project.org + * @since 2.0 + * @author Mathew Davies + */ +class MinFunction extends FunctionNode +{ + /** + * @var AggregateExpression + */ + public $aggregateExpression; + + /** + * @inheritDoc + */ + public function getSql(SqlWalker $sqlWalker) + { + return $this->aggregateExpression->dispatch($sqlWalker); + } + + /** + * @inheritDoc + */ + public function parse(Parser $parser) + { + $this->aggregateExpression = $parser->AggregateExpression(); + } +} diff --git a/lib/Doctrine/ORM/Query/AST/Functions/SumFunction.php b/lib/Doctrine/ORM/Query/AST/Functions/SumFunction.php new file mode 100644 index 000000000..f8cd48db0 --- /dev/null +++ b/lib/Doctrine/ORM/Query/AST/Functions/SumFunction.php @@ -0,0 +1,55 @@ +. + */ + +namespace Doctrine\ORM\Query\AST\Functions; + +use Doctrine\ORM\Query\Parser; +use Doctrine\ORM\Query\SqlWalker; +use Doctrine\ORM\Query\AST\AggregateExpression; + +/** + * "SUM" "(" ["DISTINCT"] StringPrimary ")" + * + * @link www.doctrine-project.org + * @since 2.0 + * @author Mathew Davies + */ +class SumFunction extends FunctionNode +{ + /** + * @var AggregateExpression + */ + public $aggregateExpression; + + /** + * @inheritDoc + */ + public function getSql(SqlWalker $sqlWalker) + { + return $this->aggregateExpression->dispatch($sqlWalker); + } + + /** + * @inheritDoc + */ + public function parse(Parser $parser) + { + $this->aggregateExpression = $parser->AggregateExpression(); + } +} diff --git a/lib/Doctrine/ORM/Query/Parser.php b/lib/Doctrine/ORM/Query/Parser.php index 3a917f059..a06cd83a6 100644 --- a/lib/Doctrine/ORM/Query/Parser.php +++ b/lib/Doctrine/ORM/Query/Parser.php @@ -65,6 +65,13 @@ class Parser 'date_diff' => Functions\DateDiffFunction::class, 'bit_and' => Functions\BitAndFunction::class, 'bit_or' => Functions\BitOrFunction::class, + + // Aggregate functions + 'min' => Functions\MinFunction::class, + 'max' => Functions\MaxFunction::class, + 'avg' => Functions\AvgFunction::class, + 'sum' => Functions\SumFunction::class, + 'count' => Functions\CountFunction::class, ]; /** @@ -171,23 +178,6 @@ class Parser */ private $identVariableExpressions = []; - /** - * Checks if a function is internally defined. Used to prevent overwriting - * of built-in functions through user-defined functions. - * - * @param string $functionName - * - * @return bool - */ - static public function isInternalFunction($functionName) - { - $functionName = strtolower($functionName); - - return isset(self::$_STRING_FUNCTIONS[$functionName]) - || isset(self::$_DATETIME_FUNCTIONS[$functionName]) - || isset(self::$_NUMERIC_FUNCTIONS[$functionName]); - } - /** * Creates a new query parser object. * @@ -1978,9 +1968,6 @@ class Parser // SUM(u.id) + COUNT(u.id) return $this->SimpleArithmeticExpression(); - case ($this->isAggregateFunction($this->lexer->lookahead['type'])): - return $this->AggregateExpression(); - default: // IDENTITY(u) return $this->FunctionDeclaration(); @@ -2209,11 +2196,6 @@ class Parser $expression = $this->ScalarExpression(); break; - case ($this->isAggregateFunction($lookaheadType)): - // COUNT(u.id) - $expression = $this->AggregateExpression(); - break; - default: // IDENTITY(u) $expression = $this->FunctionDeclaration(); @@ -2858,10 +2840,6 @@ class Parser $peek = $this->lexer->glimpse(); if ($peek['value'] == '(') { - if ($this->isAggregateFunction($this->lexer->lookahead['type'])) { - return $this->AggregateExpression(); - } - return $this->FunctionDeclaration(); } @@ -2932,11 +2910,6 @@ class Parser case Lexer::T_COALESCE: case Lexer::T_NULLIF: return $this->CaseExpression(); - - default: - if ($this->isAggregateFunction($lookaheadType)) { - return $this->AggregateExpression(); - } } $this->syntaxError( @@ -3236,10 +3209,6 @@ class Parser $expr = $this->CoalesceExpression(); break; - case $this->isAggregateFunction($this->lexer->lookahead['type']): - $expr = $this->AggregateExpression(); - break; - case $this->isFunction(): $expr = $this->FunctionDeclaration(); break; diff --git a/lib/Doctrine/ORM/Query/SqlWalker.php b/lib/Doctrine/ORM/Query/SqlWalker.php index ee57cf90b..206a4676e 100644 --- a/lib/Doctrine/ORM/Query/SqlWalker.php +++ b/lib/Doctrine/ORM/Query/SqlWalker.php @@ -1579,10 +1579,14 @@ class SqlWalker implements TreeWalker $sql .= $this->walkPathExpression($expr); break; - case ($expr instanceof AST\AggregateExpression): + case ($expr instanceof AST\Functions\AvgFunction): + case ($expr instanceof AST\Functions\CountFunction): + case ($expr instanceof AST\Functions\MaxFunction): + case ($expr instanceof AST\Functions\MinFunction): + case ($expr instanceof AST\Functions\SumFunction): $alias = $simpleSelectExpression->fieldIdentificationVariable ?: $this->scalarResultCounter++; - $sql .= $this->walkAggregateExpression($expr) . ' AS dctrn__' . $alias; + $sql .= $expr->dispatch($this) . ' AS dctrn__' . $alias; break; case ($expr instanceof AST\Subselect): diff --git a/tests/Doctrine/Tests/ORM/ConfigurationTest.php b/tests/Doctrine/Tests/ORM/ConfigurationTest.php index ab657c5fd..92a2eeaea 100644 --- a/tests/Doctrine/Tests/ORM/ConfigurationTest.php +++ b/tests/Doctrine/Tests/ORM/ConfigurationTest.php @@ -265,8 +265,6 @@ class ConfigurationTest extends TestCase $this->assertSame(null, $this->configuration->getCustomStringFunction('NonExistingFunction')); $this->configuration->setCustomStringFunctions(['OtherFunctionName' => __CLASS__]); $this->assertSame(__CLASS__, $this->configuration->getCustomStringFunction('OtherFunctionName')); - $this->expectException(ORMException::class); - $this->configuration->addCustomStringFunction('concat', __CLASS__); } public function testAddGetCustomNumericFunction() @@ -276,8 +274,6 @@ class ConfigurationTest extends TestCase $this->assertSame(null, $this->configuration->getCustomNumericFunction('NonExistingFunction')); $this->configuration->setCustomNumericFunctions(['OtherFunctionName' => __CLASS__]); $this->assertSame(__CLASS__, $this->configuration->getCustomNumericFunction('OtherFunctionName')); - $this->expectException(ORMException::class); - $this->configuration->addCustomNumericFunction('abs', __CLASS__); } public function testAddGetCustomDatetimeFunction() @@ -287,8 +283,6 @@ class ConfigurationTest extends TestCase $this->assertSame(null, $this->configuration->getCustomDatetimeFunction('NonExistingFunction')); $this->configuration->setCustomDatetimeFunctions(['OtherFunctionName' => __CLASS__]); $this->assertSame(__CLASS__, $this->configuration->getCustomDatetimeFunction('OtherFunctionName')); - $this->expectException(ORMException::class); - $this->configuration->addCustomDatetimeFunction('date_add', __CLASS__); } public function testAddGetCustomHydrationMode() diff --git a/tests/Doctrine/Tests/ORM/Functional/CustomFunctionsTest.php b/tests/Doctrine/Tests/ORM/Functional/CustomFunctionsTest.php index d7231219b..aa56e1f93 100644 --- a/tests/Doctrine/Tests/ORM/Functional/CustomFunctionsTest.php +++ b/tests/Doctrine/Tests/ORM/Functional/CustomFunctionsTest.php @@ -58,12 +58,11 @@ class CustomFunctionsTest extends OrmFunctionalTestCase $this->_em->getConfiguration()->addCustomStringFunction('COUNT', 'Doctrine\Tests\ORM\Functional\CustomCount'); - $query = $this->_em->createQuery('SELECT COUNT(u.id) FROM Doctrine\Tests\Models\CMS\CmsUser u'); + $query = $this->_em->createQuery('SELECT COUNT(DISTINCT u.id) FROM Doctrine\Tests\Models\CMS\CmsUser u'); - $users = $query->getResult(); + $usersCount = $query->getSingleScalarResult(); - $this->assertEquals(1, count($users)); - $this->assertSame($user, $users[0]); + $this->assertEquals(1, $usersCount); } } @@ -91,20 +90,17 @@ class NoOp extends FunctionNode class CustomCount extends FunctionNode { /** - * @var PathExpression + * @var Query\AST\AggregateExpression */ - private $field; + private $aggregateExpression; public function parse(Parser $parser) { - $parser->match(Lexer::T_IDENTIFIER); - $parser->match(Lexer::T_OPEN_PARENTHESIS); - $this->field = $parser->StringExpression(); - $parser->match(Lexer::T_CLOSE_PARENTHESIS); + $this->aggregateExpression = $parser->AggregateExpression(); } public function getSql(SqlWalker $sqlWalker) { - return $this->field->dispatch($sqlWalker); + return $this->aggregateExpression->dispatch($sqlWalker); } }