Image

Warning: You are browsing the documentation for Symfony 6.2, which is no longer maintained.

Read the updated version of this page for Symfony 7.2 (the current stable version).

Image

The Image constraint works exactly like the File constraint, except that its mimeTypes and mimeTypesMessage options are automatically setup to work for image files specifically.

Additionally it has options so you can validate against the width and height of the image.

See the File constraint for the bulk of the documentation on this constraint.

Applies to property or method
Class Image
Validator ImageValidator

Basic Usage

This constraint is most commonly used on a property that will be rendered in a form as a FileType field. For example, suppose you're creating an author form where you can upload a "headshot" image for the author. In your form, the headshot property would be a file type. The Author class might look as follows:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\HttpFoundation\File\File;

class Author
{
    protected File $headshot;

    public function setHeadshot(File $file = null): void
    {
        $this->headshot = $file;
    }

    public function getHeadshot(): File
    {
        return $this->headshot;
    }
}

To guarantee that the headshot File object is a valid image and that it is between a certain size, add the following:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\HttpFoundation\File\File;
use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    #[Assert\Image(
        minWidth: 200,
        maxWidth: 400,
        minHeight: 200,
        maxHeight: 400,
    )]
    protected File $headshot;
}

The headshot property is validated to guarantee that it is a real image and that it is between a certain width and height.

You may also want to guarantee the headshot image to be square. In this case you can disable portrait and landscape orientations as shown in the following code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\HttpFoundation\File\File;
use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    #[Assert\Image(
        allowLandscape: false,
        allowPortrait: false,
    )]
    protected File $headshot;
}

You can mix all the constraint options to create powerful validation rules.

Options

This constraint shares all of its options with the File constraint. It does, however, modify two of the default option values and add several other options.

allowLandscape

type: Boolean default: true

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

allowLandscapeMessage

type: string default: The image is landscape oriented ({{ width }}x{{ height }}px). Landscape oriented images are not allowed

The error message if the image is landscape oriented and you set allowLandscape to false.

You can use the following parameters in this message:

Parameter Description
{{ height }} The current height
{{ width }} The current width

allowPortrait

type: Boolean default: true

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

allowPortraitMessage

type: string default: The image is portrait oriented ({{ width }}x{{ height }}px). Portrait oriented images are not allowed

The error message if the image is portrait oriented and you set allowPortrait to false.

You can use the following parameters in this message:

Parameter Description
{{ height }} The current height
{{ width }} The current width

allowSquare

type: Boolean default: true

If this option is false, the image cannot be a square. If you want to force a square image, then leave this option as its default true value and set allowLandscape and allowPortrait both to false.

allowSquareMessage

type: string default: The image is square ({{ width }}x{{ height }}px). Square images are not allowed

The error message if the image is square and you set allowSquare to false.

You can use the following parameters in this message:

Parameter Description
{{ height }} The current height
{{ width }} The current width

corruptedMessage

type: string default: The image file is corrupted.

The error message when the detectCorrupted option is enabled and the image is corrupted.

This message has no parameters.

detectCorrupted

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.

groups

type: array | string default: null

It defines the validation group or groups of this constraint. Read more about validation groups.

maxHeight

type: integer

If set, the height of the image file must be less than or equal to this value in pixels.

maxHeightMessage

type: string default: The image height is too big ({{ height }}px). Allowed maximum height is {{ max_height }}px.

The error message if the height of the image exceeds maxHeight.

You can use the following parameters in this message:

Parameter Description
{{ height }} The current (invalid) height
{{ max_height }} The maximum allowed height

maxPixels

type: integer

If set, the amount of pixels of the image file must be less than or equal to this value.

maxPixelsMessage

type: string default: The image has too many pixels ({{ pixels }} pixels). 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
{{ height }} The current image height
{{ max_pixels }} The maximum allowed amount of pixels
{{ pixels }} The current amount of pixels
{{ width }} The current image width

maxRatio

type: float

If set, the aspect ratio (width / height) of the image file must be less than or equal to this value.

maxRatioMessage

type: string default: The image ratio is too big ({{ ratio }}). Allowed maximum ratio is {{ max_ratio }}

The error message if the aspect ratio of the image exceeds maxRatio.

You can use the following parameters in this message:

Parameter Description
{{ max_ratio }} The maximum required ratio
{{ ratio }} The current (invalid) ratio

maxWidth

type: integer

If set, the width of the image file must be less than or equal to this value in pixels.

maxWidthMessage

type: string default: The image width is too big ({{ width }}px). Allowed maximum width is {{ max_width }}px.

The error message if the width of the image exceeds maxWidth.

You can use the following parameters in this message:

Parameter Description
{{ max_width }} The maximum allowed width
{{ width }} The current (invalid) width

mimeTypes

type: array or string default: image/*

You can find a list of existing image mime types on the IANA website.

mimeTypesMessage

type: string default: This file is not a valid image.

If all the values of the mimeTypes option are a subset of image/*, the error message will be instead: The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.

You can use the following parameters in this message:

Parameter Description
{{ file }} Absolute file path
{{ name }} Base file name
{{ type }} The MIME type of the given file
{{ types }} The list of allowed MIME types

minHeight

type: integer

If set, the height of the image file must be greater than or equal to this value in pixels.

minHeightMessage

type: string default: The image height is too small ({{ height }}px). Minimum height expected is {{ min_height }}px.

The error message if the height of the image is less than minHeight.

You can use the following parameters in this message:

Parameter Description
{{ height }} The current (invalid) height
{{ min_height }} The minimum required height

minPixels

type: integer

If set, the amount of pixels of the image file must be greater than or equal to this value.

minPixelsMessage

type: string default: The image has too few pixels ({{ pixels }} pixels). 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
{{ height }} The current image height
{{ min_pixels }} The minimum required amount of pixels
{{ pixels }} The current amount of pixels
{{ width }} The current image width

minRatio

type: float

If set, the aspect ratio (width / height) of the image file must be greater than or equal to this value.

minRatioMessage

type: string default: The image ratio is too small ({{ ratio }}). Minimum ratio expected is {{ min_ratio }}

The error message if the aspect ratio of the image is less than minRatio.

You can use the following parameters in this message:

Parameter Description
{{ min_ratio }} The minimum required ratio
{{ ratio }} The current (invalid) ratio

minWidth

type: integer

If set, the width of the image file must be greater than or equal to this value in pixels.

minWidthMessage

type: string default: The image width is too small ({{ width }}px). Minimum width expected is {{ min_width }}px.

The error message if the width of the image is less than minWidth.

You can use the following parameters in this message:

Parameter Description
{{ min_width }} The minimum required width
{{ width }} The current (invalid) width

sizeNotDetectedMessage

type: string default: The size of the image could not be detected.

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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version