BaseConsumer.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\Policy\FileNamePolicy;
use ILIAS\ResourceStorage\Resource\StorableResource;

abstract class BaseConsumer implements DeliveryConsumer
{
    use GetRevisionTrait;

    protected ?int $revision_number = null;
    protected string $file_name = '';
    protected StorableResource $resource;
    protected StreamAccess $stream_access;
    protected FileNamePolicy $file_name_policy;

    public function __construct(
        StorableResource $resource,
        StreamAccess $stream_access,
        FileNamePolicy $file_name_policy
    ) {
        $this->resource = $resource;
        $this->stream_access = $stream_access;
        $this->file_name_policy = $file_name_policy;
        $this->file_name = $resource->getCurrentRevision()->getInformation()->getTitle();
    }

    abstract public function run(): void;

    public function setRevisionNumber(int $revision_number): DeliveryConsumer
    {
        $this->revision_number = $revision_number;
        return $this;
    }

    public function overrideFileName(string $file_name): DeliveryConsumer
    {
        $this->file_name = $file_name;
        return $this;
    }
}