From 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 13:34:52 -0500 Subject: replacing the old HTML user guide with a Sphinx-managed user guide --- user_guide_src/source/general/common_functions.rst | 71 ++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 user_guide_src/source/general/common_functions.rst (limited to 'user_guide_src/source/general/common_functions.rst') diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst new file mode 100644 index 000000000..73b6bccb1 --- /dev/null +++ b/user_guide_src/source/general/common_functions.rst @@ -0,0 +1,71 @@ +################ +Common Functions +################ + +CodeIgniter uses a few functions for its operation that are globally +defined, and are available to you at any point. These do not require +loading any libraries or helpers. + +is_php('version_number') +========================== + +is_php() determines of the PHP version being used is greater than the +supplied version_number. + +:: + + if (is_php('5.3.0')) {     $str = quoted_printable_encode($str); } + +Returns boolean TRUE if the installed version of PHP is equal to or +greater than the supplied version number. Returns FALSE if the installed +version of PHP is lower than the supplied version number. + +is_really_writable('path/to/file') +==================================== + +is_writable() returns TRUE on Windows servers when you really can't +write to the file as the OS reports to PHP as FALSE only if the +read-only attribute is marked. This function determines if a file is +actually writable by attempting to write to it first. Generally only +recommended on platforms where this information may be unreliable. + +:: + + if (is_really_writable('file.txt')) {     echo "I could write to this if I wanted to"; } else {     echo "File is not writable"; } + +config_item('item_key') +========================= + +The :doc:`Config library <../libraries/config>` is the preferred way of +accessing configuration information, however config_item() can be used +to retrieve single keys. See Config library documentation for more +information. + +show_error('message'), show_404('page'), log_message('level', +'message') +========== + +These are each outlined on the :doc:`Error Handling ` page. + +set_status_header(code, 'text'); +================================== + +Permits you to manually set a server status header. Example:: + + set_status_header(401); // Sets the header as: Unauthorized + +`See here `_ for +a full list of headers. + +remove_invisible_characters($str) +=================================== + +This function prevents inserting null characters between ascii +characters, like Java\\0script. + +html_escape($mixed) +==================== + +This function provides short cut for htmlspecialchars() function. It +accepts string and array. To prevent Cross Site Scripting (XSS), it is +very useful. -- cgit v1.2.3-24-g4f1b From 46715e5ca1451de2faa32b5866c37a40c8051423 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 17:36:22 -0500 Subject: fixing code spacing in Common and CLI docs --- user_guide_src/source/general/common_functions.rst | 24 +++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) (limited to 'user_guide_src/source/general/common_functions.rst') diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst index 73b6bccb1..70563b8d2 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -14,7 +14,10 @@ supplied version_number. :: - if (is_php('5.3.0')) {     $str = quoted_printable_encode($str); } + if (is_php('5.3.0')) + { + $str = quoted_printable_encode($str); + } Returns boolean TRUE if the installed version of PHP is equal to or greater than the supplied version number. Returns FALSE if the installed @@ -31,7 +34,14 @@ recommended on platforms where this information may be unreliable. :: - if (is_really_writable('file.txt')) {     echo "I could write to this if I wanted to"; } else {     echo "File is not writable"; } + if (is_really_writable('file.txt')) + { + echo "I could write to this if I wanted to"; + } + else + { + echo "File is not writable"; + } config_item('item_key') ========================= @@ -41,18 +51,18 @@ accessing configuration information, however config_item() can be used to retrieve single keys. See Config library documentation for more information. -show_error('message'), show_404('page'), log_message('level', -'message') -========== +show_error('message'), show_404('page'), log_message('level', 'message') +======================================================================== These are each outlined on the :doc:`Error Handling ` page. set_status_header(code, 'text'); -================================== +================================ Permits you to manually set a server status header. Example:: - set_status_header(401); // Sets the header as: Unauthorized + set_status_header(401); + // Sets the header as: Unauthorized `See here `_ for a full list of headers. -- cgit v1.2.3-24-g4f1b From 6ef498b49946ba74d610b3805fb908b163a7f03a Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Tue, 5 Jun 2012 22:01:58 +0300 Subject: Added get_mimes() function to system/core/Commons.php.The MIMEs array from config/mimes.php is used by multiple core classes, libraries and helpers and each of them has implemented an own way of getting it, which is not needed and is hard to maintain. This also fixes issue #1411 --- user_guide_src/source/general/common_functions.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'user_guide_src/source/general/common_functions.rst') diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst index 70563b8d2..99126f900 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -79,3 +79,8 @@ html_escape($mixed) This function provides short cut for htmlspecialchars() function. It accepts string and array. To prevent Cross Site Scripting (XSS), it is very useful. + +get_mimes() +============= + +This function returns the MIMEs array from config/mimes.php. \ No newline at end of file -- cgit v1.2.3-24-g4f1b