From 34d8843fd6d44fddfa802ab6df7e5bb3ec30ca0a Mon Sep 17 00:00:00 2001 From: Konstantin Kuklin Date: Fri, 21 Sep 2012 03:20:06 +0400 Subject: [PATCH] improve phpdoc --- lib/Doctrine/ORM/AbstractQuery.php | 4 ++-- lib/Doctrine/ORM/Configuration.php | 4 ++-- lib/Doctrine/ORM/EntityManager.php | 2 +- lib/Doctrine/ORM/EntityRepository.php | 2 +- lib/Doctrine/ORM/Event/OnFlushEventArgs.php | 2 +- lib/Doctrine/ORM/Event/PreFlushEventArgs.php | 4 ++-- lib/Doctrine/ORM/Id/AbstractIdGenerator.php | 2 +- lib/Doctrine/ORM/Query/FilterCollection.php | 10 +++++----- lib/Doctrine/ORM/Query/Parser.php | 4 ++-- .../ORM/Tools/Console/Helper/EntityManagerHelper.php | 2 +- lib/Doctrine/ORM/Tools/DebugUnitOfWorkListener.php | 1 + .../ORM/Tools/Pagination/CountOutputWalker.php | 8 ++++---- .../ORM/Tools/Pagination/LimitSubqueryOutputWalker.php | 8 ++++---- 13 files changed, 27 insertions(+), 26 deletions(-) diff --git a/lib/Doctrine/ORM/AbstractQuery.php b/lib/Doctrine/ORM/AbstractQuery.php index d5759e61b..a12336035 100644 --- a/lib/Doctrine/ORM/AbstractQuery.php +++ b/lib/Doctrine/ORM/AbstractQuery.php @@ -69,7 +69,7 @@ abstract class AbstractQuery protected $parameters; /** - * @var ResultSetMapping The user-specified ResultSetMapping to use. + * @var \Doctrine\ORM\Query\ResultSetMapping The user-specified ResultSetMapping to use. */ protected $_resultSetMapping; @@ -293,7 +293,7 @@ abstract class AbstractQuery /** * Sets the ResultSetMapping that should be used for hydration. * - * @param ResultSetMapping $rsm + * @param \Doctrine\ORM\Query\ResultSetMapping $rsm * @return \Doctrine\ORM\AbstractQuery */ public function setResultSetMapping(Query\ResultSetMapping $rsm) diff --git a/lib/Doctrine/ORM/Configuration.php b/lib/Doctrine/ORM/Configuration.php index a83548801..b50d4b934 100644 --- a/lib/Doctrine/ORM/Configuration.php +++ b/lib/Doctrine/ORM/Configuration.php @@ -659,7 +659,7 @@ class Configuration extends \Doctrine\DBAL\Configuration * Set quote strategy. * * @since 2.3 - * @param Doctrine\ORM\Mapping\QuoteStrategy $quoteStrategy + * @param \Doctrine\ORM\Mapping\QuoteStrategy $quoteStrategy */ public function setQuoteStrategy(QuoteStrategy $quoteStrategy) { @@ -670,7 +670,7 @@ class Configuration extends \Doctrine\DBAL\Configuration * Get quote strategy. * * @since 2.3 - * @return Doctrine\ORM\Mapping\QuoteStrategy + * @return \Doctrine\ORM\Mapping\QuoteStrategy */ public function getQuoteStrategy() { diff --git a/lib/Doctrine/ORM/EntityManager.php b/lib/Doctrine/ORM/EntityManager.php index 50e73824c..0c456af6b 100644 --- a/lib/Doctrine/ORM/EntityManager.php +++ b/lib/Doctrine/ORM/EntityManager.php @@ -114,7 +114,7 @@ class EntityManager implements ObjectManager /** * Collection of query filters. * - * @var Doctrine\ORM\Query\FilterCollection + * @var \Doctrine\ORM\Query\FilterCollection */ private $filterCollection; diff --git a/lib/Doctrine/ORM/EntityRepository.php b/lib/Doctrine/ORM/EntityRepository.php index d2f4088bf..c785aa9b5 100644 --- a/lib/Doctrine/ORM/EntityRepository.php +++ b/lib/Doctrine/ORM/EntityRepository.php @@ -60,7 +60,7 @@ class EntityRepository implements ObjectRepository, Selectable * Initializes a new EntityRepository. * * @param EntityManager $em The EntityManager to use. - * @param ClassMetadata $classMetadata The class descriptor. + * @param Mapping\ClassMetadata $classMetadata The class descriptor. */ public function __construct($em, Mapping\ClassMetadata $class) { diff --git a/lib/Doctrine/ORM/Event/OnFlushEventArgs.php b/lib/Doctrine/ORM/Event/OnFlushEventArgs.php index 1e18d2a46..744ae18fe 100644 --- a/lib/Doctrine/ORM/Event/OnFlushEventArgs.php +++ b/lib/Doctrine/ORM/Event/OnFlushEventArgs.php @@ -33,7 +33,7 @@ use Doctrine\ORM\EntityManager; class OnFlushEventArgs extends \Doctrine\Common\EventArgs { /** - * @var Doctirne\ORM\EntityManager + * @var \Doctrine\ORM\EntityManager */ private $em; diff --git a/lib/Doctrine/ORM/Event/PreFlushEventArgs.php b/lib/Doctrine/ORM/Event/PreFlushEventArgs.php index 82f2b7eae..c59f5db70 100644 --- a/lib/Doctrine/ORM/Event/PreFlushEventArgs.php +++ b/lib/Doctrine/ORM/Event/PreFlushEventArgs.php @@ -31,7 +31,7 @@ namespace Doctrine\ORM\Event; class PreFlushEventArgs extends \Doctrine\Common\EventArgs { /** - * @var EntityManager + * @var \Doctrine\ORM\EntityManager */ private $_em; @@ -41,7 +41,7 @@ class PreFlushEventArgs extends \Doctrine\Common\EventArgs } /** - * @return EntityManager + * @return \Doctrine\ORM\EntityManager */ public function getEntityManager() { diff --git a/lib/Doctrine/ORM/Id/AbstractIdGenerator.php b/lib/Doctrine/ORM/Id/AbstractIdGenerator.php index ef98caf8d..77f6b0022 100644 --- a/lib/Doctrine/ORM/Id/AbstractIdGenerator.php +++ b/lib/Doctrine/ORM/Id/AbstractIdGenerator.php @@ -26,7 +26,7 @@ abstract class AbstractIdGenerator /** * Generates an identifier for an entity. * - * @param \Doctrine\ORM\Entity $entity + * @param \Doctrine\ORM\Mapping\Entity $entity * @return mixed */ abstract public function generate(EntityManager $em, $entity); diff --git a/lib/Doctrine/ORM/Query/FilterCollection.php b/lib/Doctrine/ORM/Query/FilterCollection.php index fc47eb111..c8091d77d 100644 --- a/lib/Doctrine/ORM/Query/FilterCollection.php +++ b/lib/Doctrine/ORM/Query/FilterCollection.php @@ -43,14 +43,14 @@ class FilterCollection /** * The used Configuration. * - * @var Doctrine\ORM\Configuration + * @var \Doctrine\ORM\Configuration */ private $config; /** * The EntityManager that "owns" this FilterCollection instance. * - * @var Doctrine\ORM\EntityManager + * @var \Doctrine\ORM\EntityManager */ private $em; @@ -99,7 +99,7 @@ class FilterCollection * * @throws \InvalidArgumentException If the filter does not exist. * - * @return SQLFilter The enabled filter. + * @return \Doctrine\ORM\Query\Filter\SQLFilter The enabled filter. */ public function enable($name) { @@ -125,7 +125,7 @@ class FilterCollection * * @param string $name Name of the filter. * - * @return SQLFilter The disabled filter. + * @return \Doctrine\ORM\Query\Filter\SQLFilter The disabled filter. * * @throws \InvalidArgumentException If the filter does not exist. */ @@ -147,7 +147,7 @@ class FilterCollection * * @param string $name Name of the filter. * - * @return SQLFilter The filter. + * @return \Doctrine\ORM\Query\Filter\SQLFilter The filter. * * @throws \InvalidArgumentException If the filter is not enabled. */ diff --git a/lib/Doctrine/ORM/Query/Parser.php b/lib/Doctrine/ORM/Query/Parser.php index 1e1919d54..ac6ad6f3e 100644 --- a/lib/Doctrine/ORM/Query/Parser.php +++ b/lib/Doctrine/ORM/Query/Parser.php @@ -92,7 +92,7 @@ class Parser /** * The EntityManager. * - * @var EnityManager + * @var \Doctrine\ORM\EntityManager */ private $_em; @@ -209,7 +209,7 @@ class Parser /** * Gets the EntityManager used by the parser. * - * @return EntityManager + * @return \Doctrine\ORM\EntityManager */ public function getEntityManager() { diff --git a/lib/Doctrine/ORM/Tools/Console/Helper/EntityManagerHelper.php b/lib/Doctrine/ORM/Tools/Console/Helper/EntityManagerHelper.php index a5da0417c..5d4d06114 100644 --- a/lib/Doctrine/ORM/Tools/Console/Helper/EntityManagerHelper.php +++ b/lib/Doctrine/ORM/Tools/Console/Helper/EntityManagerHelper.php @@ -44,7 +44,7 @@ class EntityManagerHelper extends Helper /** * Constructor * - * @param Connection $connection Doctrine Database Connection + * @param \Doctrine\DBAL\Connection $connection Doctrine Database Connection */ public function __construct(EntityManager $em) { diff --git a/lib/Doctrine/ORM/Tools/DebugUnitOfWorkListener.php b/lib/Doctrine/ORM/Tools/DebugUnitOfWorkListener.php index c2bb0fdfe..ac12b9f62 100644 --- a/lib/Doctrine/ORM/Tools/DebugUnitOfWorkListener.php +++ b/lib/Doctrine/ORM/Tools/DebugUnitOfWorkListener.php @@ -23,6 +23,7 @@ use Doctrine\ORM\Event\OnFlushEventArgs; use Doctrine\ORM\Mapping\ClassMetadata; use Doctrine\ORM\PersistentCollection; use Doctrine\ORM\UnitOfWork; +use Doctrine\ORM\EntityManager; /** * Use this logger to dump the identity map during the onFlush event. This is useful for debugging diff --git a/lib/Doctrine/ORM/Tools/Pagination/CountOutputWalker.php b/lib/Doctrine/ORM/Tools/Pagination/CountOutputWalker.php index 098934e30..bae9be2db 100644 --- a/lib/Doctrine/ORM/Tools/Pagination/CountOutputWalker.php +++ b/lib/Doctrine/ORM/Tools/Pagination/CountOutputWalker.php @@ -30,12 +30,12 @@ use Doctrine\ORM\Query\SqlWalker, class CountOutputWalker extends SqlWalker { /** - * @var Doctrine\DBAL\Platforms\AbstractPlatform + * @var \Doctrine\DBAL\Platforms\AbstractPlatform */ private $platform; /** - * @var Doctrine\ORM\Query\ResultSetMapping + * @var \Doctrine\ORM\Query\ResultSetMapping */ private $rsm; @@ -49,8 +49,8 @@ class CountOutputWalker extends SqlWalker * because Doctrine\ORM\Query\SqlWalker keeps everything private without * accessors. * - * @param Doctrine\ORM\Query $query - * @param Doctrine\ORM\Query\ParserResult $parserResult + * @param \Doctrine\ORM\Query $query + * @param \Doctrine\ORM\Query\ParserResult $parserResult * @param array $queryComponents */ public function __construct($query, $parserResult, array $queryComponents) diff --git a/lib/Doctrine/ORM/Tools/Pagination/LimitSubqueryOutputWalker.php b/lib/Doctrine/ORM/Tools/Pagination/LimitSubqueryOutputWalker.php index 2c79a5acc..07f3993b4 100644 --- a/lib/Doctrine/ORM/Tools/Pagination/LimitSubqueryOutputWalker.php +++ b/lib/Doctrine/ORM/Tools/Pagination/LimitSubqueryOutputWalker.php @@ -30,12 +30,12 @@ use Doctrine\ORM\Query\SqlWalker, class LimitSubqueryOutputWalker extends SqlWalker { /** - * @var Doctrine\DBAL\Platforms\AbstractPlatform + * @var \Doctrine\DBAL\Platforms\AbstractPlatform */ private $platform; /** - * @var Doctrine\ORM\Query\ResultSetMapping + * @var \Doctrine\ORM\Query\ResultSetMapping */ private $rsm; @@ -59,8 +59,8 @@ class LimitSubqueryOutputWalker extends SqlWalker * because Doctrine\ORM\Query\SqlWalker keeps everything private without * accessors. * - * @param Doctrine\ORM\Query $query - * @param Doctrine\ORM\Query\ParserResult $parserResult + * @param \Doctrine\ORM\Query $query + * @param \Doctrine\ORM\Query\ParserResult $parserResult * @param array $queryComponents */ public function __construct($query, $parserResult, array $queryComponents)