NullMachine.php

Go to the documentation of this file.

<?php

namespace ILIAS\ResourceStorage\Flavour\Machine;

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

class NullMachine extends AbstractMachine implements FlavourMachine
{
    private string $reason = '';


    public function getId(): string
    {
        return 'null_machine';
    }

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

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

    public function withReason(string $reason): FlavourMachine
    {
        $clone = clone $this;
        $clone->reason = $reason;
        return $clone;
    }

    public function getReason(): string
    {
        return $this->reason;
    }


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