From a409e7591d3da299e6ad5fbcd2f413a035221e92 Mon Sep 17 00:00:00 2001 From: Jeroen Thora Date: Sun, 15 Mar 2015 16:53:34 +0100 Subject: [PATCH] Changed some wrong usage of the @internal phpdoc --- lib/Doctrine/ORM/Configuration.php | 3 ++- lib/Doctrine/ORM/EntityManager.php | 4 ++-- .../ORM/Internal/Hydration/ObjectHydrator.php | 4 ++-- lib/Doctrine/ORM/PersistentCollection.php | 6 +++--- .../Persisters/Collection/ManyToManyPersister.php | 7 +++---- .../ORM/Query/Exec/MultiTableDeleteExecutor.php | 6 +++--- .../ORM/Query/Exec/MultiTableUpdateExecutor.php | 6 +++--- lib/Doctrine/ORM/Query/Parser.php | 2 +- lib/Doctrine/ORM/UnitOfWork.php | 14 ++++++++------ 9 files changed, 27 insertions(+), 25 deletions(-) diff --git a/lib/Doctrine/ORM/Configuration.php b/lib/Doctrine/ORM/Configuration.php index 04817760d..c99c40475 100644 --- a/lib/Doctrine/ORM/Configuration.php +++ b/lib/Doctrine/ORM/Configuration.php @@ -42,8 +42,9 @@ use Doctrine\ORM\Repository\RepositoryFactory; * Configuration container for all configuration options of Doctrine. * It combines all configuration options from DBAL & ORM. * + * Internal note: When adding a new configuration option just write a getter/setter pair. + * * @since 2.0 - * @internal When adding a new configuration option just write a getter/setter pair. * @author Benjamin Eberlei * @author Guilherme Blanco * @author Jonathan Wage diff --git a/lib/Doctrine/ORM/EntityManager.php b/lib/Doctrine/ORM/EntityManager.php index 049ac0f72..685fc0d71 100644 --- a/lib/Doctrine/ORM/EntityManager.php +++ b/lib/Doctrine/ORM/EntityManager.php @@ -270,11 +270,11 @@ use Doctrine\Common\Util\ClassUtils; * MyProject\Domain\User * sales:PriceRequest * + * Internal note: Performance-sensitive method. + * * @param string $className * * @return \Doctrine\ORM\Mapping\ClassMetadata - * - * @internal Performance-sensitive method. */ public function getClassMetadata($className) { diff --git a/lib/Doctrine/ORM/Internal/Hydration/ObjectHydrator.php b/lib/Doctrine/ORM/Internal/Hydration/ObjectHydrator.php index e0024bb7c..c1bcc2591 100644 --- a/lib/Doctrine/ORM/Internal/Hydration/ObjectHydrator.php +++ b/lib/Doctrine/ORM/Internal/Hydration/ObjectHydrator.php @@ -33,12 +33,12 @@ use Doctrine\ORM\Proxy\Proxy; /** * The ObjectHydrator constructs an object graph out of an SQL result set. * + * Internal note: Highly performance-sensitive code. + * * @since 2.0 * @author Roman Borschel * @author Guilherme Blanco * @author Fabio B. Silva - * - * @internal Highly performance-sensitive code. */ class ObjectHydrator extends AbstractHydrator { diff --git a/lib/Doctrine/ORM/PersistentCollection.php b/lib/Doctrine/ORM/PersistentCollection.php index 22404bbc7..afde3b1a0 100644 --- a/lib/Doctrine/ORM/PersistentCollection.php +++ b/lib/Doctrine/ORM/PersistentCollection.php @@ -707,10 +707,10 @@ final class PersistentCollection implements Collection, Selectable * Called by PHP when this collection is serialized. Ensures that only the * elements are properly serialized. * - * @return array + * Internal note: Tried to implement Serializable first but that did not work well + * with circular references. This solution seems simpler and works well. * - * @internal Tried to implement Serializable first but that did not work well - * with circular references. This solution seems simpler and works well. + * @return array */ public function __sleep() { diff --git a/lib/Doctrine/ORM/Persisters/Collection/ManyToManyPersister.php b/lib/Doctrine/ORM/Persisters/Collection/ManyToManyPersister.php index a421b9112..bf9f14e68 100644 --- a/lib/Doctrine/ORM/Persisters/Collection/ManyToManyPersister.php +++ b/lib/Doctrine/ORM/Persisters/Collection/ManyToManyPersister.php @@ -376,9 +376,8 @@ class ManyToManyPersister extends AbstractCollectionPersister /** * {@inheritdoc} * + * Internal note: Order of the parameters must be the same as the order of the columns in getDeleteSql. * @override - * - * @internal Order of the parameters must be the same as the order of the columns in getDeleteSql. */ protected function getDeleteSQLParameters(PersistentCollection $collection) { @@ -440,7 +439,7 @@ class ManyToManyPersister extends AbstractCollectionPersister * Gets the SQL parameters for the corresponding SQL statement to delete the given * element from the given collection. * - * @internal Order of the parameters must be the same as the order of the columns in getDeleteRowSql. + * Internal note: Order of the parameters must be the same as the order of the columns in getDeleteRowSql. * * @param \Doctrine\ORM\PersistentCollection $collection * @param mixed $element @@ -491,7 +490,7 @@ class ManyToManyPersister extends AbstractCollectionPersister * Gets the SQL parameters for the corresponding SQL statement to insert the given * element of the given collection into the database. * - * @internal Order of the parameters must be the same as the order of the columns in getInsertRowSql. + * Internal note: Order of the parameters must be the same as the order of the columns in getInsertRowSql. * * @param \Doctrine\ORM\PersistentCollection $collection * @param mixed $element diff --git a/lib/Doctrine/ORM/Query/Exec/MultiTableDeleteExecutor.php b/lib/Doctrine/ORM/Query/Exec/MultiTableDeleteExecutor.php index e110d13e1..4e5303ce7 100644 --- a/lib/Doctrine/ORM/Query/Exec/MultiTableDeleteExecutor.php +++ b/lib/Doctrine/ORM/Query/Exec/MultiTableDeleteExecutor.php @@ -51,11 +51,11 @@ class MultiTableDeleteExecutor extends AbstractSqlExecutor /** * Initializes a new MultiTableDeleteExecutor. * + * Internal note: Any SQL construction and preparation takes place in the constructor for + * best performance. With a query cache the executor will be cached. + * * @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. */ public function __construct(AST\Node $AST, $sqlWalker) { diff --git a/lib/Doctrine/ORM/Query/Exec/MultiTableUpdateExecutor.php b/lib/Doctrine/ORM/Query/Exec/MultiTableUpdateExecutor.php index 8ceefe3a9..54653fc55 100644 --- a/lib/Doctrine/ORM/Query/Exec/MultiTableUpdateExecutor.php +++ b/lib/Doctrine/ORM/Query/Exec/MultiTableUpdateExecutor.php @@ -62,11 +62,11 @@ class MultiTableUpdateExecutor extends AbstractSqlExecutor /** * Initializes a new MultiTableUpdateExecutor. * + * Internal note: Any SQL construction and preparation takes place in the constructor for + * best performance. With a query cache the executor will be cached. + * * @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. */ public function __construct(AST\Node $AST, $sqlWalker) { diff --git a/lib/Doctrine/ORM/Query/Parser.php b/lib/Doctrine/ORM/Query/Parser.php index fea4f9a12..93f07b171 100644 --- a/lib/Doctrine/ORM/Query/Parser.php +++ b/lib/Doctrine/ORM/Query/Parser.php @@ -1578,7 +1578,7 @@ class Parser * * SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration * - * {@internal WARNING: Solution is harder than a bare implementation. + * {Internal note: WARNING: Solution is harder than a bare implementation. * Desired EBNF support: * * SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration | (AssociationPathExpression ["AS"] AliasIdentificationVariable) diff --git a/lib/Doctrine/ORM/UnitOfWork.php b/lib/Doctrine/ORM/UnitOfWork.php index c976443a8..0126bc628 100644 --- a/lib/Doctrine/ORM/UnitOfWork.php +++ b/lib/Doctrine/ORM/UnitOfWork.php @@ -56,13 +56,14 @@ use Doctrine\ORM\Cache\AssociationCacheEntry; * "object-level" transaction and for writing out changes to the database * in the correct order. * + * Internal note: This class contains highly performance-sensitive code. + * * @since 2.0 * @author Benjamin Eberlei * @author Guilherme Blanco * @author Jonathan Wage * @author Roman Borschel * @author Rob Caiger - * @internal This class contains highly performance-sensitive code. */ class UnitOfWork implements PropertyChangedListener { @@ -120,10 +121,11 @@ class UnitOfWork implements PropertyChangedListener * Keys are object ids (spl_object_hash). This is used for calculating changesets * at commit time. * + * Internal note: Note that PHPs "copy-on-write" behavior helps a lot with memory usage. + * A value will only really be copied if the value in the entity is modified + * by the user. + * * @var array - * @internal Note that PHPs "copy-on-write" behavior helps a lot with memory usage. - * A value will only really be copied if the value in the entity is modified - * by the user. */ private $originalEntityData = array(); @@ -2474,6 +2476,8 @@ class UnitOfWork implements PropertyChangedListener * INTERNAL: * Creates an entity. Used for reconstitution of persistent entities. * + * Internal note: Highly performance-sensitive method. + * * @ignore * * @param string $className The name of the entity class. @@ -2482,8 +2486,6 @@ class UnitOfWork implements PropertyChangedListener * * @return object The managed entity instance. * - * @internal Highly performance-sensitive method. - * * @todo Rename: getOrCreateEntity */ public function createEntity($className, array $data, &$hints = array())