[FrameworkBundle] Added friendly exception when constraint validator class does not exist #19601
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
234116b to
58a2f49
Compare
| */ | ||
| public function getInstance(Constraint $constraint) | ||
| { | ||
| $name = $constraint->validatedBy(); | ||
|
|
||
| if (!isset($this->validators[$name])) { | ||
| if (!class_exists($name)) { | ||
| throw new InvalidArgumentException(sprintf('Constraint validator class "%s" does not exist.', $name)); |
There was a problem hiding this comment.
It's the correct exception class in this case? you could improve the text message? see the PR description.
There was a problem hiding this comment.
Maybe a simple ValidatorException as used in the ValidatorBuilder ?
There was a problem hiding this comment.
Thanks, agree with you.
Now, what do you think about the message ? Should be a little bit friendly ?
There was a problem hiding this comment.
I think it's friendly enough, but perhaps you can mention the validatedBy method.
d923926 to
f070965
Compare
|
Updated! both exception class and text message have been improved. @ogizanagi thanks one more time. |
d444bed to
80dda7c
Compare
| * @throws UnexpectedTypeException When the validator is not an instance of ConstraintValidatorInterface | ||
| */ | ||
| public function getInstance(Constraint $constraint) | ||
| { | ||
| $name = $constraint->validatedBy(); | ||
|
|
||
| if (!isset($this->validators[$name])) { | ||
| if (!class_exists($name)) { | ||
| throw new ValidatorException(sprintf( |
80dda7c to
0142a83
Compare
| * @throws UnexpectedTypeException When the validator is not an instance of ConstraintValidatorInterface | ||
| */ | ||
| public function getInstance(Constraint $constraint) | ||
| { | ||
| $name = $constraint->validatedBy(); | ||
|
|
||
| if (!isset($this->validators[$name])) { | ||
| if (!class_exists($name)) { | ||
| throw new ValidatorException(sprintf('Constraint validator "%s" does not exist or it is not enabled. Check the "validatedBy" method in your constraint class "%s"', $name, get_class($constraint))); |
There was a problem hiding this comment.
Missing dot at the end of the exception message.
|
As it already throws an exception, I think this should be merged in 2.7. ping @symfony/deciders |
…it is not enabled
0142a83 to
18cd50c
Compare
|
@fabpot I should create a separate PR for 2.7 branch? |
|
👍 as a bug fix |
1 similar comment
|
👍 as a bug fix |
|
Thank you @yceruto. |
fabpot
added a commit
that referenced
this pull request
Aug 24, 2016
… validator class does not exist (yceruto) This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #19601). Discussion ---------- [FrameworkBundle] Added friendly exception when constraint validator class does not exist | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Currently when mistakenly we type a [Custom Constraint Validator class](http://symfony.com/doc/current/validation/custom_constraint.html#creating-the-validator-itself) or the "alias name" from [validator service](http://symfony.com/doc/current/validation/custom_constraint.html#constraint-validators-with-dependencies) (which would occurs frequently for newcomers) is shown `ClassNotFoundException`: > Attempted to load class "alias_name" from namespace "Symfony\Component\Validator". Did you forget a "use" statement for another namespace? 500 Internal Server Error - ClassNotFoundException **This PR tries to improve the error message when this happen.** But I'm not sure about the exception class used ([`InvalidArgumentException`](https://github.com/yceruto/symfony/blob/master/src/Symfony/Component/Validator/Exception/InvalidArgumentException.php)) : ? * [`ConstraintDefinitionException`](https://github.com/yceruto/symfony/blob/master/src/Symfony/Component/Validator/Exception/ConstraintDefinitionException.php) would be another option, because the source of the error comes from the custom [`Constraint`](https://github.com/yceruto/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Validator/ConstraintValidatorFactory.php#L68) definition. The text message more convenient from this little mistake: ? * This mistake happen for two reason: FQCN or alias name supplied by constraint not found. * The constraint validator service was declared incorrectly (missing alias) * Perhaps some hint how the developer should resolve the mistake. Maybe some documentation core member would help me ? Commits ------- b66ea5e added friendly exception when constraint validator does not exist or it is not enabled
|
@yceruto FYI, we are able to merge PR on a different branch without you having to create a new PR :) |
This was referenced Sep 2, 2016
Merged
Merged
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently when mistakenly we type a Custom Constraint Validator class or the "alias name" from validator service (which would occurs frequently for newcomers) is shown
ClassNotFoundException:This PR tries to improve the error message when this happen.
But I'm not sure about the exception class used (
InvalidArgumentException) : ?ConstraintDefinitionExceptionwould be another option, because the source of the error comes from the customConstraintdefinition.The text message more convenient from this little mistake: ?
Maybe some documentation core member would help me ?