diff options
Diffstat (limited to 'user_guide_src/source/libraries')
| -rw-r--r-- | user_guide_src/source/libraries/file_uploading.rst | 92 |
1 files changed, 29 insertions, 63 deletions
diff --git a/user_guide_src/source/libraries/file_uploading.rst b/user_guide_src/source/libraries/file_uploading.rst index 51dd0d5e2..90efca95d 100644 --- a/user_guide_src/source/libraries/file_uploading.rst +++ b/user_guide_src/source/libraries/file_uploading.rst @@ -187,69 +187,35 @@ Preferences The following preferences are available. The default value indicates what will be used if you do not specify that preference. -Preference -Default Value -Options -Description -**upload_path** -None -None -The path to the folder where the upload should be placed. The folder -must be writable and the path can be absolute or relative. -**allowed_types** -None -None -The mime types corresponding to the types of files you allow to be -uploaded. Usually the file extension can be used as the mime type. -Separate multiple types with a pipe. -**file_name** -None -Desired file name -If set CodeIgniter will rename the uploaded file to this name. The -extension provided in the file name must also be an allowed file type. - -**overwrite** -FALSE -TRUE/FALSE (boolean) -If set to true, if a file with the same name as the one you are -uploading exists, it will be overwritten. If set to false, a number will -be appended to the filename if another with the same name exists. -**max_size** -0 -None -The maximum size (in kilobytes) that the file can be. Set to zero for no -limit. Note: Most PHP installations have their own limit, as specified -in the php.ini file. Usually 2 MB (or 2048 KB) by default. -**max_width** -0 -None -The maximum width (in pixels) that the file can be. Set to zero for no -limit. -**max_height** -0 -None -The maximum height (in pixels) that the file can be. Set to zero for no -limit. -**max_filename** -0 -None -The maximum length that a file name can be. Set to zero for no limit. -**max_filename_increment** -100 -None -When overwrite is set to FALSE, use this to set the maximum filename -increment for CodeIgniter to append to the filename. -**encrypt_name** -FALSE -TRUE/FALSE (boolean) -If set to TRUE the file name will be converted to a random encrypted -string. This can be useful if you would like the file saved with a name -that can not be discerned by the person uploading it. -**remove_spaces** -TRUE -TRUE/FALSE (boolean) -If set to TRUE, any spaces in the file name will be converted to -underscores. This is recommended. +============================ ================= ======================= ====================================================================== +Preference Default Value Options Description +============================ ================= ======================= ====================================================================== +**upload_path** None None The path to the folder where the upload should be placed. The folder + must be writable and the path can be absolute or relative. +**allowed_types** None None The mime types corresponding to the types of files you allow to be + uploaded. Usually the file extension can be used as the mime type. + Separate multiple types with a pipe. +**file_name** None Desired file name If set CodeIgniter will rename the uploaded file to this name. The + extension provided in the file name must also be an allowed file type. +**overwrite** FALSE TRUE/FALSE (boolean) If set to true, if a file with the same name as the one you are + uploading exists, it will be overwritten. If set to false, a number will + be appended to the filename if another with the same name exists. +**max_size** 0 None The maximum size (in kilobytes) that the file can be. Set to zero for no + limit. Note: Most PHP installations have their own limit, as specified + in the php.ini file. Usually 2 MB (or 2048 KB) by default. +**max_width** 0 None The maximum width (in pixels) that the file can be. Set to zero for no + limit. +**max_height** 0 None The maximum height (in pixels) that the file can be. Set to zero for no + limit. +**max_filename** 0 None The maximum length that a file name can be. Set to zero for no limit. +**max_filename_increment** 100 None When overwrite is set to FALSE, use this to set the maximum filename + increment for CodeIgniter to append to the filename. +**encrypt_name** FALSE TRUE/FALSE (boolean) If set to TRUE the file name will be converted to a random encrypted + string. This can be useful if you would like the file saved with a name + that can not be discerned by the person uploading it. +**remove_spaces** TRUE TRUE/FALSE (boolean) If set to TRUE, any spaces in the file name will be converted to + underscores. This is recommended. +============================ ================= ======================= ====================================================================== Setting preferences in a config file ==================================== |