[2.3] CS And DocBlock Fixes

Author: GrahamCampbell

Constraint.php

@@ -31,19 +31,22 @@
 abstract class Constraint
 {
     /**
-     * The name of the group given to all constraints with no explicit group
+     * The name of the group given to all constraints with no explicit group.
+     *
      * @var string
      */
     const DEFAULT_GROUP = 'Default';
 
     /**
-     * Marks a constraint that can be put onto classes
+     * Marks a constraint that can be put onto classes.
+     *
      * @var string
      */
     const CLASS_CONSTRAINT = 'class';
 
     /**
-     * Marks a constraint that can be put onto properties
+     * Marks a constraint that can be put onto properties.
+     *
      * @var string
      */
     const PROPERTY_CONSTRAINT = 'property';
@@ -143,7 +146,7 @@ public function __set($option, $value)
     }
 
     /**
-     * Adds the given group if this constraint is in the Default group
+     * Adds the given group if this constraint is in the Default group.
      *
      * @param string $group
      *
@@ -157,11 +160,12 @@ public function addImplicitGroupName($group)
     }
 
     /**
-     * Returns the name of the default option
+     * Returns the name of the default option.
      *
      * Override this method to define a default option.
      *
      * @return string
+     *
      * @see __construct()
      *
      * @api
@@ -171,11 +175,12 @@ public function getDefaultOption()
     }
 
     /**
-     * Returns the name of the required options
+     * Returns the name of the required options.
      *
      * Override this method if you want to define required options.
      *
      * @return array
+     *
      * @see __construct()
      *
      * @api
@@ -186,7 +191,7 @@ public function getRequiredOptions()
     }
 
     /**
-     * Returns the name of the class that validates this constraint
+     * Returns the name of the class that validates this constraint.
      *
      * By default, this is the fully qualified name of the constraint class
      * suffixed with "Validator". You can override this method to change that
@@ -203,7 +208,7 @@ public function validatedBy()
 
     /**
      * Returns whether the constraint can be put onto classes, properties or
-     * both
+     * both.
      *
      * This method should return one or more of the constants
      * Constraint::CLASS_CONSTRAINT and Constraint::PROPERTY_CONSTRAINT.

ConstraintValidator.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Validator;
 
 /**
- * Base class for constraint validators
+ * Base class for constraint validators.
  *
  * @author Bernhard Schussek <[email protected]>
  *

Constraints/AbstractComparisonValidator.php

@@ -40,7 +40,7 @@ public function validate($value, Constraint $constraint)
     }
 
     /**
-     * Compares the two given values to find if their relationship is valid
+     * Compares the two given values to find if their relationship is valid.
      *
      * @param mixed $value1 The first value to compare
      * @param mixed $value2 The second value to compare

Constraints/CallbackValidator.php

@@ -17,7 +17,7 @@
 use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
 
 /**
- * Validator for Callback constraint
+ * Validator for Callback constraint.
  *
  * @author Bernhard Schussek <[email protected]>
  *

Constraints/CardSchemeValidator.php

@@ -19,6 +19,7 @@
  *
  * @see http://en.wikipedia.org/wiki/Bank_card_number
  * @see http://www.regular-expressions.info/creditcard.html
+ *
  * @author Tim Nagel <[email protected]>
  */
 class CardSchemeValidator extends ConstraintValidator
@@ -47,7 +48,7 @@ class CardSchemeValidator extends ConstraintValidator
         ),
         /**
          * Discover card numbers begin with 6011, 622126 through 622925, 644 through 649 or 65.
-         * All have 16 digits
+         * All have 16 digits.
          */
         'DISCOVER' => array(
             '/^6011[0-9]{12}$/',
@@ -56,7 +57,7 @@ class CardSchemeValidator extends ConstraintValidator
             '/^622(12[6-9]|1[3-9][0-9]|[2-8][0-9][0-9]|91[0-9]|92[0-5])[0-9]{10}$/',
         ),
         /**
-         * InstaPayment cards begin with 637 through 639 and have 16 digits
+         * InstaPayment cards begin with 637 through 639 and have 16 digits.
          */
         'INSTAPAYMENT' => array(
             '/^63[7-9][0-9]{13}$/',
@@ -69,14 +70,14 @@ class CardSchemeValidator extends ConstraintValidator
             '/^(?:2131|1800|35[0-9]{3})[0-9]{11}$/',
         ),
         /**
-         * Laser cards begin with either 6304, 6706, 6709 or 6771 and have between 16 and 19 digits
+         * Laser cards begin with either 6304, 6706, 6709 or 6771 and have between 16 and 19 digits.
          */
         'LASER' => array(
             '/^(6304|670[69]|6771)[0-9]{12,15}$/',
         ),
         /**
          * Maestro cards begin with either 5018, 5020, 5038, 5893, 6304, 6759, 6761, 6762, 6763 or 0604
-         * They have between 12 and 19 digits
+         * They have between 12 and 19 digits.
          */
         'MAESTRO' => array(
             '/^(5018|5020|5038|6304|6759|6761|676[23]|0604)[0-9]{8,15}$/',

Constraints/CountryValidator.php

@@ -17,7 +17,7 @@
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
- * Validates whether a value is a valid country code
+ * Validates whether a value is a valid country code.
  *
  * @author Bernhard Schussek <[email protected]>
  *

Constraints/CurrencyValidator.php

@@ -17,7 +17,7 @@
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
- * Validates whether a value is a valid currency
+ * Validates whether a value is a valid currency.
  *
  * @author Miha Vrhovnik <[email protected]>
  *

Constraints/GroupSequence.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Validator\Constraints;
 
 /**
- * Annotation for group sequences
+ * Annotation for group sequences.
  *
  * @Annotation
  * @Target({"CLASS", "ANNOTATION"})
@@ -24,7 +24,8 @@
 class GroupSequence
 {
     /**
-     * The members of the sequence
+     * The members of the sequence.
+     *
      * @var array
      */
     public $groups;

Constraints/GroupSequenceProvider.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Validator\Constraints;
 
 /**
- * Annotation to define a group sequence provider
+ * Annotation to define a group sequence provider.
  *
  * @Annotation
  * @Target({"CLASS", "ANNOTATION"})

Constraints/IbanValidator.php

@@ -19,6 +19,7 @@
  * @author Manuel Reinhard <[email protected]>
  * @author Michael Schummel
  * @author Bernhard Schussek <[email protected]>
+ *
  * @link http://www.michael-schummel.de/2007/10/05/iban-prufung-mit-php/
  */
 class IbanValidator extends ConstraintValidator

Constraints/ImageValidator.php

@@ -16,7 +16,7 @@
 
 /**
  * Validates whether a value is a valid image file and is valid
- * against minWidth, maxWidth, minHeight and maxHeight constraints
+ * against minWidth, maxWidth, minHeight and maxHeight constraints.
  *
  * @author Benjamin Dulau <[email protected]>
  */

Constraints/Ip.php

@@ -15,7 +15,7 @@
 use Symfony\Component\Validator\Constraint;
 
 /**
- * Validates that a value is a valid IP address
+ * Validates that a value is a valid IP address.
  *
  * @Annotation
  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})

Constraints/IpValidator.php

@@ -16,7 +16,7 @@
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
- * Validates whether a value is a valid IP address
+ * Validates whether a value is a valid IP address.
  *
  * @author Bernhard Schussek <[email protected]>
  * @author Joseph Bielawski <[email protected]>

Constraints/LanguageValidator.php

@@ -17,7 +17,7 @@
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
- * Validates whether a value is a valid language code
+ * Validates whether a value is a valid language code.
  *
  * @author Bernhard Schussek <[email protected]>
  *

Constraints/LocaleValidator.php

@@ -17,7 +17,7 @@
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
- * Validates whether a value is a valid locale code
+ * Validates whether a value is a valid locale code.
  *
  * @author Bernhard Schussek <[email protected]>
  *

Constraints/LuhnValidator.php

@@ -16,12 +16,13 @@
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
- * Validates a PAN using the LUHN Algorithm
+ * Validates a PAN using the LUHN Algorithm.
  *
  * For a list of example card numbers that are used to test this
  * class, please see the LuhnValidatorTest class.
  *
  * @see    http://en.wikipedia.org/wiki/Luhn_algorithm
+ *
  * @author Tim Nagel <[email protected]>
  * @author Greg Knapp http://gregk.me/2011/php-implementation-of-bank-card-luhn-algorithm/
  * @author Bernhard Schussek <[email protected]>

Constraints/Regex.php

@@ -47,7 +47,7 @@ public function getRequiredOptions()
     /**
      * Converts the htmlPattern to a suitable format for HTML5 pattern.
      * Example: /^[a-z]+$/ would be converted to [a-z]+
-     * However, if options are specified, it cannot be converted
+     * However, if options are specified, it cannot be converted.
      *
      * Pattern is also ignored if match=false since the pattern should
      * then be reversed before application.

Constraints/RegexValidator.php

@@ -16,7 +16,7 @@
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
- * Validates whether a value match or not given regexp pattern
+ * Validates whether a value match or not given regexp pattern.
  *
  * @author Bernhard Schussek <[email protected]>
  * @author Joseph Bielawski <[email protected]>

Mapping/Cache/CacheInterface.php

@@ -14,21 +14,21 @@
 use Symfony\Component\Validator\Mapping\ClassMetadata;
 
 /**
- * Persists ClassMetadata instances in a cache
+ * Persists ClassMetadata instances in a cache.
  *
  * @author Bernhard Schussek <[email protected]>
  */
 interface CacheInterface
 {
     /**
-     * Returns whether metadata for the given class exists in the cache
+     * Returns whether metadata for the given class exists in the cache.
      *
      * @param string $class
      */
     public function has($class);
 
     /**
-     * Returns the metadata for the given class from the cache
+     * Returns the metadata for the given class from the cache.
      *
      * @param string $class Class Name
      *
@@ -37,7 +37,7 @@ public function has($class);
     public function read($class);
 
     /**
-     * Stores a class metadata in the cache
+     * Stores a class metadata in the cache.
      *
      * @param ClassMetadata $metadata A Class Metadata
      */

Mapping/ClassMetadata.php

@@ -68,7 +68,7 @@ class ClassMetadata extends ElementMetadata implements MetadataInterface, ClassB
     private $reflClass;
 
     /**
-     * Constructs a metadata for the given class
+     * Constructs a metadata for the given class.
      *
      * @param string $class
      */
@@ -118,7 +118,7 @@ public function accept(ValidationVisitorInterface $visitor, $value, $group, $pro
     }
 
     /**
-     * Returns the properties to be serialized
+     * Returns the properties to be serialized.
      *
      * @return array
      */
@@ -136,7 +136,7 @@ public function __sleep()
     }
 
     /**
-     * Returns the fully qualified name of the class
+     * Returns the fully qualified name of the class.
      *
      * @return string The fully qualified class name
      */
@@ -146,7 +146,7 @@ public function getClassName()
     }
 
     /**
-     * Returns the name of the default group for this class
+     * Returns the name of the default group for this class.
      *
      * For each class, the group "Default" is an alias for the group
      * "<ClassName>", where <ClassName> is the non-namespaced name of the

Mapping/ClassMetadataFactory.php

@@ -24,13 +24,15 @@
 class ClassMetadataFactory implements MetadataFactoryInterface
 {
     /**
-     * The loader for loading the class metadata
+     * The loader for loading the class metadata.
+     *
      * @var LoaderInterface
      */
     protected $loader;
 
     /**
-     * The cache for caching class metadata
+     * The cache for caching class metadata.
+     *
      * @var CacheInterface
      */
     protected $cache;

Mapping/Loader/AbstractLoader.php

@@ -17,7 +17,8 @@
 abstract class AbstractLoader implements LoaderInterface
 {
     /**
-     * Contains all known namespaces indexed by their prefix
+     * Contains all known namespaces indexed by their prefix.
+     *
      * @var array
      */
     protected $namespaces;

Mapping/Loader/LoaderChain.php

@@ -15,7 +15,7 @@
 use Symfony\Component\Validator\Mapping\ClassMetadata;
 
 /**
- * Calls multiple LoaderInterface instances in a chain
+ * Calls multiple LoaderInterface instances in a chain.
  *
  * This class accepts multiple instances of LoaderInterface to be passed to the
  * constructor. When loadClassMetadata() is called, the same method is called
@@ -29,7 +29,7 @@ class LoaderChain implements LoaderInterface
     protected $loaders;
 
     /**
-     * Accepts a list of LoaderInterface instances
+     * Accepts a list of LoaderInterface instances.
      *
      * @param LoaderInterface[] $loaders An array of LoaderInterface instances
      *