Inheritance diagram for ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer:

Collaboration diagram for ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer:

Public Member Functions
	__construct (\ILIAS\HTTP\Services $http, StorableResource $resource, StreamAccess $stream_access, FileNamePolicy $file_name_policy)

	run ()
	This runs the actual DeliveryConsumer. More...

Public Member Functions inherited from ILIAS\ResourceStorage\Consumer\BaseConsumer
	__construct (StorableResource $resource, StreamAccess $stream_access, FileNamePolicy $file_name_policy)
	DownloadConsumer constructor. More...

	run ()
	This runs the actual DeliveryConsumer. More...

	setRevisionNumber (int $revision_number)

	overrideFileName (string $file_name)

Protected Member Functions
	getDisposition ()

Private Attributes
const	NON_VALID_EXTENSION_MIME = \ILIAS\FileUpload\MimeType::APPLICATION__OCTET_STREAM

ILIAS HTTP Services	$http

ILIAS FileDelivery Delivery StreamDelivery	$delivery

Additional Inherited Members
Protected Attributes inherited from ILIAS\ResourceStorage\Consumer\BaseConsumer
int	$revision_number = null

string	$file_name = ''

StorableResource	$resource

StreamAccess	$stream_access

FileNamePolicy	$file_name_policy

Detailed Description

Definition at line 31 of file BaseHTTPResponseBasedConsumer.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer::__construct	(	\ILIAS\HTTP\Services	$http,
		StorableResource	$resource,
		StreamAccess	$stream_access,
		FileNamePolicy	$file_name_policy
	)

Definition at line 38 of file BaseHTTPResponseBasedConsumer.php.

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), and ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\getDisposition().

       {
         global $DIC;
         $this->delivery = $DIC->fileDelivery()->delivery();
         parent::__construct($resource, $stream_access, $file_name_policy);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDisposition()

ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer::getDisposition ( )

abstractprotected

Referenced by ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\__construct(), and ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\run().

Here is the caller graph for this function:

◆ run()

ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer::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.

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Definition at line 51 of file BaseHTTPResponseBasedConsumer.php.

References ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\getDisposition().

                          : void
     {
         $revision = $this->getRevision();
         $filename_with_extension = $this->file_name ?? $revision->getInformation()->getTitle();
         $extension = pathinfo($filename_with_extension, PATHINFO_EXTENSION);
         $file_name_for_consumer = $this->file_name_policy->prepareFileNameForConsumer($filename_with_extension);
 
         $mime_type = $this->file_name_policy->isValidExtension($extension)
             ? $revision->getInformation()->getMimeType()
             : self::NON_VALID_EXTENSION_MIME;
 
         // Build Response
         $revision = $this->stream_access->populateRevision($revision);
 
         switch ($this->getDisposition()) {
             case 'attachment':
                 $this->delivery->attached(
                     $revision->maybeStreamResolver()?->getStream(),
                     $file_name_for_consumer,
                     $mime_type
                 );
                 break;
             case 'inline':
                 $this->delivery->inline(
                     $revision->maybeStreamResolver()?->getStream(),
                     $file_name_for_consumer,
                     $mime_type
                 );
                 break;
             default:
                 throw new \InvalidArgumentException('Invalid disposition');
         }
     }