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 --- .../source/general/ancillary_classes.rst | 4 ++-- user_guide_src/source/general/common_functions.rst | 24 +++++++++++----------- user_guide_src/source/general/errors.rst | 12 +++++------ 3 files changed, 20 insertions(+), 20 deletions(-) (limited to 'user_guide_src/source/general') diff --git a/user_guide_src/source/general/ancillary_classes.rst b/user_guide_src/source/general/ancillary_classes.rst index 5dc058ad4..edb3a14fb 100644 --- a/user_guide_src/source/general/ancillary_classes.rst +++ b/user_guide_src/source/general/ancillary_classes.rst @@ -9,7 +9,7 @@ resources. This is easily possible as you'll see. get_instance() ============== -.. php:function:: get_instance() +.. function:: get_instance() :returns: object of class CI_Controller @@ -48,7 +48,7 @@ Once you've assigned the object to a variable, you'll use that variable passed by reference:: $CI =& get_instance(); - + This is very important. Assigning by reference allows you to use the original CodeIgniter object rather than creating a copy of it. 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 diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst index f12d992f8..6cc8a0966 100644 --- a/user_guide_src/source/general/errors.rst +++ b/user_guide_src/source/general/errors.rst @@ -21,8 +21,8 @@ without having to worry about class/function scoping. CodeIgniter also returns a status code whenever a portion of the core calls ``exit()``. This exit status code is separate from the HTTP status code, and serves as a notice to other processes that may be watching of -whether the script completed successfully, or if not, what kind of -problem it encountered that caused it to abort. These values are +whether the script completed successfully, or if not, what kind of +problem it encountered that caused it to abort. These values are defined in *application/config/constants.php*. While exit status codes are most useful in CLI settings, returning the proper code helps server software keep track of your scripts and the health of your application. @@ -32,7 +32,7 @@ The following functions let you generate errors: 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 @@ -49,13 +49,13 @@ code should be sent with the error. If ``$status_code`` is less than 100, the HTTP status code will be set to 500, and the exit status code will be set to ``$status_code + EXIT__AUTO_MIN``. If that value is larger than ``EXIT__AUTO_MAX``, or if ``$status_code`` is 100 or higher, the exit -status code will be set to ``EXIT_ERROR``. You can check in +status code will be set to ``EXIT_ERROR``. You can check in *application/config/constants.php* for more detail. 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 @@ -77,7 +77,7 @@ optional second parameter to FALSE will skip logging. 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 -- cgit v1.2.3-24-g4f1b From 123bb20c52e0e9d6a622e14bac33e05b10ffc013 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Fri, 19 Jul 2013 16:37:51 -0700 Subject: Updating user guide :php:func: refs to :func: --- user_guide_src/source/general/reserved_names.rst | 26 ++++++++++++------------ 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'user_guide_src/source/general') diff --git a/user_guide_src/source/general/reserved_names.rst b/user_guide_src/source/general/reserved_names.rst index ccc17d61b..a767651fb 100644 --- a/user_guide_src/source/general/reserved_names.rst +++ b/user_guide_src/source/general/reserved_names.rst @@ -25,22 +25,22 @@ your controller any of these: Functions --------- -- :php:func:`is_php()` -- :php:func:`is_really_writable()` +- :func:`is_php()` +- :func:`is_really_writable()` - ``load_class()`` - ``is_loaded()`` - ``get_config()`` -- :php:func:`config_item()` -- :php:func:`show_error()` -- :php:func:`show_404()` -- :php:func:`log_message()` -- :php:func:`set_status_header()` -- :php:func:`get_mimes()` -- :php:func:`html_escape()` -- :php:func:`remove_invisible_characters()` -- :php:func:`is_https()` -- :php:func:`function_usable()` -- :php:func:`get_instance()` +- :func:`config_item()` +- :func:`show_error()` +- :func:`show_404()` +- :func:`log_message()` +- :func:`set_status_header()` +- :func:`get_mimes()` +- :func:`html_escape()` +- :func:`remove_invisible_characters()` +- :func:`is_https()` +- :func:`function_usable()` +- :func:`get_instance()` - ``_exception_handler()`` - ``_stringify_attributes()`` -- 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') 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') 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 e16b926550f736483cb11df147946c9717a1a4fe Mon Sep 17 00:00:00 2001 From: Connor Tumbleson Date: Tue, 14 Jan 2014 07:40:50 -0600 Subject: fix lists on requirements --- user_guide_src/source/general/requirements.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) (limited to 'user_guide_src/source/general') diff --git a/user_guide_src/source/general/requirements.rst b/user_guide_src/source/general/requirements.rst index 104923625..0b67e8e3a 100644 --- a/user_guide_src/source/general/requirements.rst +++ b/user_guide_src/source/general/requirements.rst @@ -2,14 +2,15 @@ Server Requirements ################### -- `PHP `_ version 5.2.4 or newer. -- A Database is required for most web application programming. - Currently supported databases are: - - MySQL (5.1+) via the *mysql* (deprecated), *mysqli* and *pdo* drivers - - Oracle via the *oci8* and *pdo* drivers - - PostgreSQL via the *postgre* and *pdo* drivers - - MS SQL via the *mssql*, *sqlsrv* (version 2005 and above only) and *pdo* drivers - - SQLite via the *sqlite* (version 2), *sqlite3* (version 3) and *pdo* drivers - - CUBRID via the *cubrid* and *pdo* drivers - - Interbase/Firebird via the *ibase* and *pdo* drivers - - ODBC via the *odbc* and *pdo* drivers (you should know that ODBC is actually an abstraction layer) \ No newline at end of file +- `PHP `_ version 5.2.4 or newer. +- A Database is required for most web application programming. + + Currently supported databases are: + - MySQL (5.1+) via the *mysql* (deprecated), *mysqli* and *pdo* drivers + - Oracle via the *oci8* and *pdo* drivers + - PostgreSQL via the *postgre* and *pdo* drivers + - MS SQL via the *mssql*, *sqlsrv* (version 2005 and above only) and *pdo* drivers + - SQLite via the *sqlite* (version 2), *sqlite3* (version 3) and *pdo* drivers + - CUBRID via the *cubrid* and *pdo* drivers + - Interbase/Firebird via the *ibase* and *pdo* drivers + - ODBC via the *odbc* and *pdo* drivers (you should know that ODBC is actually an abstraction layer) \ No newline at end of file -- cgit v1.2.3-24-g4f1b From ba231aab2b26279f536a52bf4ccdb4af0d191570 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Mon, 20 Jan 2014 16:43:41 +0200 Subject: [ci skip] Replace incorrect usage of 'then', where it should be 'than' --- user_guide_src/source/general/controllers.rst | 2 +- user_guide_src/source/general/hooks.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'user_guide_src/source/general') diff --git a/user_guide_src/source/general/controllers.rst b/user_guide_src/source/general/controllers.rst index d8ef824fb..bc8319dd8 100644 --- a/user_guide_src/source/general/controllers.rst +++ b/user_guide_src/source/general/controllers.rst @@ -107,7 +107,7 @@ You should see your new message. Passing URI Segments to your methods ==================================== -If your URI contains more then two segments they will be passed to your +If your URI contains more than two segments they will be passed to your method as parameters. For example, let's say you have a URI like this:: diff --git a/user_guide_src/source/general/hooks.rst b/user_guide_src/source/general/hooks.rst index fc5da5b80..1046c48ae 100644 --- a/user_guide_src/source/general/hooks.rst +++ b/user_guide_src/source/general/hooks.rst @@ -59,7 +59,7 @@ defined in your associative hook array: Multiple Calls to the Same Hook =============================== -If want to use the same hook point with more then one script, simply +If want to use the same hook point with more than one script, simply make your array declaration multi-dimensional, like this:: $hook['pre_controller'][] = array( -- cgit v1.2.3-24-g4f1b From b8401d44036d0fbf336ba29ec2f17c82df5ea580 Mon Sep 17 00:00:00 2001 From: Connor Tumbleson Date: Thu, 23 Jan 2014 08:48:16 -0600 Subject: fix bad url --- user_guide_src/source/general/styleguide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source/general') diff --git a/user_guide_src/source/general/styleguide.rst b/user_guide_src/source/general/styleguide.rst index 5613eabec..000d04e1c 100644 --- a/user_guide_src/source/general/styleguide.rst +++ b/user_guide_src/source/general/styleguide.rst @@ -565,7 +565,7 @@ the ability to change this in the php.ini, you can often enable it with:: ini_set('display_errors', 1); .. note:: Setting the `display_errors - `_ + `_ setting with ``ini_set()`` at runtime is not identical to having it enabled in the PHP environment. Namely, it will not have any effect if the script has fatal errors. -- cgit v1.2.3-24-g4f1b From 1d6bddd3ef95f04795e6b3228dda6f8683bfccd7 Mon Sep 17 00:00:00 2001 From: Connor Tumbleson Date: Fri, 24 Jan 2014 07:37:22 -0600 Subject: update to errorfunc url --- user_guide_src/source/general/styleguide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source/general') diff --git a/user_guide_src/source/general/styleguide.rst b/user_guide_src/source/general/styleguide.rst index 000d04e1c..6718bc342 100644 --- a/user_guide_src/source/general/styleguide.rst +++ b/user_guide_src/source/general/styleguide.rst @@ -565,7 +565,7 @@ the ability to change this in the php.ini, you can often enable it with:: ini_set('display_errors', 1); .. note:: Setting the `display_errors - `_ + `_ setting with ``ini_set()`` at runtime is not identical to having it enabled in the PHP environment. Namely, it will not have any effect if the script has fatal errors. -- 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') 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 ++++++++++++++-------- user_guide_src/source/general/errors.rst | 15 ++-------- 2 files changed, 25 insertions(+), 25 deletions(-) (limited to 'user_guide_src/source/general') 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. diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst index 6cc8a0966..26c26bea1 100644 --- a/user_guide_src/source/general/errors.rst +++ b/user_guide_src/source/general/errors.rst @@ -29,15 +29,12 @@ software keep track of your scripts and the health of your application. The following functions let you generate errors: -show_error() -============ - .. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') :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 will display the error message supplied to it using the following error template:: @@ -52,14 +49,11 @@ be set to ``$status_code + EXIT__AUTO_MIN``. If that value is larger than status code will be set to ``EXIT_ERROR``. You can check in *application/config/constants.php* for more detail. -show_404() -========== - .. function:: show_404($page = '', $log_error = TRUE) :param string $page: URI string :param bool $log_error: Whether to log the error - :returns: void + :rtype: void This function will display the 404 error message supplied to it using the following error template:: @@ -74,15 +68,12 @@ not found. CodeIgniter automatically logs any ``show_404()`` calls. Setting the optional second parameter to FALSE will skip logging. -log_message() -============= - .. function:: log_message($level, $message, $php_error = FALSE) :param string $level: Log level: 'error', 'debug' or 'info' :param string $message: Message to log :param bool $php_error: Whether we're logging a native PHP error message - :returns: void + :rtype: void This function lets you write messages to your log files. You must supply one of three "levels" in the first parameter, indicating what type of -- cgit v1.2.3-24-g4f1b