class FileDownloadController

Same name in other branches
  1. 9 core/modules/system/src/FileDownloadController.php \Drupal\system\FileDownloadController
  2. 10 core/modules/system/src/FileDownloadController.php \Drupal\system\FileDownloadController
  3. 11.x core/modules/system/src/FileDownloadController.php \Drupal\system\FileDownloadController

System file controller.

Hierarchy

Expanded class hierarchy of FileDownloadController

2 files declare their use of FileDownloadController
ConfigController.php in core/modules/config/src/Controller/ConfigController.php
ImageStyleDownloadController.php in core/modules/image/src/Controller/ImageStyleDownloadController.php

File

core/modules/system/src/FileDownloadController.php, line 16

Namespace

Drupal\system
View source
class FileDownloadController extends ControllerBase {
    
    /**
     * The stream wrapper manager.
     *
     * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
     */
    protected $streamWrapperManager;
    
    /**
     * FileDownloadController constructor.
     *
     * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $streamWrapperManager
     *   The stream wrapper manager.
     */
    public function __construct(StreamWrapperManagerInterface $streamWrapperManager = NULL) {
        if (!$streamWrapperManager) {
            @trigger_error('Calling FileDownloadController::__construct() without the $streamWrapperManager argument is deprecated in drupal:8.8.0. The $streamWrapperManager argument will be required in drupal:9.0.0. See https://www.drupal.org/node/3035273', E_USER_DEPRECATED);
            $streamWrapperManager = \Drupal::service('stream_wrapper_manager');
        }
        $this->streamWrapperManager = $streamWrapperManager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('stream_wrapper_manager'));
    }
    
    /**
     * Handles private file transfers.
     *
     * Call modules that implement hook_file_download() to find out if a file is
     * accessible and what headers it should be transferred with. If one or more
     * modules returned headers the download will start with the returned headers.
     * If a module returns -1 an AccessDeniedHttpException will be thrown. If the
     * file exists but no modules responded an AccessDeniedHttpException will be
     * thrown. If the file does not exist a NotFoundHttpException will be thrown.
     *
     * @see hook_file_download()
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The request object.
     * @param string $scheme
     *   The file scheme, defaults to 'private'.
     *
     * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
     *   The transferred file as response.
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *   Thrown when the requested file does not exist.
     * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
     *   Thrown when the user does not have access to the file.
     */
    public function download(Request $request, $scheme = 'private') {
        $target = $request->query
            ->get('file');
        // Merge remaining path arguments into relative file path.
        $uri = $scheme . '://' . $target;
        if ($this->streamWrapperManager
            ->isValidScheme($scheme) && is_file($uri)) {
            // Let other modules provide headers and controls access to the file.
            $headers = $this->moduleHandler()
                ->invokeAll('file_download', [
                $uri,
            ]);
            foreach ($headers as $result) {
                if ($result == -1) {
                    throw new AccessDeniedHttpException();
                }
            }
            if (count($headers)) {
                // \Drupal\Core\EventSubscriber\FinishResponseSubscriber::onRespond()
                // sets response as not cacheable if the Cache-Control header is not
                // already modified. We pass in FALSE for non-private schemes for the
                // $public parameter to make sure we don't change the headers.
                return new BinaryFileResponse($uri, 200, $headers, $scheme !== 'private');
            }
            throw new AccessDeniedHttpException();
        }
        throw new NotFoundHttpException();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
FileDownloadController::$streamWrapperManager protected property The stream wrapper manager.
FileDownloadController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create 1
FileDownloadController::download public function Handles private file transfers.
FileDownloadController::__construct public function FileDownloadController constructor. 1
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.