minor #18113 [Validator] Updating inaccurate docblock comment (natechicago)

nicolas-grekas · nicolas-grekas · commit a90818546b14 · 2016-03-15T13:41:46.000+01:00
This PR was merged into the 2.3 branch. Discussion ---------- [Validator] Updating inaccurate docblock comment | Q | A | ------------- | --- | Branch | 2.3 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a The formatValue() docblock refers to a $prettyDateTime argument, which does not exist. Instead, it should refer to the $format argument. I'm also adding parentheses around the `$format & self::OBJECT_TO_STRING` expression on line 102 so it is formatted similarly to the `($format & self::PRETTY_DATE)` expression a few lines above it. Commits ------- a784743 [Validator] Updating inaccurate docblock comment
diff --git a/src/Symfony/Component/Validator/ConstraintValidator.php b/src/Symfony/Component/Validator/ConstraintValidator.php
@@ -69,9 +69,9 @@ protected function formatTypeOf($value)
      * This method returns the equivalent PHP tokens for most scalar types
      * (i.e. "false" for false, "1" for 1 etc.). Strings are always wrapped
      * in double quotes ("). Objects, arrays and resources are formatted as
-     * "object", "array" and "resource". If the parameter $prettyDateTime
-     * is set to true, {@link \DateTime} objects will be formatted as
-     * RFC-3339 dates ("Y-m-d H:i:s").
+     * "object", "array" and "resource". If the $format bitmask contains
+     * the PRETTY_DATE bit, then {@link \DateTime} objects will be formatted 
+     * as RFC-3339 dates ("Y-m-d H:i:s").
      *
      * Be careful when passing message parameters to a constraint violation
      * that (may) contain objects, arrays or resources. These parameters
@@ -99,7 +99,7 @@ protected function formatValue($value, $format = 0)
         }
 
         if (is_object($value)) {
-            if ($format & self::OBJECT_TO_STRING && method_exists($value, '__toString')) {
+            if (($format & self::OBJECT_TO_STRING) && method_exists($value, '__toString')) {
                 return $value->__toString();
             }
 

Original file line number	Diff line number	Diff line change
`@@ -69,9 +69,9 @@ protected function formatTypeOf($value)`
`69`	`69`	`* This method returns the equivalent PHP tokens for most scalar types`
`70`	`70`	`* (i.e. "false" for false, "1" for 1 etc.). Strings are always wrapped`
`71`	`71`	`* in double quotes ("). Objects, arrays and resources are formatted as`
`72`		`- * "object", "array" and "resource". If the parameter $prettyDateTime`
`73`		`- * is set to true, {@link \DateTime} objects will be formatted as`
`74`		`- * RFC-3339 dates ("Y-m-d H:i:s").`
	`72`	`+ * "object", "array" and "resource". If the $format bitmask contains`
	`73`	`+ * the PRETTY_DATE bit, then {@link \DateTime} objects will be formatted`
	`74`	`+ * as RFC-3339 dates ("Y-m-d H:i:s").`
`75`	`75`	`*`
`76`	`76`	`* Be careful when passing message parameters to a constraint violation`
`77`	`77`	`* that (may) contain objects, arrays or resources. These parameters`
`@@ -99,7 +99,7 @@ protected function formatValue($value, $format = 0)`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`if (is_object($value)) {`
`102`		`- if ($format & self::OBJECT_TO_STRING && method_exists($value, '__toString')) {`
	`102`	`+ if (($format & self::OBJECT_TO_STRING) && method_exists($value, '__toString')) {`
`103`	`103`	`return $value->__toString();`
`104`	`104`	`}`
`105`	`105`