Skip to content
Browse files

Added description for function force_download_large

  • Loading branch information...
1 parent 8266b66 commit 5ac7215597068223f483844fd14707007c9de36b @tschechniker committed Apr 12, 2012
Showing with 12 additions and 0 deletions.
  1. +12 −0 user_guide_src/source/helpers/download_helper.rst
View
12 user_guide_src/source/helpers/download_helper.rst
@@ -40,3 +40,15 @@ read the file into a string
$name = 'myphoto.jpg';
force_download($name, $data);
+
+force_download_large('filepath')
+================================
+
+Generates server headers and reads the file in chunks which force data to be downloaded
+to your desktop. Useful with large file downloads. The first parameter is the **filepath where
+the file is on your local filesystem. It returns true if the download was successful.
+Example
+
+::
+ $filepath = "/var/www/test.iso";
+ force_download_large($filepath);

0 comments on commit 5ac7215

Please sign in to comment.
Something went wrong with that request. Please try again.