ConsumerFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ResourceStorage\Consumer;

use ILIAS\ResourceStorage\Consumer\StreamAccess\StreamAccess;
use ILIAS\ResourceStorage\Flavour\Flavour;
use ILIAS\ResourceStorage\Policy\FileNamePolicy;
use ILIAS\ResourceStorage\Policy\NoneFileNamePolicy;
use ILIAS\ResourceStorage\Resource\StorableResource;
use ILIAS\ResourceStorage\Resource\StorableContainerResource;

class ConsumerFactory
{
    protected \ILIAS\ResourceStorage\Policy\FileNamePolicy $file_name_policy;
    private \ILIAS\HTTP\Services $http;
    private StreamAccess $stream_access;

    public function __construct(
        StreamAccess $stream_access,
        FileNamePolicy $file_name_policy = null
    ) {
        $this->stream_access = $stream_access;
        global $DIC;
        $this->file_name_policy = $file_name_policy ?? new NoneFileNamePolicy();
        $this->http = $DIC->http();
    }

    public function download(StorableResource $resource): DownloadConsumer
    {
        return new DownloadConsumer(
            $this->http,
            $resource,
            $this->stream_access,
            $this->file_name_policy
        );
    }

    public function inline(StorableResource $resource): InlineConsumer
    {
        return new InlineConsumer(
            $this->http,
            $resource,
            $this->stream_access,
            $this->file_name_policy
        );
    }

    public function fileStream(StorableResource $resource): FileStreamConsumer
    {
        return new FileStreamConsumer(
            $resource,
            $this->stream_access
        );
    }

    public function absolutePath(StorableResource $resource): AbsolutePathConsumer
    {
        return new AbsolutePathConsumer(
            $resource,
            $this->stream_access,
            $this->file_name_policy
        );
    }

    public function src(StorableResource $resource, SrcBuilder $src_builder): SrcConsumer
    {
        return new SrcConsumer(
            $src_builder,
            $resource,
            $this->stream_access
        );
    }

    public function flavourUrl(Flavour $flavour, SrcBuilder $src_builder): FlavourURLs
    {
        return new FlavourURLs(
            $src_builder,
            $flavour
        );
    }

    public function downloadMultiple(
        array $resources,
        ?string $zip_filename = null
    ): DownloadMultipleConsumer {
        return new DownloadMultipleConsumer(
            $resources,
            $this->stream_access,
            $this->file_name_policy,
            $zip_filename ?? 'Download.zip'
        );
    }

    public function containerZIP(
        StorableContainerResource $resource,
    ): ContainerConsumer {
        return new ContainerZIPAccessConsumer(
            $resource,
            $this->stream_access
        );
    }

    public function containerURI(
        StorableContainerResource $resource,
        SrcBuilder $src_builder,
        string $start_file = 'index.html',
        float $valid_for_at_least_minutes = 120.0
    ): ContainerConsumer {
        return new ContainerURIConsumer(
            $src_builder,
            $resource,
            $this->stream_access,
            $start_file,
            $valid_for_at_least_minutes
        );
    }
}