FlavourMachine.php

Go to the documentation of this file.

<?php

namespace ILIAS\ResourceStorage\Flavour\Machine;

use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition;
use ILIAS\ResourceStorage\Flavour\Engine\Engine;
use ILIAS\ResourceStorage\Information\FileInformation;

interface FlavourMachine
{
    public function __construct();

    public function getId(): string;

    public function canHandleDefinition(FlavourDefinition $definition): bool;

    public function dependsOnEngine(): ?string;

    public function withEngine(Engine $engine): FlavourMachine;

    public function getEngine(): Engine;

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