From b8c283a695c8074a57d8c3dfa00934312638931d Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Fri, 19 Jul 2013 16:02:53 -0700 Subject: Dropping unecessary php: directive to function definitions in user guide --- user_guide_src/source/general/common_functions.rst | 24 +++++++++++----------- 1 file changed, 12 insertions(+), 12 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 32e8a8be0..8a57c183e 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -9,7 +9,7 @@ loading any libraries or helpers. is_php() ======== -.. php:function:: is_php($version = '5.3.0') +.. function:: is_php($version = '5.3.0') :param string $version: Version number :returns: bool @@ -31,7 +31,7 @@ version of PHP is lower than the supplied version number. is_really_writable() ==================== -.. php:function:: is_really_writable($file) +.. function:: is_really_writable($file) :param string $file: File path :returns: bool @@ -58,7 +58,7 @@ Example:: config_item() ============= -.. php:function:: config_item($key) +.. function:: config_item($key) :param string $key: Config item key :returns: mixed @@ -71,7 +71,7 @@ documentation for more information. show_error() ============ -.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') +.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') :param mixed $message: Error message :param int $status_code: HTTP Response status code @@ -84,7 +84,7 @@ please see the :doc:`Error Handling ` documentation. show_404() ========== -.. php:function:: show_404($page = '', $log_error = TRUE) +.. function:: show_404($page = '', $log_error = TRUE) :param string $page: URI string :param bool $log_error: Whether to log the error @@ -96,7 +96,7 @@ please see the :doc:`Error Handling ` documentation. log_message() ============= -.. php:function:: log_message($level, $message, $php_error = FALSE) +.. function:: log_message($level, $message, $php_error = FALSE) :param string $level: Log level: 'error', 'debug' or 'info' :param string $message: Message to log @@ -109,7 +109,7 @@ please see the :doc:`Error Handling ` documentation. set_status_header() =============================== -.. php:function:: set_status_header($code, $text = '') +.. function:: set_status_header($code, $text = '') :param int $code: HTTP Reponse status code :param string $text: A custom message to set with the status code @@ -126,7 +126,7 @@ a full list of headers. remove_invisible_characters() ============================= -.. php:function:: remove_invisible_characters($str, $url_encoded = TRUE) +.. function:: remove_invisible_characters($str, $url_encoded = TRUE) :param string $str: Input string :param bool $url_encoded: Whether to remove URL-encoded characters as well @@ -143,7 +143,7 @@ Example:: html_escape() ============= -.. php:function:: html_escape($var) +.. function:: html_escape($var) :param mixed $var: Variable to escape (string or array) @@ -157,7 +157,7 @@ It is useful in preventing Cross Site Scripting (XSS). get_mimes() =========== -.. php:function:: get_mimes() +.. function:: get_mimes() :returns: array @@ -167,7 +167,7 @@ This function returns a *reference* to the MIMEs array from is_https() ========== -.. php:function:: is_https() +.. function:: is_https() :returns: bool @@ -177,7 +177,7 @@ in any other case (including non-HTTP requests). function_usable() ================= -.. php:function:: function_usable($function_name) +.. function:: function_usable($function_name) :param string $function_name: Function name :returns: bool -- cgit v1.2.3-24-g4f1b From 9f387e7b756fc4d063a769338af6dc4ee89bc061 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Tue, 7 Jan 2014 11:50:34 +0200 Subject: [ci skip] Clean up the common functions docs --- user_guide_src/source/general/common_functions.rst | 165 +++++++++------------ 1 file changed, 69 insertions(+), 96 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 8a57c183e..f8e9d775b 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -6,70 +6,65 @@ 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() -======== +.. contents:: + :local: + +.. raw:: html + +
.. function:: is_php($version = '5.3.0') :param string $version: Version number :returns: bool -Determines of the PHP version being used is greater than the -supplied version number. + Determines of the PHP version being used is greater than the + supplied version number. -Example:: + Example:: - if (is_php('5.3')) - { - $str = quoted_printable_encode($str); - } + if (is_php('5.3')) + { + $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. + 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() -==================== + .. function:: is_really_writable($file) -.. function:: is_really_writable($file) - - :param string $file: File path - :returns: bool + :param string $file: File path + :returns: bool -``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. + ``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. + 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. -Example:: + Example:: - if (is_really_writable('file.txt')) - { - echo "I could write to this if I wanted to"; - } - else - { - echo "File is not writable"; - } - -config_item() -============= + if (is_really_writable('file.txt')) + { + echo "I could write to this if I wanted to"; + } + else + { + echo "File is not writable"; + } .. function:: config_item($key) :param string $key: Config item key :returns: mixed -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 :doc:`Config Library <../libraries/config>` -documentation for more information. - -show_error() -============ + 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 :doc:`Config Library <../libraries/config>` + documentation for more information. .. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') @@ -78,11 +73,8 @@ show_error() :param string $heading: Error page heading :returns: void -This function calls ``CI_Exception::show_error()``. For more info, -please see the :doc:`Error Handling ` documentation. - -show_404() -========== + This function calls ``CI_Exception::show_error()``. For more info, + please see the :doc:`Error Handling ` documentation. .. function:: show_404($page = '', $log_error = TRUE) @@ -90,11 +82,8 @@ show_404() :param bool $log_error: Whether to log the error :returns: void -This function calls ``CI_Exception::show_404()``. For more info, -please see the :doc:`Error Handling ` documentation. - -log_message() -============= + This function calls ``CI_Exception::show_404()``. For more info, + please see the :doc:`Error Handling ` documentation. .. function:: log_message($level, $message, $php_error = FALSE) @@ -103,11 +92,8 @@ log_message() :param bool $php_error: Whether we're logging a native PHP error message :returns: void -This function is an alias for ``CI_Log::write_log()``. For more info, -please see the :doc:`Error Handling ` documentation. - -set_status_header() -=============================== + This function is an alias for ``CI_Log::write_log()``. For more info, + please see the :doc:`Error Handling ` documentation. .. function:: set_status_header($code, $text = '') @@ -115,16 +101,13 @@ set_status_header() :param string $text: A custom message to set with the status code :returns: void -Permits you to manually set a server status header. Example:: - - set_status_header(401); - // Sets the header as: Unauthorized + Permits you to manually set a server status header. Example:: -`See here `_ for -a full list of headers. + set_status_header(401); + // Sets the header as: Unauthorized -remove_invisible_characters() -============================= + `See here `_ for + a full list of headers. .. function:: remove_invisible_characters($str, $url_encoded = TRUE) @@ -132,47 +115,37 @@ remove_invisible_characters() :param bool $url_encoded: Whether to remove URL-encoded characters as well :returns: string -This function prevents inserting NULL characters between ASCII -characters, like Java\\0script. + This function prevents inserting NULL characters between ASCII + characters, like Java\\0script. -Example:: + Example:: - remove_invisible_characters('Java\\0script'); - // Returns: 'Javascript' - -html_escape() -============= + remove_invisible_characters('Java\\0script'); + // Returns: 'Javascript' .. function:: html_escape($var) - :param mixed $var: Variable to escape - (string or array) + :param mixed $var: Variable to escape (string or array) :returns: mixed -This function acts as an alias for PHP's native ``htmlspecialchars()`` -function, with the advantage of being able to accept an array of strings. - -It is useful in preventing Cross Site Scripting (XSS). + This function acts as an alias for PHP's native ``htmlspecialchars()`` + function, with the advantage of being able to accept an array of strings. -get_mimes() -=========== + It is useful in preventing Cross Site Scripting (XSS). .. function:: get_mimes() :returns: array -This function returns a *reference* to the MIMEs array from -*application/config/mimes.php*. - -is_https() -========== + This function returns a *reference* to the MIMEs array from + *application/config/mimes.php*. .. function:: is_https() :returns: bool -Returns TRUE if a secure (HTTPS) connection is used and FALSE -in any other case (including non-HTTP requests). + Returns TRUE if a secure (HTTPS) connection is used and FALSE + in any other case (including non-HTTP requests). function_usable() ================= @@ -182,12 +155,12 @@ function_usable() :param string $function_name: Function name :returns: bool -Returns TRUE if a function exists and is usable, FALSE otherwise. + Returns TRUE if a function exists and is usable, FALSE otherwise. -This function runs a ``function_exists()`` check and if the -`Suhosin extension ` is loaded, -checks if it doesn't disable the function being checked. + This function runs a ``function_exists()`` check and if the + `Suhosin extension ` is loaded, + checks if it doesn't disable the function being checked. -It is useful if you want to check for the availability of functions -such as ``eval()`` and ``exec()``, which are dangerous and might be -disabled on servers with highly restrictive security policies. \ No newline at end of file + It is useful if you want to check for the availability of functions + such as ``eval()`` and ``exec()``, which are dangerous and might be + disabled on servers with highly restrictive security policies. \ No newline at end of file -- cgit v1.2.3-24-g4f1b From 75b3fb26a324c71ff18fa19b2a3caa357f8133ec Mon Sep 17 00:00:00 2001 From: Connor Tumbleson Date: Sat, 11 Jan 2014 06:58:43 -0600 Subject: cleanup warnings Signed-off-by: Connor Tumbleson --- user_guide_src/source/general/common_functions.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 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 f8e9d775b..8c5166358 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -66,7 +66,7 @@ loading any libraries or helpers. to retrieve single keys. See :doc:`Config Library <../libraries/config>` documentation for more information. -.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') +.. :noindex: function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') :param mixed $message: Error message :param int $status_code: HTTP Response status code @@ -76,7 +76,7 @@ loading any libraries or helpers. This function calls ``CI_Exception::show_error()``. For more info, please see the :doc:`Error Handling ` documentation. -.. function:: show_404($page = '', $log_error = TRUE) +.. :noindex: function:: show_404($page = '', $log_error = TRUE) :param string $page: URI string :param bool $log_error: Whether to log the error @@ -85,7 +85,7 @@ loading any libraries or helpers. This function calls ``CI_Exception::show_404()``. For more info, please see the :doc:`Error Handling ` documentation. -.. function:: log_message($level, $message, $php_error = FALSE) +.. :noindex: function:: log_message($level, $message, $php_error = FALSE) :param string $level: Log level: 'error', 'debug' or 'info' :param string $message: Message to log -- cgit v1.2.3-24-g4f1b From af9aa2b5bfa9d6060b18a0df9ebb710135c6c6ee Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Sat, 25 Jan 2014 00:28:10 +0200 Subject: [ci skip] Add a note to the is_really_writable() docs --- user_guide_src/source/general/common_functions.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 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 65ca026a1..e2536de4c 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -32,10 +32,10 @@ loading any libraries or helpers. greater than the supplied version number. Returns FALSE if the installed version of PHP is lower than the supplied version number. - .. function:: is_really_writable($file) +.. function:: is_really_writable($file) - :param string $file: File path - :returns: bool + :param string $file: File path + :returns: bool ``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 @@ -56,6 +56,8 @@ loading any libraries or helpers. echo "File is not writable"; } + .. note:: See also `PHP bug #54709 `_ for more info. + .. function:: config_item($key) :param string $key: Config item key -- cgit v1.2.3-24-g4f1b From 9228f85b1b4f59cc88ba7c4addc258a7a5fd0ac0 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Fri, 7 Feb 2014 23:40:22 +0200 Subject: [ci skip] Add return types to common and error handling functions docs --- user_guide_src/source/general/common_functions.rst | 35 ++++++++++++++-------- 1 file changed, 22 insertions(+), 13 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 c466ca0b9..2ca7478ec 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -16,7 +16,8 @@ loading any libraries or helpers. .. function:: is_php([$version = '5.3.0']) :param string $version: Version number - :returns: bool + :returns: TRUE if the running PHP version is at least the one specified or FALSE if not + :rtype: bool Determines of the PHP version being used is greater than the supplied version number. @@ -35,7 +36,8 @@ loading any libraries or helpers. .. function:: is_really_writable($file) :param string $file: File path - :returns: bool + :returns: TRUE if the path is writable, FALSE if not + :rtype: bool ``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 @@ -61,7 +63,8 @@ loading any libraries or helpers. .. function:: config_item($key) :param string $key: Config item key - :returns: mixed + :returns: Configuration key value or FALSE if not found + :rtype: mixed The :doc:`Config Library <../libraries/config>` is the preferred way of accessing configuration information, however ``config_item()`` can be used @@ -73,7 +76,7 @@ loading any libraries or helpers. :param mixed $message: Error message :param int $status_code: HTTP Response status code :param string $heading: Error page heading - :returns: void + :rtype: void This function calls ``CI_Exception::show_error()``. For more info, please see the :doc:`Error Handling ` documentation. @@ -82,7 +85,7 @@ loading any libraries or helpers. :param string $page: URI string :param bool $log_error: Whether to log the error - :returns: void + :rtype: void This function calls ``CI_Exception::show_404()``. For more info, please see the :doc:`Error Handling ` documentation. @@ -91,7 +94,7 @@ loading any libraries or helpers. :param string $level: Log level: 'error', 'debug' or 'info' :param string $message: Message to log - :returns: void + :rtype: void This function is an alias for ``CI_Log::write_log()``. For more info, please see the :doc:`Error Handling ` documentation. @@ -100,7 +103,7 @@ loading any libraries or helpers. :param int $code: HTTP Reponse status code :param string $text: A custom message to set with the status code - :returns: void + :rtype: void Permits you to manually set a server status header. Example:: @@ -114,7 +117,8 @@ loading any libraries or helpers. :param string $str: Input string :param bool $url_encoded: Whether to remove URL-encoded characters as well - :returns: string + :returns: Sanitized string + :rtype: string This function prevents inserting NULL characters between ASCII characters, like Java\\0script. @@ -127,7 +131,8 @@ loading any libraries or helpers. .. function:: html_escape($var) :param mixed $var: Variable to escape (string or array) - :returns: mixed + :returns: HTML escaped string(s) + :rtype: mixed This function acts as an alias for PHP's native ``htmlspecialchars()`` function, with the advantage of being able to accept an array of strings. @@ -136,21 +141,24 @@ loading any libraries or helpers. .. function:: get_mimes() - :returns: array + :returns: An associative array of file types + :rtype: array This function returns a *reference* to the MIMEs array from *application/config/mimes.php*. .. function:: is_https() - :returns: bool + :returns: TRUE if currently using HTTP-over-SSL, FALSE if not + :rtype: bool Returns TRUE if a secure (HTTPS) connection is used and FALSE in any other case (including non-HTTP requests). .. function:: is_cli() - :returns: bool + :returns: TRUE if currently running under CLI, FALSE otherwise + :rtype: bool Returns TRUE if the application is run through the command line and FALSE if not. @@ -161,7 +169,8 @@ loading any libraries or helpers. .. function:: function_usable($function_name) :param string $function_name: Function name - :returns: bool + :returns: TRUE if the function can be used, FALSE if not + :rtype: bool Returns TRUE if a function exists and is usable, FALSE otherwise. -- cgit v1.2.3-24-g4f1b