BinaryFileResponseTestController.php

Same filename in other branches
  1. 11.x core/modules/system/tests/modules/binary_file_response_test/src/Controller/BinaryFileResponseTestController.php

Namespace

Drupal\binary_file_response_test\Controller

File

core/modules/system/tests/modules/binary_file_response_test/src/Controller/BinaryFileResponseTestController.php

View source
<?php

namespace Drupal\binary_file_response_test\Controller;

use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;

/**
 * Controller routines for binary file response tests.
 */
class BinaryFileResponseTestController {
    
    /**
     * Download the file set in the relative_file_url query parameter.
     *
     * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
     *   The response wrapping the file content.
     */
    public function download(Request $request) {
        if (!$request->query
            ->has('relative_file_url')) {
            throw new BadRequestHttpException();
        }
        $relative_file_url = $request->query
            ->get('relative_file_url');
        // A relative URL for a file contains '%20' instead of spaces. A relative
        // file path contains spaces.
        $relative_file_path = rawurldecode($relative_file_url);
        // Ensure the file path does not start with a slash to prevent exploring
        // the file system root.
        $relative_file_path = ltrim($relative_file_path, '/');
        return new BinaryFileResponse($relative_file_path);
    }

}

Classes

Title Deprecated Summary
BinaryFileResponseTestController Controller routines for binary file response tests.

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