Merge pull request #644 from pborreli/typos

Fixed typos
doctrine · Apr 6, 2013 · 3c4a9c8 · 3c4a9c8
2 parents 64b2ecf + 30b050b
commit 3c4a9c8
Show file tree

Hide file tree

Showing 16 changed files with 28 additions and 26 deletions.
diff --git a/lib/Doctrine/ORM/AbstractQuery.php b/lib/Doctrine/ORM/AbstractQuery.php
@@ -309,7 +309,7 @@ public function setResultSetMapping(Query\ResultSetMapping $rsm)
     /**
      * Allows to translate entity namespaces to full qualified names.
      *
-     * @param EntityManager $em
+     * @param Query\ResultSetMapping $rsm
      *
      * @return void
      */

diff --git a/lib/Doctrine/ORM/Event/ListenersInvoker.php b/lib/Doctrine/ORM/Event/ListenersInvoker.php
@@ -91,7 +91,7 @@ public function getSubscribedSystems(ClassMetadata $metadata, $eventName)
      *
      * @param \Doctrine\ORM\Mapping\ClassMetadata $metadata The entity metadata.
      * @param string $eventName                             The entity lifecycle event.
-     * @param object $entity                                The Entity on which the event occured.
+     * @param object $entity                                The Entity on which the event occurred.
      * @param \Doctrine\Common\EventArgs $event             The Event args.
      * @param integer $invoke                               Bitmask to invoke listeners.
      */

diff --git a/lib/Doctrine/ORM/Id/AssignedGenerator.php b/lib/Doctrine/ORM/Id/AssignedGenerator.php
@@ -23,7 +23,7 @@
 use Doctrine\ORM\ORMException;
 
 /**
- * Special generator for application-assigned identifiers (doesnt really generate anything).
+ * Special generator for application-assigned identifiers (doesn't really generate anything).
  *
  * @since   2.0
  * @author  Benjamin Eberlei <kontakt@beberlei.de>

diff --git a/lib/Doctrine/ORM/Id/BigIntegerIdentityGenerator.php b/lib/Doctrine/ORM/Id/BigIntegerIdentityGenerator.php
@@ -38,9 +38,9 @@ class BigIntegerIdentityGenerator extends AbstractIdGenerator
     /**
      * Constructor.
      *
-     * @param string|null $seqName The name of the sequence to pass to lastInsertId()
-     *                             to obtain the last generated identifier within the current
-     *                             database session/connection, if any.
+     * @param string|null $sequenceName The name of the sequence to pass to lastInsertId()
+     *                                  to obtain the last generated identifier within the current
+     *                                  database session/connection, if any.
      */
     public function __construct($sequenceName = null)
     {

diff --git a/lib/Doctrine/ORM/Id/IdentityGenerator.php b/lib/Doctrine/ORM/Id/IdentityGenerator.php
@@ -38,9 +38,9 @@ class IdentityGenerator extends AbstractIdGenerator
     /**
      * Constructor.
      *
-     * @param string|null $seqName The name of the sequence to pass to lastInsertId()
-     *                             to obtain the last generated identifier within the current
-     *                             database session/connection, if any.
+     * @param string|null $sequenceName The name of the sequence to pass to lastInsertId()
+     *                                  to obtain the last generated identifier within the current
+     *                                  database session/connection, if any.
      */
     public function __construct($sequenceName = null)
     {

diff --git a/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php b/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php
@@ -533,6 +533,7 @@ private function getMethodCallbacks(\ReflectionMethod $method)
     /**
      * Parse the given JoinColumn as array
      *
+     * @param JoinColumn $joinColumn
      * @return array
      */
     private function joinColumnToArray(JoinColumn $joinColumn)

diff --git a/lib/Doctrine/ORM/Mapping/EntityListenerResolver.php b/lib/Doctrine/ORM/Mapping/EntityListenerResolver.php
@@ -49,7 +49,7 @@ function resolve($className);
     /**
      * Register a entity listener instance.
      *
-     * @return  object An entity listener
+     * @param   object $object An entity listener
      */
     function register($object);
 }
diff --git a/lib/Doctrine/ORM/Mapping/MappingException.php b/lib/Doctrine/ORM/Mapping/MappingException.php
@@ -685,8 +685,8 @@ public static function lifecycleCallbackMethodNotFound($className, $methodName)
     }
 
     /**
+     * @param string $listenerName
      * @param string $className
-     * @param string $methodName
      *
      * @return \Doctrine\ORM\Mapping\MappingException
      */

diff --git a/lib/Doctrine/ORM/Persisters/AbstractCollectionPersister.php b/lib/Doctrine/ORM/Persisters/AbstractCollectionPersister.php
@@ -98,7 +98,7 @@ public function delete(PersistentCollection $coll)
      *
      * @param \Doctrine\ORM\PersistentCollection $coll
      *
-     * @return void
+     * @return string
      */
     abstract protected function getDeleteSQL(PersistentCollection $coll);
 
@@ -108,7 +108,7 @@ abstract protected function getDeleteSQL(PersistentCollection $coll);
      *
      * @param \Doctrine\ORM\PersistentCollection $coll
      *
-     * @return void
+     * @return array
      */
     abstract protected function getDeleteSQLParameters(PersistentCollection $coll);
 

diff --git a/lib/Doctrine/ORM/Query/AST/Functions/FunctionNode.php b/lib/Doctrine/ORM/Query/AST/Functions/FunctionNode.php
@@ -22,7 +22,7 @@
 use Doctrine\ORM\Query\AST\Node;
 
 /**
- * Abtract Function Node.
+ * Abstract Function Node.
  *
  * 
  * @link    www.doctrine-project.org

diff --git a/lib/Doctrine/ORM/Query/AST/Functions/IdentityFunction.php b/lib/Doctrine/ORM/Query/AST/Functions/IdentityFunction.php
@@ -83,9 +83,9 @@ public function getSql(SqlWalker $sqlWalker)
         }
 
         $tableAlias = $sqlWalker->getSQLTableAlias($class->getTableName(), $dqlAlias);
-        $columName  = $quoteStrategy->getJoinColumnName($joinColumn, $targetEntity, $platform);
+        $columnName  = $quoteStrategy->getJoinColumnName($joinColumn, $targetEntity, $platform);
 
-        return $tableAlias . '.' . $columName;
+        return $tableAlias . '.' . $columnName;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Query/Parser.php b/lib/Doctrine/ORM/Query/Parser.php
@@ -2,7 +2,7 @@
 /*
  * 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 MERCHARNTABILITY AND FITNESS FOR
+ * 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
@@ -1064,7 +1064,7 @@ public function PathExpression($expectedTypes)
         // Creating AST node
         $pathExpr = new AST\PathExpression($expectedTypes, $identVariable, $field);
 
-        // Defer PathExpression validation if requested to be defered
+        // Defer PathExpression validation if requested to be deferred
         $this->deferredPathExpressions[] = array(
             'expression'   => $pathExpr,
             'nestingLevel' => $this->nestingLevel,
@@ -2413,7 +2413,7 @@ public function SimpleConditionalExpression()
         }
 
         if ($token['type'] === Lexer::T_IDENTIFIER || $token['type'] === Lexer::T_INPUT_PARAMETER || $this->isFunction()) {
-            // Peek beyond the matching closing paranthesis.
+            // Peek beyond the matching closing parenthesis.
             $beyond = $this->lexer->peek();
 
             switch ($peek['value']) {
@@ -2765,7 +2765,7 @@ public function ArithmeticPrimary()
      * StringExpression ::= StringPrimary | "(" Subselect ")"
      *
      * @return \Doctrine\ORM\Query\AST\StringPrimary |
-     *         \Doctrine]ORM\Query\AST\Subselect
+     *         \Doctrine\ORM\Query\AST\Subselect
      */
     public function StringExpression()
     {

diff --git a/lib/Doctrine/ORM/Query/SqlWalker.php b/lib/Doctrine/ORM/Query/SqlWalker.php
@@ -428,7 +428,7 @@ private function _generateDiscriminatorColumnConditionSQL(array $dqlAliases)
             $conn   = $this->em->getConnection();
             $values = array();
 
-            if ($class->discriminatorValue !== null) { // discrimnators can be 0
+            if ($class->discriminatorValue !== null) { // discriminators can be 0
                 $values[] = $conn->quote($class->discriminatorValue);
             }
 

diff --git a/lib/Doctrine/ORM/Tools/Console/ConsoleRunner.php b/lib/Doctrine/ORM/Tools/Console/ConsoleRunner.php
@@ -35,6 +35,7 @@ class ConsoleRunner
     /**
      * Create a Symfony Console HelperSet
      *
+     * @param EntityManager $entityManager
      * @return HelperSet
      */
     public static function createHelperSet(EntityManager $entityManager)

diff --git a/lib/Doctrine/ORM/Tools/EntityGenerator.php b/lib/Doctrine/ORM/Tools/EntityGenerator.php
@@ -475,7 +475,7 @@ public function setGenerateAnnotations($bool)
     public function setFieldVisibility($visibility)
     {
         if ($visibility !== self::FIELD_VISIBLE_PRIVATE && $visibility !== self::FIELD_VISIBLE_PROTECTED) {
-            throw new \InvalidArgumentException('Invalid provided visibilty (only private and protected are allowed): ' . $visibility);
+            throw new \InvalidArgumentException('Invalid provided visibility (only private and protected are allowed): ' . $visibility);
         }
 
         $this->fieldVisibility = $visibility;
@@ -1480,7 +1480,7 @@ protected function getChangeTrackingPolicyString($type)
     /**
      * @param integer $type The generator to use for the mapped class.
      *
-     * @return string The literal string for the generetor type.
+     * @return string The literal string for the generator type.
      *
      * @throws \InvalidArgumentException    When the generator type does not exists.
      */

diff --git a/lib/Doctrine/ORM/UnitOfWork.php b/lib/Doctrine/ORM/UnitOfWork.php
@@ -597,7 +597,7 @@ public function computeChangeSet(ClassMetadata $class, $entity)
 
                 $orgValue = $originalData[$propName];
 
-                // skip if value havent changed
+                // skip if value haven't changed
                 if ($orgValue === $actualValue) {
                     continue;
                 }
@@ -1055,7 +1055,7 @@ private function getCommitOrder(array $entityChangeSet = null)
         $calc = $this->getCommitOrderCalculator();
 
         // See if there are any new classes in the changeset, that are not in the
-        // commit order graph yet (dont have a node).
+        // commit order graph yet (don't have a node).
         // We have to inspect changeSet to be able to correctly build dependencies.
         // It is not possible to use IdentityMap here because post inserted ids
         // are not yet available.
@@ -1820,7 +1820,7 @@ private function doMerge($entity, array &$visited, $prevManagedCopy = null, $ass
                 $managedCopyVersion = $reflField->getValue($managedCopy);
                 $entityVersion      = $reflField->getValue($entity);
 
-                // Throw exception if versions dont match.
+                // Throw exception if versions don't match.
                 if ($managedCopyVersion != $entityVersion) {
                     throw OptimisticLockException::lockFailedVersionMismatch($entity, $entityVersion, $managedCopyVersion);
                 }