[Bridge] [Propel] minor improvements to the Propel bridge.

Hugo Hamon · Hugo Hamon · commit 6d9d460ebba9 · 2014-12-21T17:25:02.000+01:00
diff --git a/src/Symfony/Bridge/Propel1/DataCollector/PropelDataCollector.php b/src/Symfony/Bridge/Propel1/DataCollector/PropelDataCollector.php
@@ -26,7 +26,7 @@ class PropelDataCollector extends DataCollector
     /**
      * Propel logger
      *
-     * @var \Symfony\Bridge\Propel1\Logger\PropelLogger
+     * @var PropelLogger
      */
     private $logger;
 
@@ -38,7 +38,7 @@ class PropelDataCollector extends DataCollector
     protected $propelConfiguration;
 
     /**
-     * Constructor
+     * Constructor.
      *
      * @param PropelLogger         $logger              A Propel logger.
      * @param \PropelConfiguration $propelConfiguration The Propel configuration object.
@@ -63,17 +63,17 @@ public function collect(Request $request, Response $response, \Exception $except
     /**
      * Returns the collector name.
      *
-     * @return string The collector name.
+     * @return string
      */
     public function getName()
     {
         return 'propel';
     }
 
     /**
-     * Returns queries.
+     * Returns the collected stats for all executed SQL queries.
      *
-     * @return array Queries
+     * @return array
      */
     public function getQueries()
     {
@@ -83,17 +83,17 @@ public function getQueries()
     /**
      * Returns the query count.
      *
-     * @return int The query count
+     * @return int
      */
     public function getQueryCount()
     {
         return $this->data['querycount'];
     }
 
     /**
-     * Returns the total time of queries.
+     * Returns the total time spent on running all queries.
      *
-     * @return float The total time of queries
+     * @return float
      */
     public function getTime()
     {
@@ -106,9 +106,9 @@ public function getTime()
     }
 
     /**
-     * Creates an array of Build objects.
+     * Computes the stats of all executed SQL queries.
      *
-     * @return array An array of Build objects
+     * @return array
      */
     private function buildQueries()
     {
@@ -136,9 +136,9 @@ private function buildQueries()
     }
 
     /**
-     * Count queries.
+     * Returns the total count of SQL queries.
      *
-     * @return int The number of queries.
+     * @return int
      */
     private function countQueries()
     {
diff --git a/src/Symfony/Bridge/Propel1/DependencyInjection/Security/UserProvider/PropelFactory.php b/src/Symfony/Bridge/Propel1/DependencyInjection/Security/UserProvider/PropelFactory.php
@@ -26,6 +26,12 @@ class PropelFactory implements UserProviderFactoryInterface
     private $key;
     private $providerId;
 
+    /**
+     * Constructor.
+     *
+     * @param string $key
+     * @param string $providerId
+     */
     public function __construct($key, $providerId)
     {
         $this->key = $key;
@@ -38,7 +44,7 @@ public function create(ContainerBuilder $container, $id, $config)
             ->setDefinition($id, new DefinitionDecorator($this->providerId))
             ->addArgument($config['class'])
             ->addArgument($config['property'])
-            ;
+        ;
     }
 
     public function getKey()
@@ -50,9 +56,14 @@ public function addConfiguration(NodeDefinition $node)
     {
         $node
             ->children()
-            ->scalarNode('class')->isRequired()->cannotBeEmpty()->end()
-            ->scalarNode('property')->defaultNull()->end()
+                ->scalarNode('class')
+                    ->isRequired()
+                    ->cannotBeEmpty()
+                ->end()
+                ->scalarNode('property')
+                    ->defaultNull()
+                ->end()
             ->end()
-            ;
+        ;
     }
 }
diff --git a/src/Symfony/Bridge/Propel1/Form/Type/ModelType.php b/src/Symfony/Bridge/Propel1/Form/Type/ModelType.php
@@ -55,18 +55,29 @@ class ModelType extends AbstractType
      */
     private $propertyAccessor;
 
+    /**
+     * Constructor.
+     *
+     * @param PropertyAccessorInterface|null $propertyAccessor
+     */
     public function __construct(PropertyAccessorInterface $propertyAccessor = null)
     {
         $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
         if ($options['multiple']) {
             $builder->addViewTransformer(new CollectionToArrayTransformer(), true);
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function setDefaultOptions(OptionsResolverInterface $resolver)
     {
         $propertyAccessor = $this->propertyAccessor;
@@ -97,11 +108,17 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)
         ));
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getParent()
     {
         return 'choice';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getName()
     {
         return 'model';
diff --git a/src/Symfony/Bridge/Propel1/Form/Type/TranslationCollectionType.php b/src/Symfony/Bridge/Propel1/Form/Type/TranslationCollectionType.php
@@ -18,7 +18,7 @@
 use Symfony\Bridge\Propel1\Form\EventListener\TranslationCollectionFormListener;
 
 /**
- * form type for i18n-columns in propel
+ * Form type for i18n-columns in propel
  *
  * @author Patrick Kaufmann
  */
@@ -40,6 +40,9 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         $builder->addEventSubscriber($listener);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getParent()
     {
         return 'collection';
diff --git a/src/Symfony/Bridge/Propel1/Form/Type/TranslationType.php b/src/Symfony/Bridge/Propel1/Form/Type/TranslationType.php
@@ -17,7 +17,7 @@
 use Symfony\Bridge\Propel1\Form\EventListener\TranslationFormListener;
 
 /**
- * Translation type class
+ * Translation type class.
  *
  * @author Patrick Kaufmann
  */
diff --git a/src/Symfony/Bridge/Propel1/Tests/DataCollector/PropelDataCollectorTest.php b/src/Symfony/Bridge/Propel1/Tests/DataCollector/PropelDataCollectorTest.php
@@ -92,18 +92,19 @@ public function testCollectWithMultipleData()
     private function createCollector($queries)
     {
         $config = $this->getMock('\PropelConfiguration');
+
         $config
             ->expects($this->any())
             ->method('getParameter')
             ->will($this->returnArgument(1))
-            ;
+        ;
 
         $logger = $this->getMock('\Symfony\Bridge\Propel1\Logger\PropelLogger');
         $logger
             ->expects($this->any())
             ->method('getQueries')
             ->will($this->returnValue($queries))
-            ;
+        ;
 
         return new PropelDataCollector($logger, $config);
     }
diff --git a/src/Symfony/Bridge/Propel1/Tests/Fixtures/Column.php b/src/Symfony/Bridge/Propel1/Tests/Fixtures/Column.php
@@ -14,7 +14,6 @@
 class Column
 {
     private $name;
-
     private $type;
 
     public function __construct($name, $type)
@@ -35,13 +34,13 @@ public function isText()
         }
 
         switch ($this->type) {
-        case \PropelColumnTypes::CHAR:
-        case \PropelColumnTypes::VARCHAR:
-        case \PropelColumnTypes::LONGVARCHAR:
-        case \PropelColumnTypes::BLOB:
-        case \PropelColumnTypes::CLOB:
-        case \PropelColumnTypes::CLOB_EMU:
-            return true;
+            case \PropelColumnTypes::CHAR:
+            case \PropelColumnTypes::VARCHAR:
+            case \PropelColumnTypes::LONGVARCHAR:
+            case \PropelColumnTypes::BLOB:
+            case \PropelColumnTypes::CLOB:
+            case \PropelColumnTypes::CLOB_EMU:
+                return true;
         }
 
         return false;
@@ -54,6 +53,6 @@ public function getSize()
 
     public function isNotNull()
     {
-        return ('id' === $this->name);
+        return 'id' === $this->name;
     }
 }
diff --git a/src/Symfony/Bridge/Propel1/Tests/Fixtures/Item.php b/src/Symfony/Bridge/Propel1/Tests/Fixtures/Item.php
@@ -11,16 +11,11 @@
 
 namespace Symfony\Bridge\Propel1\Tests\Fixtures;
 
-use PropelPDO;
-
 class Item implements \Persistent
 {
     private $id;
-
     private $value;
-
     private $groupName;
-
     private $price;
 
     public function __construct($id = null, $value = null, $groupName = null, $price = null)
@@ -98,11 +93,11 @@ public function setDeleted($b)
     {
     }
 
-    public function delete(PropelPDO $con = null)
+    public function delete(\PropelPDO $con = null)
     {
     }
 
-    public function save(PropelPDO $con = null)
+    public function save(\PropelPDO $con = null)
     {
     }
 }
diff --git a/src/Symfony/Bridge/Propel1/Tests/Fixtures/TranslatableItem.php b/src/Symfony/Bridge/Propel1/Tests/Fixtures/TranslatableItem.php
@@ -11,16 +11,11 @@
 
 namespace Symfony\Bridge\Propel1\Tests\Fixtures;
 
-use PropelPDO;
-
 class TranslatableItem implements \Persistent
 {
     private $id;
-
     private $currentTranslations;
-
     private $groupName;
-
     private $price;
 
     public function __construct($id = null, $translations = array())
@@ -91,15 +86,15 @@ public function setDeleted($b)
     {
     }
 
-    public function delete(PropelPDO $con = null)
+    public function delete(\PropelPDO $con = null)
     {
     }
 
-    public function save(PropelPDO $con = null)
+    public function save(\PropelPDO $con = null)
     {
     }
 
-    public function getTranslation($locale = 'de', PropelPDO $con = null)
+    public function getTranslation($locale = 'de', \PropelPDO $con = null)
     {
         if (!isset($this->currentTranslations[$locale])) {
             $translation = new TranslatableItemI18n();
diff --git a/src/Symfony/Bridge/Propel1/Tests/Fixtures/TranslatableItemI18n.php b/src/Symfony/Bridge/Propel1/Tests/Fixtures/TranslatableItemI18n.php
@@ -11,18 +11,12 @@
 
 namespace Symfony\Bridge\Propel1\Tests\Fixtures;
 
-use PropelPDO;
-
 class TranslatableItemI18n implements \Persistent
 {
     private $id;
-
     private $locale;
-
     private $value;
-
     private $value2;
-
     private $item;
 
     public function __construct($id = null, $locale = null, $value = null)
@@ -84,11 +78,11 @@ public function setDeleted($b)
     {
     }
 
-    public function delete(PropelPDO $con = null)
+    public function delete(\PropelPDO $con = null)
     {
     }
 
-    public function save(PropelPDO $con = null)
+    public function save(\PropelPDO $con = null)
     {
     }
 
diff --git a/src/Symfony/Bridge/Propel1/Tests/Form/ChoiceList/ModelChoiceListTest.php b/src/Symfony/Bridge/Propel1/Tests/Form/ChoiceList/ModelChoiceListTest.php
@@ -249,14 +249,14 @@ public function testDontAllowInvalidChoiceValues()
      */
     public function testEmptyClass()
     {
-        $choiceList = new ModelChoiceList('');
+        new ModelChoiceList('');
     }
 
     /**
      * @expectedException \Symfony\Component\OptionsResolver\Exception\InvalidOptionsException
      */
     public function testInvalidClass()
     {
-        $choiceList = new ModelChoiceList('Foo\Bar\DoesNotExistClass');
+        new ModelChoiceList('Foo\Bar\DoesNotExistClass');
     }
 }
diff --git a/src/Symfony/Bridge/Propel1/Tests/Form/DataTransformer/CollectionToArrayTransformerTest.php b/src/Symfony/Bridge/Propel1/Tests/Form/DataTransformer/CollectionToArrayTransformerTest.php
diff --git a/src/Symfony/Bridge/Propel1/Tests/Form/PropelTypeGuesserTest.php b/src/Symfony/Bridge/Propel1/Tests/Form/PropelTypeGuesserTest.php
diff --git a/src/Symfony/Bridge/Propel1/Tests/Form/Type/TranslationCollectionTypeTest.php b/src/Symfony/Bridge/Propel1/Tests/Form/Type/TranslationCollectionTypeTest.php

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class PropelDataCollector extends DataCollector`
`26`	`26`	`/**`
`27`	`27`	`* Propel logger`
`28`	`28`	`*`
`29`		`- * @var \Symfony\Bridge\Propel1\Logger\PropelLogger`
	`29`	`+ * @var PropelLogger`
`30`	`30`	`*/`
`31`	`31`	`private $logger;`
`32`	`32`
`@@ -38,7 +38,7 @@ class PropelDataCollector extends DataCollector`
`38`	`38`	`protected $propelConfiguration;`
`39`	`39`
`40`	`40`	`/**`
`41`		`- * Constructor`
	`41`	`+ * Constructor.`
`42`	`42`	`*`
`43`	`43`	`* @param PropelLogger $logger A Propel logger.`
`44`	`44`	`* @param \PropelConfiguration $propelConfiguration The Propel configuration object.`
`@@ -63,17 +63,17 @@ public function collect(Request $request, Response $response, \Exception $except`
`63`	`63`	`/**`
`64`	`64`	`* Returns the collector name.`
`65`	`65`	`*`
`66`		`- * @return string The collector name.`
	`66`	`+ * @return string`
`67`	`67`	`*/`
`68`	`68`	`public function getName()`
`69`	`69`	`{`
`70`	`70`	`return 'propel';`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`/**`
`74`		`- * Returns queries.`
	`74`	`+ * Returns the collected stats for all executed SQL queries.`
`75`	`75`	`*`
`76`		`- * @return array Queries`
	`76`	`+ * @return array`
`77`	`77`	`*/`
`78`	`78`	`public function getQueries()`
`79`	`79`	`{`
`@@ -83,17 +83,17 @@ public function getQueries()`
`83`	`83`	`/**`
`84`	`84`	`* Returns the query count.`
`85`	`85`	`*`
`86`		`- * @return int The query count`
	`86`	`+ * @return int`
`87`	`87`	`*/`
`88`	`88`	`public function getQueryCount()`
`89`	`89`	`{`
`90`	`90`	`return $this->data['querycount'];`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`/**`
`94`		`- * Returns the total time of queries.`
	`94`	`+ * Returns the total time spent on running all queries.`
`95`	`95`	`*`
`96`		`- * @return float The total time of queries`
	`96`	`+ * @return float`
`97`	`97`	`*/`
`98`	`98`	`public function getTime()`
`99`	`99`	`{`
`@@ -106,9 +106,9 @@ public function getTime()`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`/**`
`109`		`- * Creates an array of Build objects.`
	`109`	`+ * Computes the stats of all executed SQL queries.`
`110`	`110`	`*`
`111`		`- * @return array An array of Build objects`
	`111`	`+ * @return array`
`112`	`112`	`*/`
`113`	`113`	`private function buildQueries()`
`114`	`114`	`{`
`@@ -136,9 +136,9 @@ private function buildQueries()`
`136`	`136`	`}`
`137`	`137`
`138`	`138`	`/**`
`139`		`- * Count queries.`
	`139`	`+ * Returns the total count of SQL queries.`
`140`	`140`	`*`
`141`		`- * @return int The number of queries.`
	`141`	`+ * @return int`
`142`	`142`	`*/`
`143`	`143`	`private function countQueries()`
`144`	`144`	`{`
Original file line number	Diff line number	Diff line change
`@@ -55,18 +55,29 @@ class ModelType extends AbstractType`
`55`	`55`	`*/`
`56`	`56`	`private $propertyAccessor;`
`57`	`57`
	`58`	`+ /**`
	`59`	`+ * Constructor.`
	`60`	`+ *`
	`61`	`+ * @param PropertyAccessorInterface\|null $propertyAccessor`
	`62`	`+ */`
`58`	`63`	`public function __construct(PropertyAccessorInterface $propertyAccessor = null)`
`59`	`64`	`{`
`60`	`65`	`$this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();`
`61`	`66`	`}`
`62`	`67`
	`68`	`+ /**`
	`69`	`+ * {@inheritdoc}`
	`70`	`+ */`
`63`	`71`	`public function buildForm(FormBuilderInterface $builder, array $options)`
`64`	`72`	`{`
`65`	`73`	`if ($options['multiple']) {`
`66`	`74`	`$builder->addViewTransformer(new CollectionToArrayTransformer(), true);`
`67`	`75`	`}`
`68`	`76`	`}`
`69`	`77`
	`78`	`+ /**`
	`79`	`+ * {@inheritdoc}`
	`80`	`+ */`
`70`	`81`	`public function setDefaultOptions(OptionsResolverInterface $resolver)`
`71`	`82`	`{`
`72`	`83`	`$propertyAccessor = $this->propertyAccessor;`
`@@ -97,11 +108,17 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)`
`97`	`108`	`));`
`98`	`109`	`}`
`99`	`110`
	`111`	`+ /**`
	`112`	`+ * {@inheritdoc}`
	`113`	`+ */`
`100`	`114`	`public function getParent()`
`101`	`115`	`{`
`102`	`116`	`return 'choice';`
`103`	`117`	`}`
`104`	`118`
	`119`	`+ /**`
	`120`	`+ * {@inheritdoc}`
	`121`	`+ */`
`105`	`122`	`public function getName()`
`106`	`123`	`{`
`107`	`124`	`return 'model';`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`use Symfony\Bridge\Propel1\Form\EventListener\TranslationCollectionFormListener;`
`19`	`19`
`20`	`20`	`/**`
`21`		`- * form type for i18n-columns in propel`
	`21`	`+ * Form type for i18n-columns in propel`
`22`	`22`	`*`
`23`	`23`	`* @author Patrick Kaufmann`
`24`	`24`	`*/`
`@@ -40,6 +40,9 @@ public function buildForm(FormBuilderInterface $builder, array $options)`
`40`	`40`	`$builder->addEventSubscriber($listener);`
`41`	`41`	`}`
`42`	`42`
	`43`	`+ /**`
	`44`	`+ * {@inheritdoc}`
	`45`	`+ */`
`43`	`46`	`public function getParent()`
`44`	`47`	`{`
`45`	`48`	`return 'collection';`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`use Symfony\Bridge\Propel1\Form\EventListener\TranslationFormListener;`
`18`	`18`
`19`	`19`	`/**`
`20`		`- * Translation type class`
	`20`	`+ * Translation type class.`
`21`	`21`	`*`
`22`	`22`	`* @author Patrick Kaufmann`
`23`	`23`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@`
`14`	`14`	`class Column`
`15`	`15`	`{`
`16`	`16`	`private $name;`
`17`		`-`
`18`	`17`	`private $type;`
`19`	`18`
`20`	`19`	`public function __construct($name, $type)`
`@@ -35,13 +34,13 @@ public function isText()`
`35`	`34`	`}`
`36`	`35`
`37`	`36`	`switch ($this->type) {`
`38`		`- case \PropelColumnTypes::CHAR:`
`39`		`- case \PropelColumnTypes::VARCHAR:`
`40`		`- case \PropelColumnTypes::LONGVARCHAR:`
`41`		`- case \PropelColumnTypes::BLOB:`
`42`		`- case \PropelColumnTypes::CLOB:`
`43`		`- case \PropelColumnTypes::CLOB_EMU:`
`44`		`- return true;`
	`37`	`+ case \PropelColumnTypes::CHAR:`
	`38`	`+ case \PropelColumnTypes::VARCHAR:`
	`39`	`+ case \PropelColumnTypes::LONGVARCHAR:`
	`40`	`+ case \PropelColumnTypes::BLOB:`
	`41`	`+ case \PropelColumnTypes::CLOB:`
	`42`	`+ case \PropelColumnTypes::CLOB_EMU:`
	`43`	`+ return true;`
`45`	`44`	`}`
`46`	`45`
`47`	`46`	`return false;`
`@@ -54,6 +53,6 @@ public function getSize()`
`54`	`53`
`55`	`54`	`public function isNotNull()`
`56`	`55`	`{`
`57`		`- return ('id' === $this->name);`
	`56`	`+ return 'id' === $this->name;`
`58`	`57`	`}`
`59`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,16 +11,11 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Bridge\Propel1\Tests\Fixtures;`
`13`	`13`
`14`		`-use PropelPDO;`
`15`		`-`
`16`	`14`	`class Item implements \Persistent`
`17`	`15`	`{`
`18`	`16`	`private $id;`
`19`		`-`
`20`	`17`	`private $value;`
`21`		`-`
`22`	`18`	`private $groupName;`
`23`		`-`
`24`	`19`	`private $price;`
`25`	`20`
`26`	`21`	`public function __construct($id = null, $value = null, $groupName = null, $price = null)`
`@@ -98,11 +93,11 @@ public function setDeleted($b)`
`98`	`93`	`{`
`99`	`94`	`}`
`100`	`95`
`101`		`- public function delete(PropelPDO $con = null)`
	`96`	`+ public function delete(\PropelPDO $con = null)`
`102`	`97`	`{`
`103`	`98`	`}`
`104`	`99`
`105`		`- public function save(PropelPDO $con = null)`
	`100`	`+ public function save(\PropelPDO $con = null)`
`106`	`101`	`{`
`107`	`102`	`}`
`108`	`103`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,18 +11,12 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Bridge\Propel1\Tests\Fixtures;`
`13`	`13`
`14`		`-use PropelPDO;`
`15`		`-`
`16`	`14`	`class TranslatableItemI18n implements \Persistent`
`17`	`15`	`{`
`18`	`16`	`private $id;`
`19`		`-`
`20`	`17`	`private $locale;`
`21`		`-`
`22`	`18`	`private $value;`
`23`		`-`
`24`	`19`	`private $value2;`
`25`		`-`
`26`	`20`	`private $item;`
`27`	`21`
`28`	`22`	`public function __construct($id = null, $locale = null, $value = null)`
`@@ -84,11 +78,11 @@ public function setDeleted($b)`
`84`	`78`	`{`
`85`	`79`	`}`
`86`	`80`
`87`		`- public function delete(PropelPDO $con = null)`
	`81`	`+ public function delete(\PropelPDO $con = null)`
`88`	`82`	`{`
`89`	`83`	`}`
`90`	`84`
`91`		`- public function save(PropelPDO $con = null)`
	`85`	`+ public function save(\PropelPDO $con = null)`
`92`	`86`	`{`
`93`	`87`	`}`
`94`	`88`