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\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;

interface StorageHandler
{

    public function getID() : string;

    public function isPrimary() : bool;

    public function getIdentificationGenerator() : IdentificationGenerator;

    public function has(ResourceIdentification $identification) : bool;

    public function getStream(Revision $revision) : FileStream;

    public function storeUpload(UploadedFileRevision $revision) : bool;

    public function storeStream(FileStreamRevision $revision) : bool;

    public function cloneRevision(CloneRevision $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;
}