ImageConversionOptions.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Util\Convert;

class ImageConversionOptions
{
    public const DIMENSION_MODE_NONE = 0;
    public const DIMENSION_MODE_FIT = 1;
    public const DIMENSTION_MODE_RESIZE_TO_FIXED = 2;
    public const DIMENSTION_MODE_RESIZE_BY_HEIGHT = 3;
    public const DIMENSTION_MODE_RESIZE_BY_WIDTH = 4;
    public const DIMENSION_MODE_KEEP = 5;

    private int $dimension_mode = self::DIMENSION_MODE_NONE;
    private ?int $height = null;
    private ?int $width = null;
    private bool $keep_aspect_ratio = true;
    private ?string $background_color = null;
    private ?string $output_path = null;
    private bool $crop = true;
    private bool $throw_on_error = false;
    private bool $make_temporary_files = false;

    public function withThrowOnError(bool $throw_on_error): self
    {
        $clone = clone $this;
        $clone->throw_on_error = $throw_on_error;
        return $clone;
    }

    public function withMakeTemporaryFiles(bool $make_temporary_files): self
    {
        $clone = clone $this;
        $clone->make_temporary_files = $make_temporary_files;
        return $clone;
    }

    public function withFitIn(int $max_size): ImageConversionOptions
    {
        $clone = clone $this;
        $clone->dimension_mode = self::DIMENSION_MODE_FIT;
        $clone->width = $clone->height = $max_size;
        return $clone;
    }

    public function withKeepAspectRatio(bool $keep_aspect_ratio): ImageConversionOptions
    {
        $clone = clone $this;
        $clone->keep_aspect_ratio = $keep_aspect_ratio;
        return $clone;
    }

    public function withCrop(bool $crop): ImageConversionOptions
    {
        $clone = clone $this;
        $clone->crop = $crop;
        return $clone;
    }

    public function withKeepDimensions(bool $keep): ImageConversionOptions
    {
        $clone = clone $this;
        $clone->dimension_mode = self::DIMENSION_MODE_KEEP;
        $this->width = $this->height = null;
        return $clone;
    }

    public function withWidth(int $width): ImageConversionOptions
    {
        $clone = clone $this;
        $clone->dimension_mode = ($this->height === null) ? self::DIMENSTION_MODE_RESIZE_BY_WIDTH : self::DIMENSTION_MODE_RESIZE_TO_FIXED;
        $clone->width = $width;
        return $clone;
    }

    public function withHeight(int $height): ImageConversionOptions
    {
        $clone = clone $this;
        $clone->dimension_mode = ($this->width === null) ? self::DIMENSTION_MODE_RESIZE_BY_HEIGHT : self::DIMENSTION_MODE_RESIZE_TO_FIXED;
        $clone->height = $height;
        return $clone;
    }

    public function withFixedDimensions(int $width, int $height): ImageConversionOptions
    {
        return $this->withHeight($height)->withWidth($width);
    }

    public function withOutputPath(string $output_path): ImageConversionOptions
    {
        $clone = clone $this;
        $clone->output_path = $output_path;
        return $clone;
    }

    public function withBackgroundColor(string $background_color): ImageConversionOptions
    {
        $this->checkBackgroundColor($background_color);

        $clone = clone $this;
        $clone->background_color = $background_color;
        return $clone;
    }

    public function getBackgroundColor(): ?string
    {
        return $this->background_color;
    }

    public function getOutputPath(): ?string
    {
        return $this->output_path;
    }


    public function getDimensionMode(): int
    {
        return $this->dimension_mode;
    }

    public function getHeight(): ?int
    {
        return $this->height;
    }

    public function getWidth(): ?int
    {
        return $this->width;
    }


    public function keepAspectRatio(): bool
    {
        return $this->keep_aspect_ratio;
    }


    public function hasCrop(): bool
    {
        return $this->crop;
    }

    public function throwOnError(): bool
    {
        return $this->throw_on_error;
    }

    public function makeTemporaryFiles(): bool
    {
        return $this->make_temporary_files;
    }

    protected function checkBackgroundColor(string $background_color): void
    {
        if (!preg_match('/^#?([a-f0-9]{6})$/i', $background_color)) {
            throw new \InvalidArgumentException('Invalid background color');
        }
    }
}