LegacyImages.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Util\Convert;

use ILIAS\Filesystem\Stream\Stream;
use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\Filesystem\Stream\Streams;

class LegacyImages
{
    private Images $image_converters;
    private ImageOutputOptions $output_options;

    public function __construct()
    {
        $this->image_converters = new Images(false);
        $this->output_options = new ImageOutputOptions();
    }
    //
    // Thumbnails
    //

    public function thumbnail(
        string $path_to_original,
        string $path_to_output,
        int $fit_into_size,
        string $output_format = ImageOutputOptions::FORMAT_KEEP,
        int $image_quality = 75
    ): string {
        $converter = $this->image_converters->thumbnail(
            $this->buildStream($path_to_original),
            $fit_into_size,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );
        return $this->storeStream($converter, $path_to_output);
    }

    //
    // Cropped Square
    //

    public function croppedSquare(
        string $path_to_original,
        string $path_to_output,
        int $square_size,
        string $output_format = ImageOutputOptions::FORMAT_KEEP,
        int $image_quality = 75
    ): string {
        $converter = $this->image_converters->croppedSquare(
            $this->buildStream($path_to_original),
            $square_size,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );

        return $this->storeStream($converter, $path_to_output);
    }

    //
    // Resize
    //

    public function resizeByWidth(
        string $path_to_original,
        string $path_to_output,
        int $width,
        string $output_format = ImageOutputOptions::FORMAT_KEEP,
        int $image_quality = 60
    ): string {
        $converter = $this->image_converters->resizeByWidth(
            $this->buildStream($path_to_original),
            $width,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );
        return $this->storeStream($converter, $path_to_output);
    }


    public function resizeByHeight(
        string $path_to_original,
        string $path_to_output,
        int $height,
        string $output_format = ImageOutputOptions::FORMAT_KEEP,
        int $image_quality = 60
    ): string {
        $converter = $this->image_converters->resizeByHeight(
            $this->buildStream($path_to_original),
            $height,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );
        return $this->storeStream($converter, $path_to_output);
    }


    public function resizeToFixedSize(
        string $path_to_original,
        string $path_to_output,
        int $width,
        int $height,
        bool $crop_if_true_and_resize_if_false = true,
        string $output_format = ImageOutputOptions::FORMAT_KEEP,
        int $image_quality = 60
    ): string {
        $converter = $this->image_converters->resizeToFixedSize(
            $this->buildStream($path_to_original),
            $width,
            $height,
            $crop_if_true_and_resize_if_false,
            $this->output_options
                ->withQuality($image_quality)
                ->withFormat($output_format)
        );
        return $this->storeStream($converter, $path_to_output);
    }

    public function convertToFormat(
        string $path_to_original,
        string $path_to_output,
        string $output_format,
        ?int $width = null,
        ?int $height = null
    ): string {
        $converter = $this->image_converters->convertToFormat(
            $this->buildStream($path_to_original),
            $output_format,
            $width,
            $height
        );
        return $this->storeStream($converter, $path_to_output);
    }

    private function storeStream(ImageConverter $converter, string $path): string
    {
        if (!$converter->isOK()) {
            throw $converter->getThrowableIfAny() ?? new \RuntimeException('Could not create requested image');
        }

        $stream = $converter->getStream();

        $stream->rewind();
        if (file_put_contents($path, $stream->getContents()) === false) {
            throw new \RuntimeException('Could not store image');
        }
        return $path;
    }

    private function buildStream(string $path_to_original): Stream|FileStream
    {
        return Streams::ofResource(fopen($path_to_original, 'rb'));
    }
}