From b3273e9cc2427360c4bf3a10eade2654cd35b8ee Mon Sep 17 00:00:00 2001 From: mark_story Date: Thu, 11 Jul 2013 20:59:52 -0400 Subject: [PATCH] Correct documentation. Options are traditionally above the @param block as it results in easier to read API docs. --- lib/Cake/Network/CakeResponse.php | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/lib/Cake/Network/CakeResponse.php b/lib/Cake/Network/CakeResponse.php index cc629d672..686ab0476 100644 --- a/lib/Cake/Network/CakeResponse.php +++ b/lib/Cake/Network/CakeResponse.php @@ -1206,13 +1206,18 @@ class CakeResponse { } /** - * Setup for display or download the given file + * Setup for display or download the given file. + * + * If $_SERVER['HTTP_RANGE'] is set a slice of the file will be + * returned instead of the entire file. + * + * ### Options keys + * + * - name: Alternate download name + * - download: If `true` sets download header and forces file to be downloaded rather than displayed in browser * * @param string $path Path to file - * @param array $options Options - * ### Options keys - * - name: Alternate download name - * - download: If `true` sets download header and forces file to be downloaded rather than displayed in browser + * @param array $options Options See above. * @return void * @throws NotFoundException */ @@ -1283,7 +1288,6 @@ class CakeResponse { $this->header('Content-Length', $fileSize); } $this->_clearBuffer(); - $this->_file = $file; }