class.ilUserProfilePictureMachine.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\ResourceStorage\Flavour\Definition\CropToSquare;
use ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition;
use ILIAS\ResourceStorage\Flavour\Definition\ToGreyScale;
use ILIAS\ResourceStorage\Flavour\Engine\GDEngine;
use ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\AbstractMachine;
use ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\CropSquare;
use ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\GdImageToStreamTrait;
use ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\MakeGreyScale;
use ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine;
use ILIAS\ResourceStorage\Flavour\Machine\Result;
use ILIAS\ResourceStorage\Information\FileInformation;

class ilUserProfilePictureMachine extends AbstractMachine implements FlavourMachine
{
    use GdImageToStreamTrait;
    public const ID = "a3c77dec93b5303f4340767b9a445ad591f6025a9ca7edbf24fa8ab23a851eae";
    private const FULL_QUALITY_SIZE_THRESHOLD = 100;
    private CropSquare $crop;
    private MakeGreyScale $grey;
    private ?ilUserProfilePictureDefinition $definition = null;
    private ?FileInformation $information = null;

    public function __construct()
    {
        $this->crop = new CropSquare();
        $this->grey = new MakeGreyScale();
    }


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

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

    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->getSizes() as $size) {
            if (($croped_image = $this->cropImage($stream, $size)) === null) {
                continue;
            }
            yield new Result(
                $for_definition,
                $croped_image,
                $i,
                true
            );
            $i++;
        }
    }

    protected function cropImage(
        FileStream $stream,
        int $size
    ): ?FileStream {
        $quality = $size <= 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 CropToSquare(
                false,
                $size,
                $quality
            )
        )->current()?->getStream();
    }

    protected function makeGreyScale(
        FileStream $stream
    ): ?FileStream {
        return $this->grey->processStream(
            $this->information,
            $stream,
            new ToGreyScale(
                false,
                $this->definition->getQuality()
            )
        )->current()?->getStream();
    }
}