class.ilObjectTileImageFlavourMachine.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Object\Properties\CoreProperties\TileImage;

use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\ResourceStorage\Flavour\Definition\CropToRectangle;
use ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition;
use ILIAS\ResourceStorage\Flavour\Engine\GDEngine;
use ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\AbstractMachine;
use ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\CropRectangle;
use ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine;
use ILIAS\ResourceStorage\Flavour\Machine\Result;
use ILIAS\ResourceStorage\Information\FileInformation;
use ILIAS\Filesystem\Stream\Stream;

class ilObjectTileImageFlavourMachine extends AbstractMachine implements FlavourMachine
{
    public const ID = "4c7e3aaff42a352fa3fd3dfc4d4a994cc3dfdd97e97c2c2c9932e22e2e57357a";
    private const FULL_QUALITY_SIZE_THRESHOLD = 100;
    private CropRectangle $crop;
    private ?ilObjectTileImageFlavourDefinition $definition = null;
    private ?FileInformation $information = null;

    public function __construct()
    {
        $this->crop = new CropRectangle();
    }

    public function getId(): string
    {
        return self::ID;
    }

    public function canHandleDefinition(FlavourDefinition $definition): bool
    {
        return $definition instanceof ilObjectTileImageFlavourDefinition;
    }

    public function dependsOnEngine(): ?string
    {
        return GDEngine::class;
    }

    public function processStream(
        FileInformation $information,
        FileStream $stream,
        FlavourDefinition $for_definition
    ): \Generator {
        $this->definition = $for_definition;
        $this->information = $information;

        $i = 0;
        foreach ($for_definition->getWidths() as $width) {
            if (($crop_stream = $this->cropImage($stream, $width)) === null) {
                continue;
            }
            yield new Result(
                $for_definition,
                $crop_stream,
                $i,
                true
            );
            $i++;
        }
    }

    protected function cropImage(
        FileStream $stream,
        int $width
    ): ?Stream {
        $quality = $width <= self::FULL_QUALITY_SIZE_THRESHOLD
            ? 100 // we take 100% jpeg quality for small resultions
            : $this->definition->getQuality();

        return $this->crop->processStream(
            $this->information,
            $stream,
            new CropToRectangle(
                false,
                $width,
                $this->definition->getRatio(),
                $quality
            )
        )->current()?->getStream();
    }
}