Consumers.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ResourceStorage\Consumer;

use ILIAS\ResourceStorage\Collection\CollectionBuilder;
use ILIAS\ResourceStorage\Flavour\Flavour;
use ILIAS\ResourceStorage\Identification\ResourceCollectionIdentification;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ResourceStorage\Resource\ResourceBuilder;
use ILIAS\ResourceStorage\Resource\ResourceType;
use ILIAS\ResourceStorage\Resource\StorableContainerResource;

class Consumers
{
    private ConsumerFactory $consumer_factory;
    private ResourceBuilder $resource_builder;
    private CollectionBuilder $collection_builder;
    private SrcBuilder $src_builder;

    public function __construct(
        ConsumerFactory $consumer_factory,
        ResourceBuilder $resource_builder,
        CollectionBuilder $collection_builder,
        ?SrcBuilder $src_builder = null
    ) {
        $this->consumer_factory = $consumer_factory;
        $this->resource_builder = $resource_builder;
        $this->collection_builder = $collection_builder;
        $this->src_builder = $src_builder ?? new InlineSrcBuilder();
    }

    public function download(ResourceIdentification $identification): DownloadConsumer
    {
        return $this->consumer_factory->download($this->resource_builder->get($identification));
    }

    public function inline(ResourceIdentification $identification): InlineConsumer
    {
        return $this->consumer_factory->inline($this->resource_builder->get($identification));
    }

    public function stream(ResourceIdentification $identification): FileStreamConsumer
    {
        return $this->consumer_factory->fileStream($this->resource_builder->get($identification));
    }

    public function src(ResourceIdentification $identification): SrcConsumer
    {
        return $this->consumer_factory->src($this->resource_builder->get($identification), $this->src_builder);
    }

    public function downloadCollection(
        ResourceCollectionIdentification $identification,
        ?string $zip_filename = null
    ): DownloadMultipleConsumer {
        return $this->downloadResources(
            iterator_to_array($this->collection_builder->getResourceIds($identification)),
            $zip_filename
        );
    }

    public function downloadResources(
        array $identifications,
        ?string $zip_filename = null
    ): DownloadMultipleConsumer {
        $resources = [];
        foreach ($identifications as $rid) {
            if (!$rid instanceof ResourceIdentification) {
                throw new \InvalidArgumentException('Expected ResourceIdentification');
            }
            $resources[] = $this->resource_builder->get($rid);
        }

        return $this->consumer_factory->downloadMultiple(
            $resources,
            $zip_filename
        );
    }

    public function flavourUrls(Flavour $flavour): FlavourURLs
    {
        return $this->consumer_factory->flavourUrl($flavour, $this->src_builder);
    }

    public function containerZIP(ResourceIdentification $identification): ContainerZIPAccessConsumer
    {
        $resource = $this->resource_builder->get($identification);
        if ($resource->getType() !== ResourceType::CONTAINER || !$resource instanceof StorableContainerResource) {
            throw new \InvalidArgumentException('Expected StorableContainerResource');
        }

        return $this->consumer_factory->containerZIP(
            $resource
        );
    }

    public function containerURI(
        ResourceIdentification $identification,
        string $start_file = 'index.html',
        float $valid_for_at_least_minutes = 60.0
    ): ContainerURIConsumer {
        $resource = $this->resource_builder->get($identification);
        if ($resource->getType() !== ResourceType::CONTAINER || !$resource instanceof StorableContainerResource) {
            throw new \InvalidArgumentException('Expected StorableContainerResource');
        }
        return $this->consumer_factory->containerURI(
            $resource,
            $this->src_builder,
            ltrim($start_file, '/'),
            $valid_for_at_least_minutes
        );
    }
}