added enum ImageType

Author: dg

src/Utils/Image.php

@@ -133,16 +133,16 @@ class Image
 
 	/** image types */
 	public const
-		JPEG = IMAGETYPE_JPEG,
-		PNG = IMAGETYPE_PNG,
-		GIF = IMAGETYPE_GIF,
-		WEBP = IMAGETYPE_WEBP,
-		AVIF = 19, // IMAGETYPE_AVIF,
-		BMP = IMAGETYPE_BMP;
+		JPEG = ImageType::JPEG,
+		PNG = ImageType::PNG,
+		GIF = ImageType::GIF,
+		WEBP = ImageType::WEBP,
+		AVIF = ImageType::AVIF,
+		BMP = ImageType::BMP;
 
 	public const EmptyGIF = "GIF89a\x01\x00\x01\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00!\xf9\x04\x01\x00\x00\x00\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x02D\x01\x00;";
 
-	private const Formats = [self::JPEG => 'jpeg', self::PNG => 'png', self::GIF => 'gif', self::WEBP => 'webp', self::AVIF => 'avif', self::BMP => 'bmp'];
+	private const Formats = [ImageType::JPEG => 'jpeg', ImageType::PNG => 'png', ImageType::GIF => 'gif', ImageType::WEBP => 'webp', ImageType::AVIF => 'avif', ImageType::BMP => 'bmp'];
 
 	private \GdImage $image;
 
@@ -249,6 +249,7 @@ public static function fromBlank(int $width, int $height, ?array $color = null):
 
 	/**
 	 * Returns the type of image from file.
+	 * @return ImageType::*|null
 	 */
 	public static function detectTypeFromFile(string $file, &$width = null, &$height = null): ?int
 	{
@@ -259,6 +260,7 @@ public static function detectTypeFromFile(string $file, &$width = null, &$height
 
 	/**
 	 * Returns the type of image from string.
+	 * @return ImageType::*|null
 	 */
 	public static function detectTypeFromString(string $s, &$width = null, &$height = null): ?int
 	{
@@ -268,7 +270,8 @@ public static function detectTypeFromString(string $s, &$width = null, &$height
 
 
 	/**
-	 * Returns the file extension for the given `Image::XXX` constant.
+	 * Returns the file extension for the given image type.
+	 * @param  ImageType::*  $type
 	 * @return value-of<self::Formats>
 	 */
 	public static function typeToExtension(int $type): string
@@ -282,11 +285,12 @@ public static function typeToExtension(int $type): string
 
 
 	/**
-	 * Returns the `Image::XXX` constant for given file extension.
+	 * Returns the image type for given file extension.
+	 * @return ImageType::*
 	 */
 	public static function extensionToType(string $extension): int
 	{
-		$extensions = array_flip(self::Formats) + ['jpg' => self::JPEG];
+		$extensions = array_flip(self::Formats) + ['jpg' => ImageType::JPEG];
 		$extension = strtolower($extension);
 		if (!isset($extensions[$extension])) {
 			throw new Nette\InvalidArgumentException("Unsupported file extension '$extension'.");
@@ -297,7 +301,8 @@ public static function extensionToType(string $extension): int
 
 
 	/**
-	 * Returns the mime type for the given `Image::XXX` constant.
+	 * Returns the mime type for the given image type.
+	 * @param  ImageType::*  $type
 	 */
 	public static function typeToMimeType(int $type): string
 	{
@@ -601,6 +606,7 @@ public function place(self $image, int|string $left = 0, int|string $top = 0, in
 
 	/**
 	 * Saves image to the file. Quality is in the range 0..100 for JPEG (default 85), WEBP (default 80) and AVIF (default 30) and 0..9 for PNG (default 9).
+	 * @param  ImageType::*|null  $type
 	 * @throws ImageException
 	 */
 	public function save(string $file, ?int $quality = null, ?int $type = null): void
@@ -612,8 +618,9 @@ public function save(string $file, ?int $quality = null, ?int $type = null): voi
 
 	/**
 	 * Outputs image to string. Quality is in the range 0..100 for JPEG (default 85), WEBP (default 80) and AVIF (default 30) and 0..9 for PNG (default 9).
+	 * @param  ImageType::*  $type
 	 */
-	public function toString(int $type = self::JPEG, ?int $quality = null): string
+	public function toString(int $type = ImageType::JPEG, ?int $quality = null): string
 	{
 		return Helpers::capture(function () use ($type, $quality): void {
 			$this->output($type, $quality);
@@ -632,9 +639,10 @@ public function __toString(): string
 
 	/**
 	 * Outputs image to browser. Quality is in the range 0..100 for JPEG (default 85), WEBP (default 80) and AVIF (default 30) and 0..9 for PNG (default 9).
+	 * @param  ImageType::*  $type
 	 * @throws ImageException
 	 */
-	public function send(int $type = self::JPEG, ?int $quality = null): void
+	public function send(int $type = ImageType::JPEG, ?int $quality = null): void
 	{
 		header('Content-Type: ' . self::typeToMimeType($type));
 		$this->output($type, $quality);
@@ -643,36 +651,37 @@ public function send(int $type = self::JPEG, ?int $quality = null): void
 
 	/**
 	 * Outputs image to browser or file.
+	 * @param  ImageType::*  $type
 	 * @throws ImageException
 	 */
 	private function output(int $type, ?int $quality, ?string $file = null): void
 	{
 		switch ($type) {
-			case self::JPEG:
+			case ImageType::JPEG:
 				$quality = $quality === null ? 85 : max(0, min(100, $quality));
 				$success = @imagejpeg($this->image, $file, $quality); // @ is escalated to exception
 				break;
 
-			case self::PNG:
+			case ImageType::PNG:
 				$quality = $quality === null ? 9 : max(0, min(9, $quality));
 				$success = @imagepng($this->image, $file, $quality); // @ is escalated to exception
 				break;
 
-			case self::GIF:
+			case ImageType::GIF:
 				$success = @imagegif($this->image, $file); // @ is escalated to exception
 				break;
 
-			case self::WEBP:
+			case ImageType::WEBP:
 				$quality = $quality === null ? 80 : max(0, min(100, $quality));
 				$success = @imagewebp($this->image, $file, $quality); // @ is escalated to exception
 				break;
 
-			case self::AVIF:
+			case ImageType::AVIF:
 				$quality = $quality === null ? 30 : max(0, min(100, $quality));
 				$success = @imageavif($this->image, $file, $quality); // @ is escalated to exception
 				break;
 
-			case self::BMP:
+			case ImageType::BMP:
 				$success = @imagebmp($this->image, $file); // @ is escalated to exception
 				break;
 

src/Utils/ImageType.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file is part of the Nette Framework (https://nette.org)
+ * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
+ */
+
+declare(strict_types=1);
+
+namespace Nette\Utils;
+
+
+/**
+ * Type of image file.
+ */
+/*enum*/ final class ImageType
+{
+	public const
+		JPEG = IMAGETYPE_JPEG,
+		PNG = IMAGETYPE_PNG,
+		GIF = IMAGETYPE_GIF,
+		WEBP = IMAGETYPE_WEBP,
+		AVIF = 19, // IMAGETYPE_AVIF,
+		BMP = IMAGETYPE_BMP;
+}