diff options
author | Eric Barnes <eric@ericlbarnes.com> | 2011-11-27 06:30:22 +0100 |
---|---|---|
committer | Eric Barnes <eric@ericlbarnes.com> | 2011-11-27 06:30:22 +0100 |
commit | 7e66dda705743cbfe1d522ddb73e5694006ec42c (patch) | |
tree | c08b63deb28c09ec49d9173280f1ca234debfe50 /user_guide_src/source/helpers/download_helper.rst | |
parent | 7eceb03f083643254c7393c6b5ebe539e344a1ba (diff) | |
parent | e101593561a10632c1d63180436b19f1d7115046 (diff) |
Merge branch 'refs/heads/develop' into feature/unit-tests
Conflicts:
user_guide/helpers/number_helper.html
Diffstat (limited to 'user_guide_src/source/helpers/download_helper.rst')
-rw-r--r-- | user_guide_src/source/helpers/download_helper.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst new file mode 100644 index 000000000..e6094dc6b --- /dev/null +++ b/user_guide_src/source/helpers/download_helper.rst @@ -0,0 +1,42 @@ +############### +Download Helper +############### + +The Download Helper lets you download data to your desktop. + +.. contents:: Page Contents + +Loading this Helper +=================== + +This helper is loaded using the following code + +:: + + $this->load->helper('download'); + +The following functions are available: + +force_download('filename', '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. Example + +:: + + $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 +read the file into a string + +:: + + $data = file_get_contents("/path/to/photo.jpg"); // Read the file's contents + $name = 'myphoto.jpg'; + force_download($name, $data); + |