Permalink
Browse files

fixed phpdoc @param alignment

  • Loading branch information...
1 parent e0526e5 commit 35682ae4d73680fefd7716dcccbca0b6d9fab787 @fabpot fabpot committed May 15, 2012
Showing with 144 additions and 144 deletions.
  1. +5 −5 AbstractType.php
  2. +2 −2 AbstractTypeExtension.php
  3. +4 −4 CallbackTransformer.php
  4. +2 −2 DataTransformerInterface.php
  5. +2 −2 Extension/Core/DataTransformer/ArrayToBooleanChoicesTransformer.php
  6. +2 −2 Extension/Core/DataTransformer/BooleanToStringTransformer.php
  7. +2 −2 Extension/Core/DataTransformer/DataTransformerChain.php
  8. +6 −6 Extension/Core/DataTransformer/DateTimeToArrayTransformer.php
  9. +8 −8 Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php
  10. +2 −2 Extension/Core/DataTransformer/DateTimeToStringTransformer.php
  11. +2 −2 Extension/Core/DataTransformer/DateTimeToTimestampTransformer.php
  12. +1 −1 Extension/Core/DataTransformer/MoneyToLocalizedStringTransformer.php
  13. +1 −1 Extension/Core/DataTransformer/NumberToLocalizedStringTransformer.php
  14. +2 −2 Extension/Core/DataTransformer/PercentToLocalizedStringTransformer.php
  15. +2 −2 Extension/Core/DataTransformer/ScalarToBooleanChoicesTransformer.php
  16. +1 −1 Extension/Csrf/CsrfProvider/CsrfProviderInterface.php
  17. +1 −1 Extension/Csrf/CsrfProvider/DefaultCsrfProvider.php
  18. +2 −2 Extension/Csrf/Type/FormTypeCsrfExtension.php
  19. +7 −7 Extension/Validator/ValidatorTypeGuesser.php
  20. +8 −8 Form.php
  21. +3 −3 FormBuilder.php
  22. +2 −2 FormError.php
  23. +22 −22 FormFactory.php
  24. +22 −22 FormFactoryInterface.php
  25. +1 −1 FormInterface.php
  26. +2 −2 FormTypeExtensionInterface.php
  27. +1 −1 FormTypeGuesserChain.php
  28. +8 −8 FormTypeGuesserInterface.php
  29. +5 −5 FormTypeInterface.php
  30. +2 −2 Guess/Guess.php
  31. +3 −3 Guess/TypeGuess.php
  32. +2 −2 Guess/ValueGuess.php
  33. +8 −8 Util/PropertyPath.php
  34. +1 −1 Util/PropertyPathIterator.php
View
@@ -30,8 +30,8 @@
*
* @see FormTypeExtensionInterface::buildForm()
*
- * @param FormBuilder $builder The form builder
- * @param array $options The options
+ * @param FormBuilder $builder The form builder
+ * @param array $options The options
*/
public function buildForm(FormBuilder $builder, array $options)
{
@@ -78,9 +78,9 @@ public function buildViewBottomUp(FormView $view, FormInterface $form)
* The builder is retrieved by going up in the type hierarchy when a type does
* not provide one.
*
- * @param string $name The name of the builder
- * @param FormFactoryInterface $factory The form factory
- * @param array $options The options
+ * @param string $name The name of the builder
+ * @param FormFactoryInterface $factory The form factory
+ * @param array $options The options
*
* @return FormBuilder|null A form builder or null when the type does not have a builder
*/
@@ -21,8 +21,8 @@
*
* @see FormTypeInterface::buildForm()
*
- * @param FormBuilder $builder The form builder
- * @param array $options The options
+ * @param FormBuilder $builder The form builder
+ * @param array $options The options
*/
public function buildForm(FormBuilder $builder, array $options)
{
View
@@ -28,8 +28,8 @@ class CallbackTransformer implements DataTransformerInterface
/**
* Constructor.
*
- * @param \Closure $transform The forward transform callback
- * @param \Closure $reverseTransform The reverse transform callback
+ * @param \Closure $transform The forward transform callback
+ * @param \Closure $reverseTransform The reverse transform callback
*/
public function __construct(\Closure $transform, \Closure $reverseTransform)
{
@@ -40,7 +40,7 @@ public function __construct(\Closure $transform, \Closure $reverseTransform)
/**
* Transforms a value from the original representation to a transformed representation.
*
- * @param mixed $data The value in the original representation
+ * @param mixed $data The value in the original representation
*
* @return mixed The value in the transformed representation
*
@@ -56,7 +56,7 @@ public function transform($data)
* Transforms a value from the transformed representation to its original
* representation.
*
- * @param mixed $data The value in the transformed representation
+ * @param mixed $data The value in the transformed representation
*
* @return mixed The value in the original representation
*
@@ -39,7 +39,7 @@
* By convention, transform() should return an empty string if NULL is
* passed.
*
- * @param mixed $value The value in the original representation
+ * @param mixed $value The value in the original representation
*
* @return mixed The value in the transformed representation
*
@@ -66,7 +66,7 @@ function transform($value);
* By convention, reverseTransform() should return NULL if an empty string
* is passed.
*
- * @param mixed $value The value in the transformed representation
+ * @param mixed $value The value in the transformed representation
*
* @return mixed The value in the original representation
*
@@ -33,7 +33,7 @@ public function __construct(ChoiceListInterface $choiceList)
* depending on whether a given option is selected. If this field is rendered
* as select tag, the value is not modified.
*
- * @param mixed $array An array
+ * @param mixed $array An array
*
* @return mixed An array
*
@@ -70,7 +70,7 @@ public function transform($array)
* values, depending on whether a given choice is selected. The output
* is an array with the selected choices.
*
- * @param mixed $value An array
+ * @param mixed $value An array
*
* @return mixed $value An array
*
@@ -25,7 +25,7 @@ class BooleanToStringTransformer implements DataTransformerInterface
/**
* Transforms a Boolean into a string.
*
- * @param Boolean $value Boolean value.
+ * @param Boolean $value Boolean value.
*
* @return string String value.
*
@@ -47,7 +47,7 @@ public function transform($value)
/**
* Transforms a string into a Boolean.
*
- * @param string $value String value.
+ * @param string $value String value.
*
* @return Boolean Boolean value.
*
@@ -44,7 +44,7 @@ public function __construct(array $transformers)
* transformer as input. The output of the last transformer is returned
* by this method.
*
- * @param mixed $value The original value
+ * @param mixed $value The original value
*
* @return mixed The transformed value
*
@@ -69,7 +69,7 @@ public function transform($value)
* transformer as input. The output of the last transformer is returned
* by this method.
*
- * @param mixed $value The transformed value
+ * @param mixed $value The transformed value
*
* @return mixed The reverse-transformed value
*
@@ -29,10 +29,10 @@ class DateTimeToArrayTransformer extends BaseDateTimeTransformer
/**
* Constructor.
*
- * @param string $inputTimezone The input timezone
- * @param string $outputTimezone The output timezone
- * @param array $fields The date fields
- * @param Boolean $pad Whether to use padding
+ * @param string $inputTimezone The input timezone
+ * @param string $outputTimezone The output timezone
+ * @param array $fields The date fields
+ * @param Boolean $pad Whether to use padding
*
* @throws UnexpectedTypeException if a timezone is not a string
*/
@@ -51,7 +51,7 @@ public function __construct($inputTimezone = null, $outputTimezone = null, array
/**
* Transforms a normalized date into a localized date.
*
- * @param DateTime $dateTime Normalized date.
+ * @param DateTime $dateTime Normalized date.
*
* @return array Localized date.
*
@@ -106,7 +106,7 @@ public function transform($dateTime)
/**
* Transforms a localized date into a normalized date.
*
- * @param array $value Localized date
+ * @param array $value Localized date
*
* @return DateTime Normalized date
*
@@ -32,12 +32,12 @@ class DateTimeToLocalizedStringTransformer extends BaseDateTimeTransformer
*
* @see BaseDateTimeTransformer::formats for available format options
*
- * @param string $inputTimezone The name of the input timezone
- * @param string $outputTimezone The name of the output timezone
- * @param integer $dateFormat The date format
- * @param integer $timeFormat The time format
- * @param \IntlDateFormatter $calendar An \IntlDateFormatter instance
- * @param string $pattern A pattern to pass to \IntlDateFormatter
+ * @param string $inputTimezone The name of the input timezone
+ * @param string $outputTimezone The name of the output timezone
+ * @param integer $dateFormat The date format
+ * @param integer $timeFormat The time format
+ * @param \IntlDateFormatter $calendar An \IntlDateFormatter instance
+ * @param string $pattern A pattern to pass to \IntlDateFormatter
*
* @throws UnexpectedTypeException If a format is not supported
* @throws UnexpectedTypeException if a timezone is not a string
@@ -71,7 +71,7 @@ public function __construct($inputTimezone = null, $outputTimezone = null, $date
/**
* Transforms a normalized date into a localized date string/array.
*
- * @param DateTime $dateTime Normalized date.
+ * @param DateTime $dateTime Normalized date.
*
* @return string|array Localized date string/array.
*
@@ -106,7 +106,7 @@ public function transform($dateTime)
/**
* Transforms a localized date string/array into a normalized date.
*
- * @param string|array $value Localized date string/array
+ * @param string|array $value Localized date string/array
*
* @return DateTime Normalized date
*
@@ -46,7 +46,7 @@ public function __construct($inputTimezone = null, $outputTimezone = null, $form
* Transforms a DateTime object into a date string with the configured format
* and timezone
*
- * @param DateTime $value A DateTime object
+ * @param DateTime $value A DateTime object
*
* @return string A value as produced by PHP's date() function
*
@@ -76,7 +76,7 @@ public function transform($value)
/**
* Transforms a date string in the configured timezone into a DateTime object.
*
- * @param string $value A value as produced by PHP's date() function
+ * @param string $value A value as produced by PHP's date() function
*
* @return \DateTime An instance of \DateTime
*
@@ -25,7 +25,7 @@ class DateTimeToTimestampTransformer extends BaseDateTimeTransformer
/**
* Transforms a DateTime object into a timestamp in the configured timezone.
*
- * @param DateTime $value A DateTime object
+ * @param DateTime $value A DateTime object
*
* @return integer A timestamp
*
@@ -55,7 +55,7 @@ public function transform($value)
/**
* Transforms a timestamp in the configured timezone into a DateTime object
*
- * @param string $value A timestamp
+ * @param string $value A timestamp
*
* @return \DateTime An instance of \DateTime
*
@@ -46,7 +46,7 @@ public function __construct($precision = null, $grouping = null, $roundingMode =
/**
* Transforms a normalized format into a localized money string.
*
- * @param number $value Normalized number
+ * @param number $value Normalized number
*
* @return string Localized money string.
*
@@ -56,7 +56,7 @@ public function __construct($precision = null, $grouping = null, $roundingMode =
/**
* Transforms a number type into localized number.
*
- * @param integer|float $value Number value.
+ * @param integer|float $value Number value.
*
* @return string Localized value.
*
@@ -64,7 +64,7 @@ public function __construct($precision = null, $type = null)
/**
* Transforms between a normalized format (integer or float) into a percentage value.
*
- * @param number $value Normalized value
+ * @param number $value Normalized value
*
* @return number Percentage value
*
@@ -99,7 +99,7 @@ public function transform($value)
/**
* Transforms between a percentage value into a normalized format (integer or float).
*
- * @param number $value Percentage value.
+ * @param number $value Percentage value.
*
* @return number Normalized value.
*
@@ -39,7 +39,7 @@ public function __construct(ChoiceListInterface $choiceList)
* depending on whether a given option is selected. If this field is rendered
* as select tag, the value is not modified.
*
- * @param mixed $value An array if "multiple" is set to true, a scalar
+ * @param mixed $value An array if "multiple" is set to true, a scalar
* value otherwise.
*
* @return mixed An array
@@ -74,7 +74,7 @@ public function transform($value)
* values, depending on whether a given choice is selected. The output
* is the selected choice.
*
- * @param array $value An array of values
+ * @param array $value An array of values
*
* @return mixed $value A scalar value
*
@@ -41,7 +41,7 @@ public function generateCsrfToken($intention);
* Validates a CSRF token.
*
* @param string $intention The intention used when generating the CSRF token
- * @param string $token The token supplied by the browser
+ * @param string $token The token supplied by the browser
*
* @return Boolean Whether the token supplied by the browser is correct
*/
@@ -33,7 +33,7 @@ class DefaultCsrfProvider implements CsrfProviderInterface
* A recommended value for the secret is a generated value with at least
* 32 characters and mixed letters, digits and special characters.
*
- * @param string $secret A secret value included in the CSRF token
+ * @param string $secret A secret value included in the CSRF token
*/
public function __construct($secret)
{
@@ -32,8 +32,8 @@ public function __construct($enabled = true, $fieldName = '_token')
/**
* Adds a CSRF field to the form when the CSRF protection is enabled.
*
- * @param FormBuilder $builder The form builder
- * @param array $options The options
+ * @param FormBuilder $builder The form builder
+ * @param array $options The options
*/
public function buildForm(FormBuilder $builder, array $options)
{
@@ -78,7 +78,7 @@ public function guessMinLength($class, $property)
/**
* Guesses a field class name for a given constraint
*
- * @param Constraint $constraint The constraint to guess for
+ * @param Constraint $constraint The constraint to guess for
*
* @return TypeGuess The guessed field class and options
*/
@@ -227,7 +227,7 @@ public function guessTypeForConstraint(Constraint $constraint)
/**
* Guesses whether a field is required based on the given constraint
*
- * @param Constraint $constraint The constraint to guess for
+ * @param Constraint $constraint The constraint to guess for
*
* @return Guess The guess whether the field is required
*/
@@ -255,7 +255,7 @@ public function guessRequiredForConstraint(Constraint $constraint)
/**
* Guesses a field's maximum length based on the given constraint
*
- * @param Constraint $constraint The constraint to guess for
+ * @param Constraint $constraint The constraint to guess for
*
* @return Guess The guess for the maximum length
*/
@@ -278,7 +278,7 @@ public function guessMaxLengthForConstraint(Constraint $constraint)
/**
* Guesses a field's minimum length based on the given constraint
*
- * @param Constraint $constraint The constraint to guess for
+ * @param Constraint $constraint The constraint to guess for
*
* @return Guess The guess for the minimum length
*/
@@ -302,9 +302,9 @@ public function guessMinLengthForConstraint(Constraint $constraint)
* Iterates over the constraints of a property, executes a constraints on
* them and returns the best guess
*
- * @param string $class The class to read the constraints from
- * @param string $property The property for which to find constraints
- * @param \Closure $guessForConstraint The closure that returns a guess
+ * @param string $class The class to read the constraints from
+ * @param string $property The property for which to find constraints
+ * @param \Closure $guessForConstraint The closure that returns a guess
* for a given constraint
* @return Guess The guessed value with the highest confidence
*/
Oops, something went wrong.

0 comments on commit 35682ae

Please sign in to comment.