diff options
author | Timothy Warren <tim@timshomepage.net> | 2011-10-06 03:47:59 +0200 |
---|---|---|
committer | Timothy Warren <tim@timshomepage.net> | 2011-10-06 03:47:59 +0200 |
commit | fb7ff742949e0474dfba30be45be513b3b4f63cc (patch) | |
tree | 87b150fd502d0789f9660ca4dc2ace44817813c3 /user_guide_src/source/helpers/download_helper.rst | |
parent | f7a8d86dbc6805a4e52964bbea76738df75b5f35 (diff) | |
parent | ec8abee24f456b09ab9d53e88853fe6bd0f7879a (diff) |
Merge branch 'develop' of git://github.com/EllisLab/CodeIgniter into develop
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); + |