vendor/symfony/validator/Constraints/Image.php line 22

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Validator\Constraints;
  14. /**
  15.  * @Annotation
  16.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  17.  *
  18.  * @author Benjamin Dulau <benjamin.dulau@gmail.com>
  19.  * @author Bernhard Schussek <bschussek@gmail.com>
  20.  */
  21. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  22. class Image extends File
  23. {
  24.     public const SIZE_NOT_DETECTED_ERROR = '6d55c3f4-e58e-4fe3-91ee-74b492199956';
  25.     public const TOO_WIDE_ERROR = '7f87163d-878f-47f5-99ba-a8eb723a1ab2';
  26.     public const TOO_NARROW_ERROR = '9afbd561-4f90-4a27-be62-1780fc43604a';
  27.     public const TOO_HIGH_ERROR = '7efae81c-4877-47ba-aa65-d01ccb0d4645';
  28.     public const TOO_LOW_ERROR = 'aef0cb6a-c07f-4894-bc08-1781420d7b4c';
  29.     public const TOO_FEW_PIXEL_ERROR = '1b06b97d-ae48-474e-978f-038a74854c43';
  30.     public const TOO_MANY_PIXEL_ERROR = 'ee0804e8-44db-4eac-9775-be91aaf72ce1';
  31.     public const RATIO_TOO_BIG_ERROR = '70cafca6-168f-41c9-8c8c-4e47a52be643';
  32.     public const RATIO_TOO_SMALL_ERROR = '59b8c6ef-bcf2-4ceb-afff-4642ed92f12e';
  33.     public const SQUARE_NOT_ALLOWED_ERROR = '5d41425b-facb-47f7-a55a-de9fbe45cb46';
  34.     public const LANDSCAPE_NOT_ALLOWED_ERROR = '6f895685-7cf2-4d65-b3da-9029c5581d88';
  35.     public const PORTRAIT_NOT_ALLOWED_ERROR = '65608156-77da-4c79-a88c-02ef6d18c782';
  36.     public const CORRUPTED_IMAGE_ERROR = '5d4163f3-648f-4e39-87fd-cc5ea7aad2d1';
  38.     // Include the mapping from the base class
  40.     protected const ERROR_NAMES = [
  41.         self::NOT_FOUND_ERROR => 'NOT_FOUND_ERROR',
  42.         self::NOT_READABLE_ERROR => 'NOT_READABLE_ERROR',
  43.         self::EMPTY_ERROR => 'EMPTY_ERROR',
  44.         self::TOO_LARGE_ERROR => 'TOO_LARGE_ERROR',
  45.         self::INVALID_MIME_TYPE_ERROR => 'INVALID_MIME_TYPE_ERROR',
  46.         self::SIZE_NOT_DETECTED_ERROR => 'SIZE_NOT_DETECTED_ERROR',
  47.         self::TOO_WIDE_ERROR => 'TOO_WIDE_ERROR',
  48.         self::TOO_NARROW_ERROR => 'TOO_NARROW_ERROR',
  49.         self::TOO_HIGH_ERROR => 'TOO_HIGH_ERROR',
  50.         self::TOO_LOW_ERROR => 'TOO_LOW_ERROR',
  51.         self::TOO_FEW_PIXEL_ERROR => 'TOO_FEW_PIXEL_ERROR',
  52.         self::TOO_MANY_PIXEL_ERROR => 'TOO_MANY_PIXEL_ERROR',
  53.         self::RATIO_TOO_BIG_ERROR => 'RATIO_TOO_BIG_ERROR',
  54.         self::RATIO_TOO_SMALL_ERROR => 'RATIO_TOO_SMALL_ERROR',
  55.         self::SQUARE_NOT_ALLOWED_ERROR => 'SQUARE_NOT_ALLOWED_ERROR',
  56.         self::LANDSCAPE_NOT_ALLOWED_ERROR => 'LANDSCAPE_NOT_ALLOWED_ERROR',
  57.         self::PORTRAIT_NOT_ALLOWED_ERROR => 'PORTRAIT_NOT_ALLOWED_ERROR',
  58.         self::CORRUPTED_IMAGE_ERROR => 'CORRUPTED_IMAGE_ERROR',
  59.     ];
  61.     /**
  62.      * @deprecated since Symfony 6.1, use const ERROR_NAMES instead
  63.      */
  64.     protected static $errorNames = self::ERROR_NAMES;
  66.     public $mimeTypes = 'image/*';
  67.     public $minWidth;
  68.     public $maxWidth;
  69.     public $maxHeight;
  70.     public $minHeight;
  71.     public $maxRatio;
  72.     public $minRatio;
  73.     public $minPixels;
  74.     public $maxPixels;
  75.     public $allowSquare = true;
  76.     public $allowLandscape = true;
  77.     public $allowPortrait = true;
  78.     public $detectCorrupted = false;
  80.     // The constant for a wrong MIME type is taken from the parent class.
  81.     public $mimeTypesMessage = 'This file is not a valid image.';
  82.     public $sizeNotDetectedMessage = 'The size of the image could not be detected.';
  83.     public $maxWidthMessage = 'The image width is too big ({{ width }}px). Allowed maximum width is {{ max_width }}px.';
  84.     public $minWidthMessage = 'The image width is too small ({{ width }}px). Minimum width expected is {{ min_width }}px.';
  85.     public $maxHeightMessage = 'The image height is too big ({{ height }}px). Allowed maximum height is {{ max_height }}px.';
  86.     public $minHeightMessage = 'The image height is too small ({{ height }}px). Minimum height expected is {{ min_height }}px.';
  87.     public $minPixelsMessage = 'The image has too few pixels ({{ pixels }} pixels). Minimum amount expected is {{ min_pixels }} pixels.';
  88.     public $maxPixelsMessage = 'The image has too many pixels ({{ pixels }} pixels). Maximum amount expected is {{ max_pixels }} pixels.';
  89.     public $maxRatioMessage = 'The image ratio is too big ({{ ratio }}). Allowed maximum ratio is {{ max_ratio }}.';
  90.     public $minRatioMessage = 'The image ratio is too small ({{ ratio }}). Minimum ratio expected is {{ min_ratio }}.';
  91.     public $allowSquareMessage = 'The image is square ({{ width }}x{{ height }}px). Square images are not allowed.';
  92.     public $allowLandscapeMessage = 'The image is landscape oriented ({{ width }}x{{ height }}px). Landscape oriented images are not allowed.';
  93.     public $allowPortraitMessage = 'The image is portrait oriented ({{ width }}x{{ height }}px). Portrait oriented images are not allowed.';
  94.     public $corruptedMessage = 'The image file is corrupted.';
  96.     /**
  97.      * {@inheritdoc}
  98.      */
  99.     public function __construct(
  100.         array $options = null,
  101.         int|string $maxSize = null,
  102.         bool $binaryFormat = null,
  103.         array $mimeTypes = null,
  104.         int $minWidth = null,
  105.         int $maxWidth = null,
  106.         int $maxHeight = null,
  107.         int $minHeight = null,
  108.         int|float $maxRatio = null,
  109.         int|float $minRatio = null,
  110.         int|float $minPixels = null,
  111.         int|float $maxPixels = null,
  112.         bool $allowSquare = null,
  113.         bool $allowLandscape = null,
  114.         bool $allowPortrait = null,
  115.         bool $detectCorrupted = null,
  116.         string $notFoundMessage = null,
  117.         string $notReadableMessage = null,
  118.         string $maxSizeMessage = null,
  119.         string $mimeTypesMessage = null,
  120.         string $disallowEmptyMessage = null,
  121.         string $uploadIniSizeErrorMessage = null,
  122.         string $uploadFormSizeErrorMessage = null,
  123.         string $uploadPartialErrorMessage = null,
  124.         string $uploadNoFileErrorMessage = null,
  125.         string $uploadNoTmpDirErrorMessage = null,
  126.         string $uploadCantWriteErrorMessage = null,
  127.         string $uploadExtensionErrorMessage = null,
  128.         string $uploadErrorMessage = null,
  129.         string $sizeNotDetectedMessage = null,
  130.         string $maxWidthMessage = null,
  131.         string $minWidthMessage = null,
  132.         string $maxHeightMessage = null,
  133.         string $minHeightMessage = null,
  134.         string $minPixelsMessage = null,
  135.         string $maxPixelsMessage = null,
  136.         string $maxRatioMessage = null,
  137.         string $minRatioMessage = null,
  138.         string $allowSquareMessage = null,
  139.         string $allowLandscapeMessage = null,
  140.         string $allowPortraitMessage = null,
  141.         string $corruptedMessage = null,
  142.         array $groups = null,
  143.         mixed $payload = null
  144.     ) {
  145.         parent::__construct(
  146.             $options,
  147.             $maxSize,
  148.             $binaryFormat,
  149.             $mimeTypes,
  150.             $notFoundMessage,
  151.             $notReadableMessage,
  152.             $maxSizeMessage,
  153.             $mimeTypesMessage,
  154.             $disallowEmptyMessage,
  155.             $uploadIniSizeErrorMessage,
  156.             $uploadFormSizeErrorMessage,
  157.             $uploadPartialErrorMessage,
  158.             $uploadNoFileErrorMessage,
  159.             $uploadNoTmpDirErrorMessage,
  160.             $uploadCantWriteErrorMessage,
  161.             $uploadExtensionErrorMessage,
  162.             $uploadErrorMessage,
  163.             $groups,
  164.             $payload
  165.         );
  167.         $this->minWidth = $minWidth ?? $this->minWidth;
  168.         $this->maxWidth = $maxWidth ?? $this->maxWidth;
  169.         $this->maxHeight = $maxHeight ?? $this->maxHeight;
  170.         $this->minHeight = $minHeight ?? $this->minHeight;
  171.         $this->maxRatio = $maxRatio ?? $this->maxRatio;
  172.         $this->minRatio = $minRatio ?? $this->minRatio;
  173.         $this->minPixels = $minPixels ?? $this->minPixels;
  174.         $this->maxPixels = $maxPixels ?? $this->maxPixels;
  175.         $this->allowSquare = $allowSquare ?? $this->allowSquare;
  176.         $this->allowLandscape = $allowLandscape ?? $this->allowLandscape;
  177.         $this->allowPortrait = $allowPortrait ?? $this->allowPortrait;
  178.         $this->detectCorrupted = $detectCorrupted ?? $this->detectCorrupted;
  179.         $this->sizeNotDetectedMessage = $sizeNotDetectedMessage ?? $this->sizeNotDetectedMessage;
  180.         $this->maxWidthMessage = $maxWidthMessage ?? $this->maxWidthMessage;
  181.         $this->minWidthMessage = $minWidthMessage ?? $this->minWidthMessage;
  182.         $this->maxHeightMessage = $maxHeightMessage ?? $this->maxHeightMessage;
  183.         $this->minHeightMessage = $minHeightMessage ?? $this->minHeightMessage;
  184.         $this->minPixelsMessage = $minPixelsMessage ?? $this->minPixelsMessage;
  185.         $this->maxPixelsMessage = $maxPixelsMessage ?? $this->maxPixelsMessage;
  186.         $this->maxRatioMessage = $maxRatioMessage ?? $this->maxRatioMessage;
  187.         $this->minRatioMessage = $minRatioMessage ?? $this->minRatioMessage;
  188.         $this->allowSquareMessage = $allowSquareMessage ?? $this->allowSquareMessage;
  189.         $this->allowLandscapeMessage = $allowLandscapeMessage ?? $this->allowLandscapeMessage;
  190.         $this->allowPortraitMessage = $allowPortraitMessage ?? $this->allowPortraitMessage;
  191.         $this->corruptedMessage = $corruptedMessage ?? $this->corruptedMessage;
  193.         if (!\in_array('image/*', (array) $this->mimeTypes, true) && !\array_key_exists('mimeTypesMessage', $options ?? []) && null === $mimeTypesMessage) {
  194.             $this->mimeTypesMessage = 'The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.';
  195.         }
  196.     }
  197. }