From 0c760570b4212ec25222116f099d754f8248dd40 Mon Sep 17 00:00:00 2001 From: Timo Bakx Date: Wed, 31 Oct 2018 10:17:08 +0100 Subject: [PATCH] Added documentation for message parameters added between 2.8 and 3.4 --- reference/constraints/Image.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/reference/constraints/Image.rst b/reference/constraints/Image.rst index 45b9fd09619..4118b416e38 100644 --- a/reference/constraints/Image.rst +++ b/reference/constraints/Image.rst @@ -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 ~~~~~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~~ @@ -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