typo3/sysext/core/Classes/Resource/Driver/StreamableDriverInterface.php

   1 <?php
   2 declare(strict_types = 1);
   3
   4 namespace TYPO3\CMS\Core\Resource\Driver;
   5
   6 /*
   7  * This file is part of the TYPO3 CMS project.
   8  *
   9  * It is free software; you can redistribute it and/or modify it under
  10  * the terms of the GNU General Public License, either version 2
  11  * of the License, or any later version.
  12  *
  13  * For the full copyright and license information, please read the
  14  * LICENSE.txt file that was distributed with this source code.
  15  *
  16  * The TYPO3 project - inspiring people to share!
  17  */
  18
  19 use Psr\Http\Message\ResponseInterface;
  20
  21 /**
  22  * An interface FAL drivers have to implement to fulfil the needs
  23  * of streaming files using PSR-7 Response objects.
  24  *
  25  * @internal
  26  */
  27 interface StreamableDriverInterface
  28 {
  29     /**
  30      * Streams a file using a PSR-7 Response object.
  31      *
  32      * @param string $identifier
  33      * @param array $properties
  34      * @return ResponseInterface
  35      */
  36     public function streamFile(string $identifier, array $properties): ResponseInterface;
  37 }