DummyMachine.php

Go to the documentation of this file.

<?php

namespace ILIAS\ResourceStorage\Flavours;

use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition;
use ILIAS\ResourceStorage\Flavour\Engine\Engine;
use ILIAS\ResourceStorage\Flavour\Engine\NoEngine;
use ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\AbstractMachine;
use ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine;
use ILIAS\ResourceStorage\Flavour\Machine\NonStoreableResult;
use ILIAS\ResourceStorage\Information\FileInformation;

class DummyMachine extends AbstractMachine implements FlavourMachine
{
    private string $depends_on_engine = NoEngine::class;
    private string $id = self::class;
    private ?string $can_handle_definition_id = null;

    public function load(
        string $id,
        string $can_handle_definition_id = null,
        string $depends_on_engine = NoEngine::class
    ): void {
        $this->id = $id;
        $this->depends_on_engine = $depends_on_engine;
        $this->can_handle_definition_id = $can_handle_definition_id;
    }

    public function __construct()
    {
    }

    public function getId(): string
    {
        return $this->id;
    }

    public function canHandleDefinition(FlavourDefinition $definition): bool
    {
        if ($this->can_handle_definition_id === null) {
            return true;
        }
        return $this->can_handle_definition_id === $definition->getId();
    }

    public function dependsOnEngine(): ?string
    {
        return $this->depends_on_engine;
    }


    public function processStream(
        FileInformation $information,
        FileStream $stream,
        FlavourDefinition $for_definition
    ): \Generator {
        yield new NonStoreableResult($for_definition, $stream);
    }
}