[2.3] CS And DocBlock Fixes

symfony · Dec 22, 2014 · 1082181 · 1082181
1 parent 7eecc50
commit 1082181
Show file tree

Hide file tree

Showing 45 changed files with 150 additions and 128 deletions.
diff --git a/AbstractExtension.php b/AbstractExtension.php
@@ -20,25 +20,29 @@
 abstract class AbstractExtension implements FormExtensionInterface
 {
     /**
-     * The types provided by this extension
+     * The types provided by this extension.
+     *
      * @var FormTypeInterface[] An array of FormTypeInterface
      */
     private $types;
 
     /**
-     * The type extensions provided by this extension
+     * The type extensions provided by this extension.
+     *
      * @var FormTypeExtensionInterface[] An array of FormTypeExtensionInterface
      */
     private $typeExtensions;
 
     /**
-     * The type guesser provided by this extension
+     * The type guesser provided by this extension.
+     *
      * @var FormTypeGuesserInterface
      */
     private $typeGuesser;
 
     /**
-     * Whether the type guesser has been loaded
+     * Whether the type guesser has been loaded.
+     *
      * @var bool
      */
     private $typeGuesserLoaded = false;

diff --git a/Button.php b/Button.php
@@ -206,26 +206,20 @@ public function setData($modelData)
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getData()
     {
     }
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getNormData()
     {
     }
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getViewData()
     {
@@ -273,8 +267,6 @@ public function getName()
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getPropertyPath()
     {

diff --git a/ButtonBuilder.php b/ButtonBuilder.php
@@ -544,8 +544,6 @@ public function getFormConfig()
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getEventDispatcher()
     {
@@ -561,8 +559,6 @@ public function getName()
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getPropertyPath()
     {
@@ -640,8 +636,6 @@ public function getModelTransformers()
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getDataMapper()
     {
@@ -679,8 +673,6 @@ public function getErrorBubbling()
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getEmptyData()
     {
@@ -723,17 +715,13 @@ public function getAttribute($name, $default = null)
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getData()
     {
     }
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getDataClass()
     {
@@ -751,35 +739,27 @@ public function getDataLocked()
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getFormFactory()
     {
     }
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getAction()
     {
     }
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getMethod()
     {
     }
 
     /**
      * Unsupported method.
-     *
-     * @return null Always returns null.
      */
     public function getRequestHandler()
     {

diff --git a/CallbackTransformer.php b/CallbackTransformer.php
@@ -17,13 +17,15 @@
 class CallbackTransformer implements DataTransformerInterface
 {
     /**
-     * The callback used for forward transform
+     * The callback used for forward transform.
+     *
      * @var callable
      */
     private $transform;
 
     /**
-     * The callback used for reverse transform
+     * The callback used for reverse transform.
+     *
      * @var callable
      */
     private $reverseTransform;

diff --git a/Extension/Core/ChoiceList/ChoiceListInterface.php b/Extension/Core/ChoiceList/ChoiceListInterface.php
@@ -29,14 +29,14 @@
 interface ChoiceListInterface
 {
     /**
-     * Returns the list of choices
+     * Returns the list of choices.
      *
      * @return array The choices with their indices as keys
      */
     public function getChoices();
 
     /**
-     * Returns the values for the choices
+     * Returns the values for the choices.
      *
      * @return array The values with the corresponding choice indices as keys
      */

diff --git a/Extension/Core/ChoiceList/LazyChoiceList.php b/Extension/Core/ChoiceList/LazyChoiceList.php
@@ -14,7 +14,7 @@
 use Symfony\Component\Form\Exception\InvalidArgumentException;
 
 /**
- * A choice list that is loaded lazily
+ * A choice list that is loaded lazily.
  *
  * This list loads itself as soon as any of the getters is accessed for the
  * first time. You should implement loadChoiceList() in your child classes,
@@ -25,7 +25,7 @@
 abstract class LazyChoiceList implements ChoiceListInterface
 {
     /**
-     * The loaded choice list
+     * The loaded choice list.
      *
      * @var ChoiceListInterface
      */
@@ -128,7 +128,7 @@ public function getIndicesForValues(array $values)
     }
 
     /**
-     * Loads the choice list
+     * Loads the choice list.
      *
      * Should be implemented by child classes.
      *

diff --git a/Extension/Core/DataTransformer/BooleanToStringTransformer.php b/Extension/Core/DataTransformer/BooleanToStringTransformer.php
@@ -23,7 +23,8 @@
 class BooleanToStringTransformer implements DataTransformerInterface
 {
     /**
-     * The value emitted upon transform if the input is true
+     * The value emitted upon transform if the input is true.
+     *
      * @var string
      */
     private $trueValue;

diff --git a/Extension/Core/DataTransformer/DataTransformerChain.php b/Extension/Core/DataTransformer/DataTransformerChain.php
@@ -15,20 +15,21 @@
 use Symfony\Component\Form\Exception\TransformationFailedException;
 
 /**
- * Passes a value through multiple value transformers
+ * Passes a value through multiple value transformers.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
 class DataTransformerChain implements DataTransformerInterface
 {
     /**
-     * The value transformers
+     * The value transformers.
+     *
      * @var DataTransformerInterface[]
      */
     protected $transformers;
 
     /**
-     * Uses the given value transformers to transform values
+     * Uses the given value transformers to transform values.
      *
      * @param array $transformers
      */
@@ -38,7 +39,7 @@ public function __construct(array $transformers)
     }
 
     /**
-     * Passes the value through the transform() method of all nested transformers
+     * Passes the value through the transform() method of all nested transformers.
      *
      * The transformers receive the value in the same order as they were passed
      * to the constructor. Each transformer receives the result of the previous
@@ -62,7 +63,7 @@ public function transform($value)
 
     /**
      * Passes the value through the reverseTransform() method of all nested
-     * transformers
+     * transformers.
      *
      * The transformers receive the value in the reverse order as they were passed
      * to the constructor. Each transformer receives the result of the previous

diff --git a/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php b/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php
@@ -15,7 +15,7 @@
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
 
 /**
- * Transforms between a normalized time and a localized time string
+ * Transforms between a normalized time and a localized time string.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
@@ -149,7 +149,7 @@ public function reverseTransform($value)
     }
 
     /**
-     * Returns a preconfigured IntlDateFormatter instance
+     * Returns a preconfigured IntlDateFormatter instance.
      *
      * @return \IntlDateFormatter
      *

diff --git a/Extension/Core/DataTransformer/DateTimeToStringTransformer.php b/Extension/Core/DataTransformer/DateTimeToStringTransformer.php
@@ -15,21 +15,22 @@
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
 
 /**
- * Transforms between a date string and a DateTime object
+ * Transforms between a date string and a DateTime object.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
  */
 class DateTimeToStringTransformer extends BaseDateTimeTransformer
 {
     /**
-     * Format used for generating strings
+     * Format used for generating strings.
+     *
      * @var string
      */
     private $generateFormat;
 
     /**
-     * Format used for parsing strings
+     * Format used for parsing strings.
      *
      * Different than the {@link $generateFormat} because formats for parsing
      * support additional characters in PHP that are not supported for
@@ -49,7 +50,7 @@ class DateTimeToStringTransformer extends BaseDateTimeTransformer
     private $parseUsingPipe;
 
     /**
-     * Transforms a \DateTime instance to a string
+     * Transforms a \DateTime instance to a string.
      *
      * @see \DateTime::format() for supported formats
      *
@@ -87,7 +88,7 @@ public function __construct($inputTimezone = null, $outputTimezone = null, $form
 
     /**
      * Transforms a DateTime object into a date string with the configured format
-     * and timezone
+     * and timezone.
      *
      * @param \DateTime $value A DateTime object
      *

diff --git a/Extension/Core/DataTransformer/DateTimeToTimestampTransformer.php b/Extension/Core/DataTransformer/DateTimeToTimestampTransformer.php
@@ -14,7 +14,7 @@
 use Symfony\Component\Form\Exception\TransformationFailedException;
 
 /**
- * Transforms between a timestamp and a DateTime object
+ * Transforms between a timestamp and a DateTime object.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
@@ -53,7 +53,7 @@ public function transform($value)
     }
 
     /**
-     * Transforms a timestamp in the configured timezone into a DateTime object
+     * Transforms a timestamp in the configured timezone into a DateTime object.
      *
      * @param string $value A timestamp
      *

diff --git a/Extension/Core/DataTransformer/NumberToLocalizedStringTransformer.php b/Extension/Core/DataTransformer/NumberToLocalizedStringTransformer.php
@@ -86,7 +86,7 @@ public function transform($value)
     }
 
     /**
-     * Transforms a localized number into an integer or float
+     * Transforms a localized number into an integer or float.
      *
      * @param string $value The localized value
      *
@@ -158,7 +158,7 @@ public function reverseTransform($value)
     }
 
     /**
-     * Returns a preconfigured \NumberFormatter instance
+     * Returns a preconfigured \NumberFormatter instance.
      *
      * @return \NumberFormatter
      */

diff --git a/Extension/Core/DataTransformer/PercentToLocalizedStringTransformer.php b/Extension/Core/DataTransformer/PercentToLocalizedStringTransformer.php
@@ -134,7 +134,7 @@ public function reverseTransform($value)
     }
 
     /**
-     * Returns a preconfigured \NumberFormatter instance
+     * Returns a preconfigured \NumberFormatter instance.
      *
      * @return \NumberFormatter
      */

diff --git a/Extension/Core/EventListener/MergeCollectionListener.php b/Extension/Core/EventListener/MergeCollectionListener.php
@@ -22,13 +22,15 @@
 class MergeCollectionListener implements EventSubscriberInterface
 {
     /**
-     * Whether elements may be added to the collection
+     * Whether elements may be added to the collection.
+     *
      * @var bool
      */
     private $allowAdd;
 
     /**
-     * Whether elements may be removed from the collection
+     * Whether elements may be removed from the collection.
+     *
      * @var bool
      */
     private $allowDelete;