XSendFileResponseBuilder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\FileDelivery\Delivery\ResponseBuilder;

use Psr\Http\Message\ResponseInterface;
use ILIAS\Filesystem\Stream\FileStream;
use Psr\Http\Message\ServerRequestInterface;

class XSendFileResponseBuilder implements ResponseBuilder
{
    private const X_SENDFILE_HEADER = 'X-Sendfile';

    public function getName(): string
    {
        return 'xsendfile';
    }

    public function buildForStream(
        ServerRequestInterface $request,
        ResponseInterface $response,
        FileStream $stream,
    ): ResponseInterface {
        return $response->withHeader(
            self::X_SENDFILE_HEADER,
            $stream->getMetadata('uri')
        );
    }

    public function supportPartial(): bool
    {
        return true;
    }

    public function supportStreaming(): bool
    {
        return true;
    }

    public function supportFileDeletion(): bool
    {
        return false;
    }

    public function supportsInlineDelivery(): bool
    {
        return true;
    }

    public function supportsAttachmentDelivery(): bool
    {
        return true;
    }
}