ImageOutputOptions.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Util\Convert;

class ImageOutputOptions
{
    public const FORMAT_JPG = 'jpg';
    public const FORMAT_PNG = 'png';
    public const FORMAT_WEBP = 'webp';
    public const FORMAT_KEEP = 'keep';
    private int $quality = 75;
    private string $format = self::FORMAT_JPG;
    private array $allowed_formats = [
        self::FORMAT_JPG,
        self::FORMAT_PNG,
        self::FORMAT_WEBP,
        self::FORMAT_KEEP,
    ];

    public function withFormat(string $format): ImageOutputOptions
    {
        $format = $this->checkFormat($format);
        $clone = clone $this;
        $clone->format = $format;
        return $clone;
    }

    public function withJpgOutput(): ImageOutputOptions
    {
        return $this->withFormat(self::FORMAT_JPG);
    }

    public function withPngOutput(): ImageOutputOptions
    {
        return $this->withFormat(self::FORMAT_PNG);
    }

    public function withWebPOutput(): ImageOutputOptions
    {
        return $this->withFormat(self::FORMAT_WEBP);
    }

    public function withQuality(int $image_quality): ImageOutputOptions
    {
        $this->checkImageQuality($image_quality);
        $clone = clone $this;
        $clone->quality = $image_quality;
        return $clone;
    }

    public function getFormat(): string
    {
        return $this->format;
    }

    public function getQuality(): int
    {
        return $this->quality;
    }

    private function checkFormat(string $format): string
    {
        $format = strtolower($format);
        if ($format === 'jpeg') {
            $format = self::FORMAT_JPG;
        }

        if (!in_array($format, $this->allowed_formats, true)) {
            throw new \InvalidArgumentException('Format must be one of ' . implode(', ',$this->allowed_formats) . ', but ' . $format . ' was given.');
        }
        return $format;
    }

    protected function checkImageQuality(int $image_quality): void
    {
        if ($this->format === self::FORMAT_WEBP) {
            if ($image_quality !== 0 && $image_quality !== 100) {
                throw new \InvalidArgumentException('WebP only supports quality 0 (loss) or 100 (losless)');
            }
        } elseif ($image_quality < 0 || $image_quality > 100) {
            throw new \InvalidArgumentException('Quality must be between 0 and 100');
        }
    }
}