summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/helpers
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide_src/source/helpers')
-rw-r--r--user_guide_src/source/helpers/download_helper.rst48
1 files changed, 27 insertions, 21 deletions
diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst
index fd95f4f34..17b68f454 100644
--- a/user_guide_src/source/helpers/download_helper.rst
+++ b/user_guide_src/source/helpers/download_helper.rst
@@ -4,7 +4,12 @@ Download Helper
The Download Helper lets you download data to your desktop.
-.. contents:: Page Contents
+.. contents::
+ :local:
+
+.. raw:: html
+
+ <div class="custom-index container"></div>
Loading this Helper
===================
@@ -13,38 +18,39 @@ This helper is loaded using the following code::
$this->load->helper('download');
+Available Functions
+===================
+
The following functions are available:
-force_download()
-================
-.. function:: force_download($filename = '', $data = '', $set_mime = FALSE)
+.. function:: force_download([$filename = ''[, $data = ''[, $set_mime = FALSE]]])
:param string $filename: Filename
:param mixed $data: File contents
:param bool $set_mime: Whether to try to send the actual MIME type
:returns: void
-Generates server headers which force data to be downloaded to your
-desktop. Useful with file downloads. The first parameter is the **name
-you want the downloaded file to be named**, the second parameter is the
-file data.
+ Generates server headers which force data to be downloaded to your
+ desktop. Useful with file downloads. The first parameter is the **name
+ you want the downloaded file to be named**, the second parameter is the
+ file data.
-If you set the second parameter to NULL and ``$filename`` is an existing, readable
-file path, then its content will be read instead.
+ If you set the second parameter to NULL and ``$filename`` is an existing, readable
+ file path, then its content will be read instead.
-If you set the third parameter to boolean TRUE, then the actual file MIME type
-(based on the filename extension) will be sent, so that if your browser has a
-handler for that type - it can use it.
+ If you set the third parameter to boolean TRUE, then the actual file MIME type
+ (based on the filename extension) will be sent, so that if your browser has a
+ handler for that type - it can use it.
-Example::
+ Example::
- $data = 'Here is some text!';
- $name = 'mytext.txt';
- force_download($name, $data);
+ $data = 'Here is some text!';
+ $name = 'mytext.txt';
+ force_download($name, $data);
-If you want to download an existing file from your server you'll need to
-do the following::
+ If you want to download an existing file from your server you'll need to
+ do the following::
- // Contents of photo.jpg will be automatically read
- force_download('/path/to/photo.jpg', NULL); \ No newline at end of file
+ // Contents of photo.jpg will be automatically read
+ force_download('/path/to/photo.jpg', NULL); \ No newline at end of file