Skip to content

Commit 0a05312

Browse files
committed
Merge branch '6.4' into 7.1
* 6.4: Reword cannot validate svg image size
2 parents 8c24e13 + a604558 commit 0a05312

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

reference/constraints/Image.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,11 @@ add several other options.
210210

211211
If this option is false, the image cannot be landscape oriented.
212212

213+
.. note::
214+
215+
This option does not apply to SVG files. If you use it with SVG files,
216+
you'll see the error message defined in the ``sizeNotDetectedMessage`` option.
217+
213218
``allowLandscapeMessage``
214219
~~~~~~~~~~~~~~~~~~~~~~~~~
215220

@@ -234,6 +239,11 @@ Parameter Description
234239

235240
If this option is false, the image cannot be portrait oriented.
236241

242+
.. note::
243+
244+
This option does not apply to SVG files. If you use it with SVG files,
245+
you'll see the error message defined in the ``sizeNotDetectedMessage`` option.
246+
237247
``allowPortraitMessage``
238248
~~~~~~~~~~~~~~~~~~~~~~~~
239249

@@ -260,6 +270,11 @@ If this option is false, the image cannot be a square. If you want to force
260270
a square image, then leave this option as its default ``true`` value
261271
and set `allowLandscape`_ and `allowPortrait`_ both to ``false``.
262272

273+
.. note::
274+
275+
This option does not apply to SVG files. If you use it with SVG files,
276+
you'll see the error message defined in the ``sizeNotDetectedMessage`` option.
277+
263278
``allowSquareMessage``
264279
~~~~~~~~~~~~~~~~~~~~~~
265280

@@ -358,6 +373,11 @@ Parameter Description
358373
If set, the aspect ratio (``width / height``) of the image file must be less
359374
than or equal to this value.
360375

376+
.. note::
377+
378+
This option does not apply to SVG files. If you use it with SVG files,
379+
you'll see the error message defined in the ``sizeNotDetectedMessage`` option.
380+
361381
``maxRatioMessage``
362382
~~~~~~~~~~~~~~~~~~~
363383

@@ -477,6 +497,11 @@ Parameter Description
477497
If set, the aspect ratio (``width / height``) of the image file must be greater
478498
than or equal to this value.
479499

500+
.. note::
501+
502+
This option does not apply to SVG files. If you use it with SVG files,
503+
you'll see the error message defined in the ``sizeNotDetectedMessage`` option.
504+
480505
``minRatioMessage``
481506
~~~~~~~~~~~~~~~~~~~
482507

@@ -530,5 +555,11 @@ options has been set.
530555

531556
This message has no parameters.
532557

558+
.. note::
559+
560+
Detecting the size of SVG images is not supported. This error message will
561+
be displayed if you use any of the following options: ``allowLandscape``,
562+
``allowPortrait``, ``allowSquare``, ``maxRatio``, and ``minRatio``.
563+
533564
.. _`IANA website`: https://www.iana.org/assignments/media-types/media-types.xhtml
534565
.. _`PHP GD extension`: https://www.php.net/manual/en/book.image.php

0 commit comments

Comments
 (0)