ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder Class Reference

Inheritance diagram for ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder:

Collaboration diagram for ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder:

Public Member Functions
	__construct (private string $external_data_dir)
	getName ()
	buildForStream (ServerRequestInterface $request, ResponseInterface $response, FileStream $stream,)
	supportPartial ()
	supportStreaming ()
	supportFileDeletion ()
	supportsInlineDelivery ()
	supportsAttachmentDelivery ()
	getName ()
	buildForStream (ServerRequestInterface $request, ResponseInterface $response, FileStream $stream,)
	supportStreaming ()
	supportPartial ()
	supportFileDeletion ()
	supportsInlineDelivery ()
	supportsAttachmentDelivery ()

Private Attributes
const	DATA = 'data'
const	SECURED_DATA = 'secured-data'
const	SECURED_EXT_DATA = 'secured-ext-data'
const	X_ACCEL_REDIRECT_HEADER = 'X-Accel-Redirect'

Detailed Description

Author

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

Definition at line 30 of file XAccelResponseBuilder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::__construct

(

private string

$external_data_dir

)

Definition at line 49 of file XAccelResponseBuilder.php.

    {
        $this->external_data_dir = rtrim($this->external_data_dir, '/') . '/';
    }

Member Function Documentation

buildForStream()

ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::buildForStream	(	ServerRequestInterface	$request,
		ResponseInterface	$response,
		FileStream	$stream
	)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 59 of file XAccelResponseBuilder.php.

     : ResponseInterface {
        $path_to_file = $stream->getMetadata('uri');
        if (str_starts_with((string) $path_to_file, './' . self::DATA . '/')) {
            $path_to_file = str_replace(
                './' . self::DATA . '/',
                '/' . self::SECURED_DATA
                . '/',
                $path_to_file
            );
        } elseif (str_starts_with((string) $path_to_file, $this->external_data_dir)) {
            $path_to_file = str_replace(
                $this->external_data_dir,
                '/' . self::SECURED_EXT_DATA . '/',
                $path_to_file
            );
        }
 
        return $response->withHeader(
            self::X_ACCEL_REDIRECT_HEADER,
            $path_to_file
        );
    }

References ILIAS\FileDelivery\Delivery\$path_to_file, and ILIAS\MetaData\Paths\Filters\DATA.

getName()

ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::getName

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 54 of file XAccelResponseBuilder.php.

                             : string
    {
        return 'x-accel';
    }

supportFileDeletion()

ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::supportFileDeletion

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 96 of file XAccelResponseBuilder.php.

                                         : bool
    {
        return false;
    }

supportPartial()

ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::supportPartial

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 86 of file XAccelResponseBuilder.php.

                                    : bool
    {
        return true;
    }

supportsAttachmentDelivery()

ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::supportsAttachmentDelivery

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 106 of file XAccelResponseBuilder.php.

                                                : bool
    {
        return true;
    }

supportsInlineDelivery()

ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::supportsInlineDelivery

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 101 of file XAccelResponseBuilder.php.

                                            : bool
    {
        return true;
    }

supportStreaming()

ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::supportStreaming

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 91 of file XAccelResponseBuilder.php.

                                      : bool
    {
        return true;
    }

Field Documentation

DATA

const ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::DATA = 'data'

private

Definition at line 35 of file XAccelResponseBuilder.php.

SECURED_DATA

const ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::SECURED_DATA = 'secured-data'

private

Definition at line 39 of file XAccelResponseBuilder.php.

SECURED_EXT_DATA

const ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::SECURED_EXT_DATA = 'secured-ext-data'

private

Definition at line 43 of file XAccelResponseBuilder.php.

X_ACCEL_REDIRECT_HEADER

const ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder::X_ACCEL_REDIRECT_HEADER = 'X-Accel-Redirect'

private

Definition at line 47 of file XAccelResponseBuilder.php.

---

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

• components/ILIAS/FileDelivery/src/Delivery/ResponseBuilder/XAccelResponseBuilder.php