VendorFileDownloadControllerInterface.php in Vendor Stream Wrapper 8

Namespace

Drupal\vendor_stream_wrapper\Controller

File

src/Controller/VendorFileDownloadControllerInterface.php

<?php

namespace Drupal\vendor_stream_wrapper\Controller;

use Symfony\Component\HttpFoundation\Request;

/**
 * Vendor Stream Wrapper file controller interface.
 *
 * Sets up serving of files from the vendor directory, using the vendor://
 * stream wrapper.
 */
interface VendorFileDownloadControllerInterface {

  /**
   * Handles vendor file transfers.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
   *   The transferred file as response.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   Thrown when the requested file does not exist.
   */
  public function download(Request $request);

}

Interfaces

Name	Description
VendorFileDownloadControllerInterface	Vendor Stream Wrapper file controller interface.