StorageHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ResourceStorage\StorageHandler;

use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\ResourceStorage\Flavour\Flavour;
use ILIAS\ResourceStorage\Flavour\StorableFlavourDecorator;
use ILIAS\ResourceStorage\Identification\IdentificationGenerator;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ResourceStorage\Resource\StorableResource;
use ILIAS\ResourceStorage\Revision\CloneRevision;
use ILIAS\ResourceStorage\Revision\FileStreamRevision;
use ILIAS\ResourceStorage\Revision\Revision;
use ILIAS\ResourceStorage\Revision\UploadedFileRevision;
use ILIAS\ResourceStorage\StorageHandler\PathGenerator\PathGenerator;
use ILIAS\ResourceStorage\Revision\StreamReplacementRevision;

interface StorageHandler
{
    public function getID(): string;

    public function isPrimary(): bool;

    public function getIdentificationGenerator(): IdentificationGenerator;

    public function has(ResourceIdentification $identification): bool;

    // STREAMS

    public function getStream(Revision $revision): FileStream;

    public function storeUpload(UploadedFileRevision $revision): bool;

    public function storeStream(FileStreamRevision $revision): bool;


    // FLAVOURS

    public function hasFlavour(Revision $revision, Flavour $flavour): bool;

    public function storeFlavour(Revision $revision, StorableFlavourDecorator $storabel_flavour): bool;

    public function deleteFlavour(Revision $revision, Flavour $flavour): bool;

    public function getFlavourStreams(Revision $revision, Flavour $flavour): \Generator;


    public function getFlavourPath(Revision $revision, Flavour $flavour): string;

    public function clearFlavours(Revision $revision): void;

    // REVISIONS

    public function cloneRevision(CloneRevision $revision): bool;

    public function streamReplacement(StreamReplacementRevision $revision): bool;

    public function deleteRevision(Revision $revision): void;

    public function deleteResource(StorableResource $resource): void;

    public function cleanUpContainer(StorableResource $resource): void;

    public function getStorageLocationBasePath(): string;

    public function getFullContainerPath(ResourceIdentification $identification): string;

    public function getContainerPathWithoutBase(ResourceIdentification $identification): string;

    public function getRevisionPath(Revision $revision): string;


    public function movementImplementation(): string;

    public function getPathGenerator(): PathGenerator;
}