ILIAS\ResourceStorage\Consumer\BaseConsumer Class Reference

Inheritance diagram for ILIAS\ResourceStorage\Consumer\BaseConsumer:

Collaboration diagram for ILIAS\ResourceStorage\Consumer\BaseConsumer:

Public Member Functions
	__construct (protected StorableResource $resource, protected StreamAccess $stream_access, protected FileNamePolicy $file_name_policy)
	DownloadConsumer constructor. More...
	run ()
	This runs the actual DeliveryConsumer. More...
	setRevisionNumber (int $revision_number)
	@inheritDoc More...
	overrideFileName (string $file_name)
	run ()
	This runs the actual DeliveryConsumer. More...
	setRevisionNumber (int $revision_number)
	overrideFileName (string $file_name)

Protected Attributes
int	$revision_number = null
string	$file_name = ''

Detailed Description

Definition at line 31 of file BaseConsumer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Consumer\BaseConsumer::__construct	(	protected StorableResource	$resource,
		protected StreamAccess	$stream_access,
		protected FileNamePolicy	$file_name_policy
	)

DownloadConsumer constructor.

Definition at line 41 of file BaseConsumer.php.

      {
        $this->file_name = $this->resource->getCurrentRevision()->getInformation()->getTitle();
    }

Member Function Documentation

overrideFileName()

ILIAS\ResourceStorage\Consumer\BaseConsumer::overrideFileName

(

string

$file_name

)

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Definition at line 60 of file BaseConsumer.php.

                                                       : DeliveryConsumer
    {
        $this->file_name = $file_name;
        return $this;
    }

References ILIAS\ResourceStorage\Consumer\BaseConsumer\$file_name.

run()

ILIAS\ResourceStorage\Consumer\BaseConsumer::run ( )

abstract

This runs the actual DeliveryConsumer.

E.g. a DownloadConsumer will pass the Stream of a Ressource to the HTTP-Service and download the file.

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Reimplemented in ILIAS\ResourceStorage\Consumer\AbsolutePathConsumer, and ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer.

setRevisionNumber()

ILIAS\ResourceStorage\Consumer\BaseConsumer::setRevisionNumber

(

int

$revision_number

)

@inheritDoc

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Definition at line 54 of file BaseConsumer.php.

                                                           : DeliveryConsumer
    {
        $this->revision_number = $revision_number;
        return $this;
    }

References ILIAS\ResourceStorage\Consumer\BaseConsumer\$revision_number.

Field Documentation

$file_name

string ILIAS\ResourceStorage\Consumer\BaseConsumer::$file_name = ''

protected

Definition at line 36 of file BaseConsumer.php.

Referenced by ILIAS\ResourceStorage\Consumer\BaseConsumer\overrideFileName().

$revision_number

int ILIAS\ResourceStorage\Consumer\BaseConsumer::$revision_number = null

protected

Definition at line 35 of file BaseConsumer.php.

Referenced by ILIAS\ResourceStorage\Consumer\BaseConsumer\setRevisionNumber().

---

The documentation for this class was generated from the following file:

• components/ILIAS/ResourceStorage/src/Consumer/BaseConsumer.php