ILIAS\FileDelivery\Delivery\BaseDelivery Class Reference

Inheritance diagram for ILIAS\FileDelivery\Delivery\BaseDelivery:

Collaboration diagram for ILIAS\FileDelivery\Delivery\BaseDelivery:

Public Member Functions
	__construct (protected Services $http, protected ResponseBuilder $response_builder, protected ResponseBuilder $fallback_response_builder,)

Protected Member Functions
	saveAndClose (ResponseInterface $r, string $path_to_delete=null)
	setGeneralHeaders (ResponseInterface $r, string $uri, string $mime_type, string $file_name, Disposition $disposition=Disposition::INLINE)

Protected Attributes
const	MIME_TYPE_MAP = __DIR__ . '/../../../FileUpload/src/mime_type_map.php'
array	$mime_type_map

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 31 of file BaseDelivery.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileDelivery\Delivery\BaseDelivery::__construct	(	protected Services	$http,
		protected ResponseBuilder	$response_builder,
		protected ResponseBuilder	$fallback_response_builder
	)

Definition at line 37 of file BaseDelivery.php.

      {
        if (is_readable(self::MIME_TYPE_MAP)) {
            $map = include self::MIME_TYPE_MAP;
        }
        $this->mime_type_map = $map ?? [];
    }

Member Function Documentation

saveAndClose()

ILIAS\FileDelivery\Delivery\BaseDelivery::saveAndClose ( ResponseInterface  $r, string  $path_to_delete = null  )

protected

Definition at line 48 of file BaseDelivery.php.

References ILIAS\FileDelivery\http().

Referenced by ILIAS\FileDelivery\Delivery\LegacyDelivery\deliver(), and ILIAS\FileDelivery\Delivery\StreamDelivery\deliver().

     : never {
        $sender = function () use ($r): void {
            $this->http->saveResponse($r);
            $this->http->sendResponse();
            $this->http->close();
        };

        if ($path_to_delete !== null && file_exists($path_to_delete)) {
            ignore_user_abort(true);
            set_time_limit(0);
            ob_start();

            $sender();

            ob_flush();
            ob_end_flush();
            flush();

            unlink($path_to_delete);
        } else {
            $sender();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setGeneralHeaders()

ILIAS\FileDelivery\Delivery\BaseDelivery::setGeneralHeaders ( ResponseInterface  $r, string  $uri, string  $mime_type, string  $file_name, Disposition  $disposition = Disposition::INLINE  )

protected

Definition at line 75 of file BaseDelivery.php.

References ILIAS\FileDelivery\Delivery\$disposition, ILIAS\HTTP\Response\ResponseHeader\CACHE_CONTROL, ILIAS\HTTP\Response\ResponseHeader\CONTENT_DISPOSITION, ILIAS\HTTP\Response\ResponseHeader\CONTENT_TYPE, and ILIAS\HTTP\Response\ResponseHeader\EXPIRES.

Referenced by ILIAS\FileDelivery\Delivery\LegacyDelivery\deliver(), ILIAS\FileDelivery\Delivery\StreamDelivery\deliver(), and ILIAS\FileDelivery\Delivery\StreamDelivery\deliverFromToken().

     : ResponseInterface {
        $r = $r->withHeader('X-ILIAS-FileDelivery-Method', $this->response_builder->getName());
        $r = $r->withHeader(ResponseHeader::CONTENT_TYPE, $mime_type);
        $r = $r->withHeader(
            ResponseHeader::CONTENT_DISPOSITION,
            $disposition->value . '; filename="' . $file_name . '"'
        );
        $r = $r->withHeader(ResponseHeader::CACHE_CONTROL, 'max-age=31536000, immutable, private');

        return $r->withHeader(
            ResponseHeader::EXPIRES,
            date("D, j M Y H:i:s", strtotime('+5 days')) . " GMT"
        );
    }

Here is the caller graph for this function:

Field Documentation

$mime_type_map

array ILIAS\FileDelivery\Delivery\BaseDelivery::$mime_type_map

protected

Definition at line 35 of file BaseDelivery.php.

MIME_TYPE_MAP

const ILIAS\FileDelivery\Delivery\BaseDelivery::MIME_TYPE_MAP = __DIR__ . '/../../../FileUpload/src/mime_type_map.php'

protected

Definition at line 33 of file BaseDelivery.php.

---

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

• components/ILIAS/FileDelivery/src/Delivery/BaseDelivery.php