Images.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Util\Convert;

use ILIAS\Filesystem\Stream\FileStream;

class Images
{
    protected ImageConversionOptions $conversion_options;
    protected ImageOutputOptions $image_output_options;

    public function __construct(
        bool $throw_on_error = false
    ) {
        // Defaults
        $this->conversion_options = (new ImageConversionOptions())
            ->withMakeTemporaryFiles(false)
            ->withThrowOnError($throw_on_error);
        $this->image_output_options = (new ImageOutputOptions())
            ->withJpgOutput()
            ->withQuality(75);
    }

    public function thumbnail(
        FileStream $stream,
        int $fit_into_size,
        ?ImageOutputOptions $image_output_options = null
    ): ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withFitIn($fit_into_size)
                ->withCrop(false)
                ->withKeepAspectRatio(true),
            $this->merge($image_output_options),
            $stream
        );
    }

    public function croppedSquare(
        FileStream $stream,
        int $square_size,
        ?ImageOutputOptions $image_output_options = null
    ): ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withFitIn($square_size)
                ->withKeepAspectRatio(true)
                ->withCrop(true),
            $this->merge($image_output_options),
            $stream
        );
    }


    public function resizeByWidth(
        FileStream $stream,
        int $width,
        ?ImageOutputOptions $image_output_options = null
    ): ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withWidth($width)
                ->withKeepAspectRatio(true),
            $this->merge($image_output_options),
            $stream
        );
    }


    public function resizeByHeight(
        FileStream $stream,
        int $height,
        ?ImageOutputOptions $image_output_options = null
    ): ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withHeight($height)
                ->withKeepAspectRatio(true),
            $this->merge($image_output_options),
            $stream
        );
    }


    public function resizeToFixedSize(
        FileStream $stream,
        int $width,
        int $height,
        bool $crop_or_otherwise_squeeze = true,
        ?ImageOutputOptions $image_output_options = null
    ): ImageConverter {
        return new ImageConverter(
            $this->conversion_options
                ->withWidth($width)
                ->withHeight($height)
                ->withCrop($crop_or_otherwise_squeeze)
                ->withKeepAspectRatio(true),
            $this->merge($image_output_options),
            $stream
        );
    }

    public function convertToFormat(
        FileStream $stream,
        string $to_format,
        ?int $width = null,
        ?int $height = null,
        ?ImageOutputOptions $image_output_options = null
    ): ImageConverter {
        $conversion_options = $this->conversion_options
            ->withKeepAspectRatio(true)
            ->withCrop(true);

        if ($height !== null) {
            $conversion_options = $conversion_options->withHeight($height);
        }
        if ($width !== null) {
            $conversion_options = $conversion_options->withWidth($width);
        }
        if ($width === null && $height === null) {
            $conversion_options = $conversion_options->withKeepDimensions(true);
        }
        return new ImageConverter(
            $conversion_options,
            $this->merge($image_output_options)->withFormat($to_format),
            $stream
        );
    }

    private function merge(?ImageOutputOptions $image_output_options): ImageOutputOptions
    {
        if ($image_output_options !== null) {
            return $this->image_output_options
                ->withQuality($image_output_options->getQuality())
                ->withFormat($image_output_options->getFormat());
        }
        return $this->image_output_options;
    }
}