summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/general
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide_src/source/general')
-rw-r--r--user_guide_src/source/general/ancillary_classes.rst4
-rw-r--r--user_guide_src/source/general/common_functions.rst24
-rw-r--r--user_guide_src/source/general/errors.rst12
3 files changed, 20 insertions, 20 deletions
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 <errors>` 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 <errors>` 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 <errors>` 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