Inheritance diagram for ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer:

Collaboration diagram for ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer:

Public Member Functions
	__construct (array $resources, StreamAccess $stream_access, FileNamePolicy $file_name_policy, string $zip_file_name)

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

	useRevisionTitlesForFileNames (bool $use_revision_titles)

	setRevisionNumber (int $revision_number)

	overrideFileName (string $file_name)

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

	setRevisionNumber (int $revision_number)

	overrideFileName (string $file_name)

Protected Attributes
ResourceCollection	$collection

int	$revision_number = null

bool	$use_revision_titles = false

array	$resources

FileNamePolicy	$file_name_policy

string	$zip_file_name

Private Attributes
StreamAccess	$stream_access

Detailed Description

Definition at line 34 of file DownloadMultipleConsumer.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer::__construct	(	array	$resources,
		StreamAccess	$stream_access,
		FileNamePolicy	$file_name_policy,
		string	$zip_file_name
	)

Parameters

\ILIAS\ResourceStorage\Resource\StorableResource[] $resources

Definition at line 50 of file DownloadMultipleConsumer.php.

      {
        $this->resources = $resources;
        $this->stream_access = $stream_access;
        $this->file_name_policy = $file_name_policy;
        $this->zip_file_name = $zip_file_name;
    }

References ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer\$file_name_policy, ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer\$resources, ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer\$stream_access, and ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer\$zip_file_name.

Member Function Documentation

◆ overrideFileName()

ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer::overrideFileName ( string $file_name )

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Definition at line 119 of file DownloadMultipleConsumer.php.

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

◆ run()

ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer::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 63 of file DownloadMultipleConsumer.php.

                         : void
    {
        global $DIC;
 
        $directory = CLIENT_DATA_DIR . '/temp';
        $temp = tempnam($directory, 'zip');
        $zip = new \ZipArchive();
        $zip->open($temp, \ZipArchive::CREATE | \ZipArchive::OVERWRITE);
 
        foreach ($this->resources as $resource) {
            $revision = $this->stream_access->populateRevision($resource->getCurrentRevision());
            if ($this->use_revision_titles) {
                $file_name = $this->file_name_policy->prepareFileNameForConsumer($revision->getTitle());
            } else {
                $file_name = $this->file_name_policy->prepareFileNameForConsumer(
                    $revision->getInformation()->getTitle()
                );
            }
 
            $zip->addFile($revision->maybeGetToken()->resolveStream()->getMetadata('uri'), $file_name);
        }
 
        $zip->close();
        $response = $DIC->http()->response();
        $response = $response->withHeader(ResponseHeader::CONTENT_TYPE, MimeType::APPLICATION__ZIP);
        $response = $response->withHeader(ResponseHeader::CONNECTION, 'close');
        $response = $response->withHeader(ResponseHeader::ACCEPT_RANGES, 'bytes');
        $response = $response->withHeader(
            ResponseHeader::CONTENT_DISPOSITION,
            'attachment'
            . '; filename="'
            . $this->zip_file_name
            . '"'
        );
        $fopen = fopen($temp, 'rb');
        $response = $response->withBody(Streams::ofResource($fopen));
        $DIC->http()->saveResponse($response);
        $DIC->http()->sendResponse();
        fclose($fopen);
        unlink($temp);
        $DIC->http()->close();
    }

References $DIC, $response, ILIAS\HTTP\Response\ResponseHeader\ACCEPT_RANGES, ILIAS\FileUpload\MimeType\APPLICATION__ZIP, CLIENT_DATA_DIR, ILIAS\HTTP\Response\ResponseHeader\CONNECTION, ILIAS\HTTP\Response\ResponseHeader\CONTENT_DISPOSITION, ILIAS\HTTP\Response\ResponseHeader\CONTENT_TYPE, and ILIAS\Filesystem\Stream\Streams\ofResource().

Here is the call graph for this function:

◆ setRevisionNumber()

ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer::setRevisionNumber ( int $revision_number )

Parameters

int $revision_number of a specific revision. otherwise the latest will be chosen during run()

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Definition at line 113 of file DownloadMultipleConsumer.php.

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

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

◆ useRevisionTitlesForFileNames()

ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer::useRevisionTitlesForFileNames ( bool $use_revision_titles )

Definition at line 107 of file DownloadMultipleConsumer.php.

                                                                            : self
    {
        $this->use_revision_titles = $use_revision_titles;
        return $this;
    }