Skip to content

[Validator] Added documentation for message parameters added between 2.8 and 3.4 #10622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2018
Merged

[Validator] Added documentation for message parameters added between 2.8 and 3.4 #10622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions reference/constraints/Image.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,8 @@ If the system is unable to determine the size of the image, this error will
be displayed. This will only occur when at least one of the size constraint
options has been set.

This message has no parameters.

maxWidthMessage
~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -436,6 +438,20 @@ Maximum amount expected is {{ max_pixels }} pixels.``

The error message if the amount of pixels of the image exceeds `maxPixels`_.

You can use the following parameters in this message:

+----------------------+---------------------------------------+
| Parameter | Description |
+======================+=======================================+
| ``{{ pixels }}`` | The current amount of pixels |
+----------------------+---------------------------------------+
| ``{{ max_pixels }}`` | The maximum allowed amount of pixels |
+----------------------+---------------------------------------+
| ``{{ height }}`` | The current image height |
+----------------------+---------------------------------------+
| ``{{ width }}`` | The current image width |
+----------------------+---------------------------------------+

minPixelsMessage
~~~~~~~~~~~~~~~~

Expand All @@ -447,6 +463,20 @@ Minimum amount expected is {{ min_pixels }} pixels.``

The error message if the amount of pixels of the image is less than `minPixels`_.

You can use the following parameters in this message:

+----------------------+---------------------------------------+
| Parameter | Description |
+======================+=======================================+
| ``{{ pixels }}`` | The current amount of pixels |
+----------------------+---------------------------------------+
| ``{{ min_pixels }}`` | The minimum required amount of pixels |
+----------------------+---------------------------------------+
| ``{{ height }}`` | The current image height |
+----------------------+---------------------------------------+
| ``{{ width }}`` | The current image width |
+----------------------+---------------------------------------+

maxRatioMessage
~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -545,5 +575,7 @@ corruptedMessage
The error message when the `detectCorrupted`_ option is enabled and the image
is corrupted.

This message has no parameters.

.. _`IANA website`: http://www.iana.org/assignments/media-types/image/index.html
.. _`PHP GD extension`: http://php.net/manual/en/book.image.php