From d4357801a2fbbcdf5ef3b6d4fd435430b7a68714 Mon Sep 17 00:00:00 2001 From: Benjamin Morel Date: Thu, 13 Dec 2012 11:57:46 +0000 Subject: [PATCH] Fixed documentation for Doctrine\ORM\Query\Exec --- .../ORM/Query/Exec/AbstractSqlExecutor.php | 12 +++++++--- .../Query/Exec/MultiTableDeleteExecutor.php | 16 +++++++++++-- .../Query/Exec/MultiTableUpdateExecutor.php | 24 +++++++++++++++++-- .../ORM/Query/Exec/SingleSelectExecutor.php | 4 ++++ .../Exec/SingleTableDeleteUpdateExecutor.php | 4 ++++ lib/Doctrine/ORM/Query/SqlWalker.php | 2 +- 6 files changed, 54 insertions(+), 8 deletions(-) diff --git a/lib/Doctrine/ORM/Query/Exec/AbstractSqlExecutor.php b/lib/Doctrine/ORM/Query/Exec/AbstractSqlExecutor.php index d20905a09..3d6ed4353 100644 --- a/lib/Doctrine/ORM/Query/Exec/AbstractSqlExecutor.php +++ b/lib/Doctrine/ORM/Query/Exec/AbstractSqlExecutor.php @@ -53,6 +53,11 @@ abstract class AbstractSqlExecutor return $this->_sqlStatements; } + /** + * @param \Doctrine\DBAL\Cache\QueryCacheProfile $qcp + * + * @return void + */ public function setQueryCacheProfile(QueryCacheProfile $qcp) { $this->queryCacheProfile = $qcp; @@ -61,9 +66,10 @@ abstract class AbstractSqlExecutor /** * Executes all sql statements. * - * @param \Doctrine\DBAL\Connection $conn The database connection that is used to execute the queries. - * @param array $params The parameters. - * @param array $types The parameter types. + * @param Connection $conn The database connection that is used to execute the queries. + * @param array $params The parameters. + * @param array $types The parameter types. + * * @return \Doctrine\DBAL\Driver\Statement */ abstract public function execute(Connection $conn, array $params, array $types); diff --git a/lib/Doctrine/ORM/Query/Exec/MultiTableDeleteExecutor.php b/lib/Doctrine/ORM/Query/Exec/MultiTableDeleteExecutor.php index 1ead1eafa..13af55905 100644 --- a/lib/Doctrine/ORM/Query/Exec/MultiTableDeleteExecutor.php +++ b/lib/Doctrine/ORM/Query/Exec/MultiTableDeleteExecutor.php @@ -33,15 +33,27 @@ use Doctrine\ORM\Query\AST; */ class MultiTableDeleteExecutor extends AbstractSqlExecutor { + /** + * @var string + */ private $_createTempTableSql; + + /** + * @var string + */ private $_dropTempTableSql; + + /** + * @var string + */ private $_insertSql; /** * Initializes a new MultiTableDeleteExecutor. * - * @param Node $AST The root AST node of the DQL query. - * @param SqlWalker $sqlWalker The walker used for SQL generation from the AST. + * @param \Doctrine\ORM\Query\AST\Node $AST The root AST node of the DQL query. + * @param \Doctrine\ORM\Query\SqlWalker $sqlWalker The walker used for SQL generation from the AST. + * * @internal Any SQL construction and preparation takes place in the constructor for * best performance. With a query cache the executor will be cached. */ diff --git a/lib/Doctrine/ORM/Query/Exec/MultiTableUpdateExecutor.php b/lib/Doctrine/ORM/Query/Exec/MultiTableUpdateExecutor.php index 7dc3fed82..cc15cea92 100644 --- a/lib/Doctrine/ORM/Query/Exec/MultiTableUpdateExecutor.php +++ b/lib/Doctrine/ORM/Query/Exec/MultiTableUpdateExecutor.php @@ -34,17 +34,37 @@ use Doctrine\ORM\Query\AST; */ class MultiTableUpdateExecutor extends AbstractSqlExecutor { + /** + * @var string + */ private $_createTempTableSql; + + /** + * @var string + */ private $_dropTempTableSql; + + /** + * @var string + */ private $_insertSql; + + /** + * @var array + */ private $_sqlParameters = array(); + + /** + * @var int + */ private $_numParametersInUpdateClause = 0; /** * Initializes a new MultiTableUpdateExecutor. * - * @param Node $AST The root AST node of the DQL query. - * @param SqlWalker $sqlWalker The walker used for SQL generation from the AST. + * @param \Doctrine\ORM\Query\AST\Node $AST The root AST node of the DQL query. + * @param \Doctrine\ORM\Query\SqlWalker $sqlWalker The walker used for SQL generation from the AST. + * * @internal Any SQL construction and preparation takes place in the constructor for * best performance. With a query cache the executor will be cached. */ diff --git a/lib/Doctrine/ORM/Query/Exec/SingleSelectExecutor.php b/lib/Doctrine/ORM/Query/Exec/SingleSelectExecutor.php index c5ce9b5fa..f652fbe8c 100644 --- a/lib/Doctrine/ORM/Query/Exec/SingleSelectExecutor.php +++ b/lib/Doctrine/ORM/Query/Exec/SingleSelectExecutor.php @@ -33,6 +33,10 @@ use Doctrine\ORM\Query\SqlWalker; */ class SingleSelectExecutor extends AbstractSqlExecutor { + /** + * @param \Doctrine\ORM\Query\AST\SelectStatement $AST + * @param \Doctrine\ORM\Query\SqlWalker $sqlWalker + */ public function __construct(SelectStatement $AST, SqlWalker $sqlWalker) { $this->_sqlStatements = $sqlWalker->walkSelectStatement($AST); diff --git a/lib/Doctrine/ORM/Query/Exec/SingleTableDeleteUpdateExecutor.php b/lib/Doctrine/ORM/Query/Exec/SingleTableDeleteUpdateExecutor.php index ea4e91897..695176d5b 100644 --- a/lib/Doctrine/ORM/Query/Exec/SingleTableDeleteUpdateExecutor.php +++ b/lib/Doctrine/ORM/Query/Exec/SingleTableDeleteUpdateExecutor.php @@ -34,6 +34,10 @@ use Doctrine\ORM\Query\AST; */ class SingleTableDeleteUpdateExecutor extends AbstractSqlExecutor { + /** + * @param \Doctrine\ORM\Query\AST\Node $AST + * @param \Doctrine\ORM\Query\SqlWalker $sqlWalker + */ public function __construct(AST\Node $AST, $sqlWalker) { if ($AST instanceof AST\UpdateStatement) { diff --git a/lib/Doctrine/ORM/Query/SqlWalker.php b/lib/Doctrine/ORM/Query/SqlWalker.php index c21e0e91d..71c09c0a2 100644 --- a/lib/Doctrine/ORM/Query/SqlWalker.php +++ b/lib/Doctrine/ORM/Query/SqlWalker.php @@ -205,7 +205,7 @@ class SqlWalker implements TreeWalker /** * Gets the EntityManager used by the walker. * - * @return EntityManager + * @return \Doctrine\ORM\EntityManager */ public function getEntityManager() {