minor #18113 [Validator] Updating inaccurate docblock comment (natechicago)
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
This commit is contained in:
commit
a90818546b
@ -69,9 +69,9 @@ abstract class ConstraintValidator implements ConstraintValidatorInterface
|
||||
* 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 @@ abstract class ConstraintValidator implements ConstraintValidatorInterface
|
||||
}
|
||||
|
||||
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();
|
||||
}
|
||||
|
||||
|
Reference in New Issue
Block a user