ILIAS\ResourceStorage\Consumer\DownloadConsumer Class Reference

Inheritance diagram for ILIAS\ResourceStorage\Consumer\DownloadConsumer:

Collaboration diagram for ILIAS\ResourceStorage\Consumer\DownloadConsumer:

Public Member Functions
	run ()
	This runs the actual DeliveryConsumer. More...
Public Member Functions inherited from ILIAS\ResourceStorage\Consumer\BaseConsumer
	__construct (StorableResource $resource, StorageHandler $storage_handler, 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)

Additional Inherited Members
Protected Attributes inherited from ILIAS\ResourceStorage\Consumer\BaseConsumer
	$storage_handler
	$resource
	$revision_number = null
	$file_name_policy
	$file_name = ''

Detailed Description

Definition at line 11 of file DownloadConsumer.php.

Member Function Documentation

run()

ILIAS\ResourceStorage\Consumer\DownloadConsumer::run

(

)

This runs the actual DeliveryConsumer.

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

Reimplemented from ILIAS\ResourceStorage\Consumer\BaseConsumer.

Definition at line 14 of file DownloadConsumer.php.

                          : void
    {
        global $DIC;
 
        $revision = $this->getRevision();
 
        $file_name = $this->file_name_policy->prepareFileNameForConsumer($this->file_name ?? $revision->getInformation()->getTitle());
        $mime_type = $revision->getInformation()->getMimeType();
 
        $response = $DIC->http()->response();
        if ($this->file_name_policy->isValidExtension($revision->getInformation()->getSuffix())) {
            $response = $response->withHeader(ResponseHeader::CONTENT_TYPE, $mime_type);
        } else {
            $response = $response->withHeader(ResponseHeader::CONTENT_TYPE, 'application/octet-stream');
        }
        $response = $response->withHeader(ResponseHeader::CONNECTION, 'close');
        $response = $response->withHeader(ResponseHeader::ACCEPT_RANGES, 'bytes');
        $response = $response->withHeader(
            ResponseHeader::CONTENT_DISPOSITION,
            'attachment'
            . '; filename="'
            . $file_name
            . '"'
        );
        $response = $response->withBody($this->storage_handler->getStream($revision));
 
        $DIC->http()->saveResponse($response);
        $DIC->http()->sendResponse();
        $DIC->http()->close();
    }

References $DIC, ILIAS\ResourceStorage\Consumer\BaseConsumer\$file_name, $response, ILIAS\HTTP\Response\ResponseHeader\ACCEPT_RANGES, ILIAS\HTTP\Response\ResponseHeader\CONNECTION, ILIAS\HTTP\Response\ResponseHeader\CONTENT_DISPOSITION, and ILIAS\HTTP\Response\ResponseHeader\CONTENT_TYPE.

---

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

• src/ResourceStorage/Consumer/DownloadConsumer.php