StorageHandlerFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ResourceStorage\StorageHandler;

use ILIAS\ResourceStorage\Resource\StorableResource;
use ILIAS\ResourceStorage\Revision\Revision;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;

class StorageHandlerFactory
{
    public const BASE_DIRECTORY = "storage";
    protected array $handlers = [];
    protected ?StorageHandler $primary = null;

    public function __construct(array $handlers, private string $base_dir)
    {
        foreach ($handlers as $handler) {
            $this->handlers[$handler->getID()] = $handler;
            if ($handler->isPrimary()) {
                if ($this->primary !== null) {
                    throw new \LogicException("Only one primary StorageHandler can exist");
                }
                $this->primary = $handler;
            }
        }
        if ($this->primary === null) {
            throw new \LogicException("One primary StorageHandler must exist");
        }
    }

    public function getBaseDir(): string
    {
        return $this->base_dir;
    }

    public function getHandlerForResource(StorableResource $resource): StorageHandler
    {
        return $this->getHandlerForStorageId($resource->getStorageID());
    }

    public function getHandlerForRevision(Revision $revision): StorageHandler
    {
        return $this->getHandlerForStorageId($revision->getStorageID());
    }

    public function getHandlerForStorageId(string $storage_id): StorageHandler
    {
        if (isset($this->handlers[$storage_id])) {
            return $this->handlers[$storage_id];
        }

        throw new \LogicException("no StorageHandler for '$storage_id' available");
    }

    public function getPrimary(): ?StorageHandler
    {
        return $this->primary;
    }

    public function getRidForURI(string $uri): ?ResourceIdentification
    {
        $internal_path = str_replace($this->getBaseDir(), "", $uri);
        $internal_path = ltrim(str_replace(self::BASE_DIRECTORY, "", $internal_path), "/");

        $fs_identifier = explode("/", $internal_path)[0];

        $internal_path = str_replace($fs_identifier . "/", "", $internal_path);

        $handler = $this->getHandlerForStorageId($fs_identifier);
        $path_generator = $handler->getPathGenerator();
        try {
            $rid = $path_generator->getIdentificationFor($internal_path);
        } catch (\Throwable) {
            return null;
        }
        return $rid;
    }
}