Documented the detectCorrupted and corruptedMessage options #6433
Conversation
This file contains 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
Member
javiereguiluz
commented
Apr 5, 2016
javiereguiluz
commented
| Q | A |
|---|---|
| Doc fix? | no |
| New docs? | yes |
| Applies to | master (3.1+) |
| Fixed tickets | symfony/symfony#17458 |
| .. versionadded:: 3.1 | ||
| The ``detectCorrupted`` option was introduced in Symfony 3.1. | ||
|
|
||
| **type**: ``Boolean`` **default**: ``false`` |
|
|
||
| If this option is true, the image contents are validated to ensure that the | ||
| image is not corrupted. This validation is done with PHP's ``imagecreatefromstring()`` | ||
| function, which requires the PHP GD extension to be enabled. |
There was a problem hiding this comment.
should we link to the GD Extension?
|
Thanks for the review! I've done all the changes. This is now ready to be merged. Thanks! |
|
👍 |
|
👍 Thanks! |
|
|
||
| **type**: ``string`` **default**: ``The image file is corrupted.`` | ||
|
|
||
| The error message when the `detectCorrupted`_ option is enabled and the image |
There was a problem hiding this comment.
I was to unsure to commit this, but shouldn't we use if here instead of when?
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.