summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/helpers
diff options
context:
space:
mode:
authorGeorge PETCULESCU <george.petculescu@zitec.com>2016-10-31 13:16:35 +0100
committerGeorge PETCULESCU <george.petculescu@zitec.com>2016-10-31 13:16:35 +0100
commit5d1c2123fdc575d70e9db38ce30b34d4b291469c (patch)
tree2691c5e83f1b36d02b673bacdbf1d5a98ff26254 /user_guide_src/source/helpers
parentb907c8ad41dfb4a9394b3a73182f0abf7fe14f94 (diff)
refactorised Docs (parts) of Download helper.
Diffstat (limited to 'user_guide_src/source/helpers')
-rw-r--r--user_guide_src/source/helpers/download_helper.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst
index 83182a256..e11d92a14 100644
--- a/user_guide_src/source/helpers/download_helper.rst
+++ b/user_guide_src/source/helpers/download_helper.rst
@@ -38,9 +38,10 @@ The following functions are available:
If you set the second parameter to NULL and ``$filename`` is an existing, readable
file path, then its content will be read instead. You may also set ``$filename``
- as an array containing a single entry, the key being the existing, readable file path
- and the value as the downloading file name.
-
+ as an associative array with a single element, where the key of that element would be
+ the local file you are trying to read and where the value is the name of the downloadable
+ file that will be sent to browser. An example of this is provided below.
+
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.