Fixes various phpdoc and coding standards.

Hugo Hamon · Hugo Hamon · commit 017495b89b0a · 2015-01-02T09:58:20.000+01:00
diff --git a/DependencyInjection/AbstractDoctrineExtension.php b/DependencyInjection/AbstractDoctrineExtension.php
@@ -129,11 +129,11 @@ protected function setMappingDriverAlias($mappingConfig, $mappingName)
      */
     protected function setMappingDriverConfig(array $mappingConfig, $mappingName)
     {
-        if (is_dir($mappingConfig['dir'])) {
-            $this->drivers[$mappingConfig['type']][$mappingConfig['prefix']] = realpath($mappingConfig['dir']);
-        } else {
+        if (!is_dir($mappingConfig['dir'])) {
             throw new \InvalidArgumentException(sprintf('Invalid Doctrine mapping path given. Cannot load Doctrine mapping/bundle named "%s".', $mappingName));
         }
+
+        $this->drivers[$mappingConfig['type']][$mappingConfig['prefix']] = realpath($mappingConfig['dir']);
     }
 
     /**
diff --git a/Form/ChoiceList/EntityChoiceList.php b/Form/ChoiceList/EntityChoiceList.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Form\Extension\Core\ChoiceList\ObjectChoiceList;
 use Doctrine\Common\Persistence\ObjectManager;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Doctrine\Common\Persistence\Mapping\ClassMetadata;
 
 /**
  * A choice list presenting a list of Doctrine entities as choices.
@@ -35,7 +36,7 @@ class EntityChoiceList extends ObjectChoiceList
     private $class;
 
     /**
-     * @var \Doctrine\Common\Persistence\Mapping\ClassMetadata
+     * @var ClassMetadata
      */
     private $classMetadata;
 
@@ -132,7 +133,7 @@ public function __construct(ObjectManager $manager, $class, $labelPath = null, E
      *
      * @return array
      *
-     * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
+     * @see ChoiceListInterface
      */
     public function getChoices()
     {
@@ -148,7 +149,7 @@ public function getChoices()
      *
      * @return array
      *
-     * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
+     * @see ChoiceListInterface
      */
     public function getValues()
     {
@@ -165,7 +166,7 @@ public function getValues()
      *
      * @return array
      *
-     * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
+     * @see ChoiceListInterface
      */
     public function getPreferredViews()
     {
@@ -182,7 +183,7 @@ public function getPreferredViews()
      *
      * @return array
      *
-     * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
+     * @see ChoiceListInterface
      */
     public function getRemainingViews()
     {
@@ -200,7 +201,7 @@ public function getRemainingViews()
      *
      * @return array
      *
-     * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
+     * @see ChoiceListInterface
      */
     public function getChoicesForValues(array $values)
     {
@@ -253,7 +254,7 @@ public function getChoicesForValues(array $values)
      *
      * @return array
      *
-     * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
+     * @see ChoiceListInterface
      */
     public function getValuesForChoices(array $entities)
     {
@@ -293,7 +294,7 @@ public function getValuesForChoices(array $entities)
      *
      * @return array
      *
-     * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
+     * @see ChoiceListInterface
      */
     public function getIndicesForChoices(array $entities)
     {
@@ -333,7 +334,7 @@ public function getIndicesForChoices(array $entities)
      *
      * @return array
      *
-     * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
+     * @see ChoiceListInterface
      */
     public function getIndicesForValues(array $values)
     {
@@ -416,6 +417,8 @@ protected function fixIndex($index)
 
     /**
      * Loads the list with entities.
+     *
+     * @throws StringCastException
      */
     private function load()
     {
diff --git a/Form/DoctrineOrmExtension.php b/Form/DoctrineOrmExtension.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bridge\Doctrine\Form;
 
 use Doctrine\Common\Persistence\ManagerRegistry;
+use Symfony\Bridge\Doctrine\Form\Type\EntityType;
 use Symfony\Component\Form\AbstractExtension;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 
@@ -27,7 +28,7 @@ public function __construct(ManagerRegistry $registry)
     protected function loadTypes()
     {
         return array(
-            new Type\EntityType($this->registry, PropertyAccess::createPropertyAccessor()),
+            new EntityType($this->registry, PropertyAccess::createPropertyAccessor()),
         );
     }
 
diff --git a/Form/EventListener/MergeDoctrineCollectionListener.php b/Form/EventListener/MergeDoctrineCollectionListener.php
@@ -23,7 +23,7 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
- * @see    Doctrine\Common\Collections\Collection
+ * @see Collection
  */
 class MergeDoctrineCollectionListener implements EventSubscriberInterface
 {
diff --git a/Security/RememberMe/DoctrineTokenProvider.php b/Security/RememberMe/DoctrineTokenProvider.php
@@ -41,14 +41,14 @@ class DoctrineTokenProvider implements TokenProviderInterface
      * Doctrine DBAL database connection
      * F.ex. service id: doctrine.dbal.default_connection.
      *
-     * @var \Doctrine\DBAL\Connection
+     * @var Connection
      */
     private $conn;
 
     /**
      * new DoctrineTokenProvider for the RemembeMe authentication service.
      *
-     * @param \Doctrine\DBAL\Connection $conn
+     * @param Connection $conn
      */
     public function __construct(Connection $conn)
     {
@@ -65,14 +65,10 @@ public function loadTokenBySeries($series)
         $paramValues = array('series' => $series);
         $paramTypes = array('series' => \PDO::PARAM_STR);
         $stmt = $this->conn->executeQuery($sql, $paramValues, $paramTypes);
-        $row =  $stmt->fetch(\PDO::FETCH_ASSOC);
+        $row = $stmt->fetch(\PDO::FETCH_ASSOC);
+
         if ($row) {
-            return new PersistentToken($row['class'],
-                                       $row['username'],
-                                       $series,
-                                       $row['value'],
-                                       new \DateTime($row['lastUsed'])
-                                       );
+            return new PersistentToken($row['class'], $row['username'], $series, $row['value'], new \DateTime($row['lastUsed']));
         }
 
         throw new TokenNotFoundException('No token found.');
diff --git a/Validator/Constraints/UniqueEntityValidator.php b/Validator/Constraints/UniqueEntityValidator.php
@@ -29,9 +29,6 @@ class UniqueEntityValidator extends ConstraintValidator
      */
     private $registry;
 
-    /**
-     * @param ManagerRegistry $registry
-     */
     public function __construct(ManagerRegistry $registry)
     {
         $this->registry = $registry;

Original file line number	Diff line number	Diff line change
`@@ -129,11 +129,11 @@ protected function setMappingDriverAlias($mappingConfig, $mappingName)`
`129`	`129`	`*/`
`130`	`130`	`protected function setMappingDriverConfig(array $mappingConfig, $mappingName)`
`131`	`131`	`{`
`132`		`- if (is_dir($mappingConfig['dir'])) {`
`133`		`- $this->drivers[$mappingConfig['type']][$mappingConfig['prefix']] = realpath($mappingConfig['dir']);`
`134`		`- } else {`
	`132`	`+ if (!is_dir($mappingConfig['dir'])) {`
`135`	`133`	`throw new \InvalidArgumentException(sprintf('Invalid Doctrine mapping path given. Cannot load Doctrine mapping/bundle named "%s".', $mappingName));`
`136`	`134`	`}`
	`135`	`+`
	`136`	`+ $this->drivers[$mappingConfig['type']][$mappingConfig['prefix']] = realpath($mappingConfig['dir']);`
`137`	`137`	`}`
`138`	`138`
`139`	`139`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`use Symfony\Component\Form\Extension\Core\ChoiceList\ObjectChoiceList;`
`17`	`17`	`use Doctrine\Common\Persistence\ObjectManager;`
`18`	`18`	`use Symfony\Component\PropertyAccess\PropertyAccessorInterface;`
	`19`	`+use Doctrine\Common\Persistence\Mapping\ClassMetadata;`
`19`	`20`
`20`	`21`	`/**`
`21`	`22`	`* A choice list presenting a list of Doctrine entities as choices.`
`@@ -35,7 +36,7 @@ class EntityChoiceList extends ObjectChoiceList`
`35`	`36`	`private $class;`
`36`	`37`
`37`	`38`	`/**`
`38`		`- * @var \Doctrine\Common\Persistence\Mapping\ClassMetadata`
	`39`	`+ * @var ClassMetadata`
`39`	`40`	`*/`
`40`	`41`	`private $classMetadata;`
`41`	`42`
`@@ -132,7 +133,7 @@ public function __construct(ObjectManager $manager, $class, $labelPath = null, E`
`132`	`133`	`*`
`133`	`134`	`* @return array`
`134`	`135`	`*`
`135`		`- * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface`
	`136`	`+ * @see ChoiceListInterface`
`136`	`137`	`*/`
`137`	`138`	`public function getChoices()`
`138`	`139`	`{`
`@@ -148,7 +149,7 @@ public function getChoices()`
`148`	`149`	`*`
`149`	`150`	`* @return array`
`150`	`151`	`*`
`151`		`- * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface`
	`152`	`+ * @see ChoiceListInterface`
`152`	`153`	`*/`
`153`	`154`	`public function getValues()`
`154`	`155`	`{`
`@@ -165,7 +166,7 @@ public function getValues()`
`165`	`166`	`*`
`166`	`167`	`* @return array`
`167`	`168`	`*`
`168`		`- * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface`
	`169`	`+ * @see ChoiceListInterface`
`169`	`170`	`*/`
`170`	`171`	`public function getPreferredViews()`
`171`	`172`	`{`
`@@ -182,7 +183,7 @@ public function getPreferredViews()`
`182`	`183`	`*`
`183`	`184`	`* @return array`
`184`	`185`	`*`
`185`		`- * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface`
	`186`	`+ * @see ChoiceListInterface`
`186`	`187`	`*/`
`187`	`188`	`public function getRemainingViews()`
`188`	`189`	`{`
`@@ -200,7 +201,7 @@ public function getRemainingViews()`
`200`	`201`	`*`
`201`	`202`	`* @return array`
`202`	`203`	`*`
`203`		`- * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface`
	`204`	`+ * @see ChoiceListInterface`
`204`	`205`	`*/`
`205`	`206`	`public function getChoicesForValues(array $values)`
`206`	`207`	`{`
`@@ -253,7 +254,7 @@ public function getChoicesForValues(array $values)`
`253`	`254`	`*`
`254`	`255`	`* @return array`
`255`	`256`	`*`
`256`		`- * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface`
	`257`	`+ * @see ChoiceListInterface`
`257`	`258`	`*/`
`258`	`259`	`public function getValuesForChoices(array $entities)`
`259`	`260`	`{`
`@@ -293,7 +294,7 @@ public function getValuesForChoices(array $entities)`
`293`	`294`	`*`
`294`	`295`	`* @return array`
`295`	`296`	`*`
`296`		`- * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface`
	`297`	`+ * @see ChoiceListInterface`
`297`	`298`	`*/`
`298`	`299`	`public function getIndicesForChoices(array $entities)`
`299`	`300`	`{`
`@@ -333,7 +334,7 @@ public function getIndicesForChoices(array $entities)`
`333`	`334`	`*`
`334`	`335`	`* @return array`
`335`	`336`	`*`
`336`		`- * @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface`
	`337`	`+ * @see ChoiceListInterface`
`337`	`338`	`*/`
`338`	`339`	`public function getIndicesForValues(array $values)`
`339`	`340`	`{`
`@@ -416,6 +417,8 @@ protected function fixIndex($index)`
`416`	`417`
`417`	`418`	`/**`
`418`	`419`	`* Loads the list with entities.`
	`420`	`+ *`
	`421`	`+ * @throws StringCastException`
`419`	`422`	`*/`
`420`	`423`	`private function load()`
`421`	`424`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Bridge\Doctrine\Form;`
`13`	`13`
`14`	`14`	`use Doctrine\Common\Persistence\ManagerRegistry;`
	`15`	`+use Symfony\Bridge\Doctrine\Form\Type\EntityType;`
`15`	`16`	`use Symfony\Component\Form\AbstractExtension;`
`16`	`17`	`use Symfony\Component\PropertyAccess\PropertyAccess;`
`17`	`18`
`@@ -27,7 +28,7 @@ public function __construct(ManagerRegistry $registry)`
`27`	`28`	`protected function loadTypes()`
`28`	`29`	`{`
`29`	`30`	`return array(`
`30`		`- new Type\EntityType($this->registry, PropertyAccess::createPropertyAccessor()),`
	`31`	`+ new EntityType($this->registry, PropertyAccess::createPropertyAccessor()),`
`31`	`32`	`);`
`32`	`33`	`}`
`33`	`34`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* @author Bernhard Schussek <[email protected]>`
`25`	`25`	`*`
`26`		`- * @see Doctrine\Common\Collections\Collection`
	`26`	`+ * @see Collection`
`27`	`27`	`*/`
`28`	`28`	`class MergeDoctrineCollectionListener implements EventSubscriberInterface`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,6 @@ class UniqueEntityValidator extends ConstraintValidator`
`29`	`29`	`*/`
`30`	`30`	`private $registry;`
`31`	`31`
`32`		`- /**`
`33`		`- * @param ManagerRegistry $registry`
`34`		`- */`
`35`	`32`	`public function __construct(ManagerRegistry $registry)`
`36`	`33`	`{`
`37`	`34`	`$this->registry = $registry;`