RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2024-12-13 22:56:04 +03:00
Code Issues Projects Releases Wiki Activity

Extended TreeWalker interface with getQueryComponenets() and setQueryComponent() which are used by the Parser class

Browse Source
This commit is contained in:
Lukasz Cybula 2012-10-11 15:25:39 +02:00
parent f25b098029
commit 2c99ecf586
6 changed files with 196 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lib/Doctrine/ORM/Query/Parser.php
View File

@ -358,6 +358,7 @@ class Parser
default:
$treeWalkerChain->walkSelectStatement($AST);
}
$this->queryComponents = $treeWalkerChain->getQueryComponents();
}
$outputWalkerClass = $this->customOutputWalker ?: __NAMESPACE__ . '\SqlWalker';

12
lib/Doctrine/ORM/Query/SqlWalker.php
View File

@ -223,13 +223,23 @@ class SqlWalker implements TreeWalker
return $this->queryComponents[$dqlAlias];
}
/**
* Return internal queryComponents array
*
* @return array
*/
public function getQueryComponents()
{
return $this->queryComponents;
}
/**
* Set or override a query component for a given dql alias.
*
* @param string $dqlAlias The DQL alias.
* @param array $queryComponent
*/
protected function setQueryComponent($dqlAlias, array $queryComponent)
public function setQueryComponent($dqlAlias, array $queryComponent)
{
$requiredKeys = array('metadata', 'parent', 'relation', 'map', 'nestingLevel', 'token');

15
lib/Doctrine/ORM/Query/TreeWalker.php
View File

@ -36,6 +36,21 @@ interface TreeWalker
*/
public function __construct($query, $parserResult, array $queryComponents);
/**
* Return internal queryComponents array
*
* @return array
*/
public function getQueryComponents();
/**
* Set or override a query component for a given dql alias.
*
* @param string $dqlAlias The DQL alias.
* @param array $queryComponent
*/
public function setQueryComponent($dqlAlias, array $queryComponent);
/**
* Walks down a SelectStatement AST node, thereby generating the appropriate SQL.
*

27
lib/Doctrine/ORM/Query/TreeWalkerAdapter.php
View File

@ -42,6 +42,33 @@ abstract class TreeWalkerAdapter implements TreeWalker
$this->_queryComponents = $queryComponents;
}
/**
* Return internal queryComponents array
*
* @return array:
*/
public function getQueryComponents()
{
return $this->_queryComponents;
}
/**
* Set or override a query component for a given dql alias.
*
* @param string $dqlAlias The DQL alias.
* @param array $queryComponent
*/
public function setQueryComponent($dqlAlias, array $queryComponent)
{
$requiredKeys = array('metadata', 'parent', 'relation', 'map', 'nestingLevel', 'token');
if (array_diff($requiredKeys, array_keys($queryComponent))) {
throw QueryException::invalidQueryComponent($dqlAlias);
}
$this->_queryComponents[$dqlAlias] = $queryComponent;
}
/**
* @return array
*/

28
lib/Doctrine/ORM/Query/TreeWalkerChain.php
View File

@ -38,6 +38,33 @@ class TreeWalkerChain implements TreeWalker
/** The query components of the original query (the "symbol table") that was produced by the Parser. */
private $_queryComponents;
/**
* Return internal queryComponents array
*
* @return array
*/
public function getQueryComponents()
{
return $this->_queryComponents;
}
/**
* Set or override a query component for a given dql alias.
*
* @param string $dqlAlias The DQL alias.
* @param array $queryComponent
*/
public function setQueryComponent($dqlAlias, array $queryComponent)
{
$requiredKeys = array('metadata', 'parent', 'relation', 'map', 'nestingLevel', 'token');
if (array_diff($requiredKeys, array_keys($queryComponent))) {
throw QueryException::invalidQueryComponent($dqlAlias);
}
$this->_queryComponents[$dqlAlias] = $queryComponent;
}
/**
* @inheritdoc
*/
@ -67,6 +94,7 @@ class TreeWalkerChain implements TreeWalker
{
foreach ($this->_walkers as $walker) {
$walker->walkSelectStatement($AST);
$this->_queryComponents = $walker->getQueryComponents();
}
}

112
tests/Doctrine/Tests/ORM/Functional/CustomTreeWalkersJoinTest.php Normal file
View File

@ -0,0 +1,112 @@
<?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 LGPL. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\Tests\ORM\Functional;
use Doctrine\ORM\Query;
require_once __DIR__ . '/../../TestInit.php';
/**
* Test case for custom AST walking and adding new joins.
*
* @author Lukasz Cybula <lukasz.cybula@fsi.pl>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link http://www.doctrine-project.org
*/
class CustomTreeWalkersJoinTest extends \Doctrine\Tests\OrmTestCase
{
private $_em;
protected function setUp()
{
$this->_em = $this->_getTestEntityManager();
}
public function assertSqlGeneration($dqlToBeTested, $sqlToBeConfirmed)
{
try {
$query = $this->_em->createQuery($dqlToBeTested);
$query->setHint(Query::HINT_CUSTOM_TREE_WALKERS, array('Doctrine\Tests\ORM\Functional\CustomTreeWalker2'))
->useQueryCache(false);
$this->assertEquals($sqlToBeConfirmed, $query->getSql());
$query->free();
} catch (\Exception $e) {
$this->fail($e->getMessage() . ' at "' . $e->getFile() . '" on line ' . $e->getLine());
}
}
public function testAddsJoin()
{
$this->assertSqlGeneration(
'select u from Doctrine\Tests\Models\CMS\CmsUser u',
"SELECT c0_.id AS id0, c0_.status AS status1, c0_.username AS username2, c0_.name AS name3, c1_.id AS id4, c1_.country AS country5, c1_.zip AS zip6, c1_.city AS city7, c0_.email_id AS email_id8, c1_.user_id AS user_id9 FROM cms_users c0_ LEFT JOIN cms_addresses c1_ ON c0_.id = c1_.user_id"
);
}
public function testDoesNotAddJoin()
{
$this->assertSqlGeneration(
'select a from Doctrine\Tests\Models\CMS\CmsAddress a',
"SELECT c0_.id AS id0, c0_.country AS country1, c0_.zip AS zip2, c0_.city AS city3, c0_.user_id AS user_id4 FROM cms_addresses c0_"
);
}
}
class CustomTreeWalker2 extends Query\TreeWalkerAdapter
{
public function walkSelectStatement(Query\AST\SelectStatement $selectStatement)
{
foreach ($selectStatement->fromClause->identificationVariableDeclarations as $identificationVariableDeclaration) {
if ($identificationVariableDeclaration->rangeVariableDeclaration->abstractSchemaName == 'Doctrine\Tests\Models\CMS\CmsUser') {
$identificationVariableDeclaration->joins[] = new Query\AST\Join(
Query\AST\Join::JOIN_TYPE_LEFT,
new Query\AST\JoinAssociationDeclaration(
new Query\AST\JoinAssociationPathExpression(
$identificationVariableDeclaration->rangeVariableDeclaration->aliasIdentificationVariable,
'address'
),
$identificationVariableDeclaration->rangeVariableDeclaration->aliasIdentificationVariable . 'a',
null
)
);
$selectStatement->selectClause->selectExpressions[] =
new Query\AST\SelectExpression(
$identificationVariableDeclaration->rangeVariableDeclaration->aliasIdentificationVariable . 'a',
null,
false
);
$meta1 = $this->_getQuery()->getEntityManager()->getClassMetadata('Doctrine\Tests\Models\CMS\CmsUser');
$meta = $this->_getQuery()->getEntityManager()->getClassMetadata('Doctrine\Tests\Models\CMS\CmsAddress');
$this->setQueryComponent($identificationVariableDeclaration->rangeVariableDeclaration->aliasIdentificationVariable . 'a',
array(
'metadata' => $meta,
'parent' => $identificationVariableDeclaration->rangeVariableDeclaration->aliasIdentificationVariable,
'relation' => $meta1->getAssociationMapping('address'),
'map' => null,
'nestingLevel' => 0,
'token' => null
)
);
}
}
}
}