summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/general
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2015-02-02 12:41:01 +0100
committerAndrey Andreev <narf@devilix.net>2015-02-02 12:41:01 +0100
commitcd3d9dbcbc99fa956b7400d328f202e1bcab4677 (patch)
treeca1e12b6751f31de8f49055118318643f7d647c7 /user_guide_src/source/general
parent7fd0c2d22ccbeb824419477ae8b506b84002ea13 (diff)
[ci skip] Fix #3515
Diffstat (limited to 'user_guide_src/source/general')
-rw-r--r--user_guide_src/source/general/ancillary_classes.rst2
-rw-r--r--user_guide_src/source/general/cli.rst2
-rw-r--r--user_guide_src/source/general/common_functions.rst20
-rw-r--r--user_guide_src/source/general/compatibility_functions.rst28
-rw-r--r--user_guide_src/source/general/errors.rst6
-rw-r--r--user_guide_src/source/general/reserved_names.rst26
6 files changed, 42 insertions, 42 deletions
diff --git a/user_guide_src/source/general/ancillary_classes.rst b/user_guide_src/source/general/ancillary_classes.rst
index cc232f447..6a64742ce 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()
==============
-.. function:: get_instance()
+.. php:function:: get_instance()
:returns: object of class CI_Controller
diff --git a/user_guide_src/source/general/cli.rst b/user_guide_src/source/general/cli.rst
index 4f3b07d9e..b45be1aa8 100644
--- a/user_guide_src/source/general/cli.rst
+++ b/user_guide_src/source/general/cli.rst
@@ -23,7 +23,7 @@ but they are not always obvious.
- Run your cron-jobs without needing to use *wget* or *curl*
- Make your cron-jobs inaccessible from being loaded in the URL by
- checking the return value of :func:`is_cli()`.
+ checking the return value of :php:func:`is_cli()`.
- Make interactive "tasks" that can do things like set permissions,
prune cache folders, run backups, etc.
- Integrate with other applications in other languages. For example, a
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index 399a323cc..6d6744cf7 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -13,7 +13,7 @@ loading any libraries or helpers.
<div class="custom-index container"></div>
-.. function:: is_php($version)
+.. php:function:: is_php($version)
:param string $version: Version number
:returns: TRUE if the running PHP version is at least the one specified or FALSE if not
@@ -33,7 +33,7 @@ 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)
+.. php:function:: is_really_writable($file)
:param string $file: File path
:returns: TRUE if the path is writable, FALSE if not
@@ -60,7 +60,7 @@ loading any libraries or helpers.
.. note:: See also `PHP bug #54709 <https://bugs.php.net/bug.php?id=54709>`_ for more info.
-.. function:: config_item($key)
+.. php:function:: config_item($key)
:param string $key: Config item key
:returns: Configuration key value or NULL if not found
@@ -99,7 +99,7 @@ loading any libraries or helpers.
This function is an alias for ``CI_Log::write_log()``. For more info,
please see the :doc:`Error Handling <errors>` documentation.
-.. function:: set_status_header($code[, $text = ''])
+.. php: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
@@ -113,7 +113,7 @@ loading any libraries or helpers.
`See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for
a full list of headers.
-.. function:: remove_invisible_characters($str[, $url_encoded = TRUE])
+.. php: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
@@ -128,7 +128,7 @@ loading any libraries or helpers.
remove_invisible_characters('Java\\0script');
// Returns: 'Javascript'
-.. function:: html_escape($var)
+.. php:function:: html_escape($var)
:param mixed $var: Variable to escape (string or array)
:returns: HTML escaped string(s)
@@ -139,7 +139,7 @@ loading any libraries or helpers.
It is useful in preventing Cross Site Scripting (XSS).
-.. function:: get_mimes()
+.. php:function:: get_mimes()
:returns: An associative array of file types
:rtype: array
@@ -147,7 +147,7 @@ loading any libraries or helpers.
This function returns a *reference* to the MIMEs array from
*application/config/mimes.php*.
-.. function:: is_https()
+.. php:function:: is_https()
:returns: TRUE if currently using HTTP-over-SSL, FALSE if not
:rtype: bool
@@ -155,7 +155,7 @@ loading any libraries or helpers.
Returns TRUE if a secure (HTTPS) connection is used and FALSE
in any other case (including non-HTTP requests).
-.. function:: is_cli()
+.. php:function:: is_cli()
:returns: TRUE if currently running under CLI, FALSE otherwise
:rtype: bool
@@ -166,7 +166,7 @@ loading any libraries or helpers.
.. note:: This function checks both if the ``PHP_SAPI`` value is 'cli'
or if the ``STDIN`` constant is defined.
-.. function:: function_usable($function_name)
+.. php:function:: function_usable($function_name)
:param string $function_name: Function name
:returns: TRUE if the function can be used, FALSE if not
diff --git a/user_guide_src/source/general/compatibility_functions.rst b/user_guide_src/source/general/compatibility_functions.rst
index aee9b1ef0..434b0982f 100644
--- a/user_guide_src/source/general/compatibility_functions.rst
+++ b/user_guide_src/source/general/compatibility_functions.rst
@@ -44,7 +44,7 @@ Constants
Function reference
==================
-.. function:: password_get_info($hash)
+.. php:function:: password_get_info($hash)
:param string $hash: Password hash
:returns: Information about the hashed password
@@ -53,7 +53,7 @@ Function reference
For more information, please refer to the `PHP manual for
password_get_info() <http://php.net/password_get_info>`_.
-.. function:: password_hash($password, $algo[, $options = array()])
+.. php:function:: password_hash($password, $algo[, $options = array()])
:param string $password: Plain-text password
:param int $algo: Hashing algorithm
@@ -72,7 +72,7 @@ Function reference
- /dev/arandom
- /dev/urandom
-.. function:: password_needs_rehash()
+.. php:function:: password_needs_rehash()
:param string $hash: Password hash
:param int $algo: Hashing algorithm
@@ -83,7 +83,7 @@ Function reference
For more information, please refer to the `PHP manual for
password_needs_rehash() <http://php.net/password_needs_rehash>`_.
-.. function:: password_verify($password, $hash)
+.. php:function:: password_verify($password, $hash)
:param string $password: Plain-text password
:param string $hash: Password hash
@@ -109,7 +109,7 @@ Dependencies
Function reference
==================
-.. function:: hash_equals($known_string, $user_string)
+.. php:function:: hash_equals($known_string, $user_string)
:param string $known_string: Known string
:param string $user_string: User-supplied string
@@ -119,7 +119,7 @@ Function reference
For more information, please refer to the `PHP manual for
hash_equals() <http://php.net/hash_equals>`_.
-.. function:: hash_pbkdf2($algo, $password, $salt, $iterations[, $length = 0[, $raw_output = FALSE]])
+.. php:function:: hash_pbkdf2($algo, $password, $salt, $iterations[, $length = 0[, $raw_output = FALSE]])
:param string $algo: Hashing algorithm
:param string $password: Password
@@ -162,7 +162,7 @@ Dependencies
Function reference
==================
-.. function:: mb_strlen($str[, $encoding = NULL])
+.. php:function:: mb_strlen($str[, $encoding = NULL])
:param string $str: Input string
:param string $encoding: Character set
@@ -172,7 +172,7 @@ Function reference
For more information, please refer to the `PHP manual for
mb_strlen() <http://php.net/mb_strlen>`_.
-.. function:: mb_strpos($haystack, $needle[, $offset = 0[, $encoding = NULL]])
+.. php:function:: mb_strpos($haystack, $needle[, $offset = 0[, $encoding = NULL]])
:param string $haystack: String to search in
:param string $needle: Part of string to search for
@@ -184,7 +184,7 @@ Function reference
For more information, please refer to the `PHP manual for
mb_strpos() <http://php.net/mb_strpos>`_.
-.. function:: mb_substr($str, $start[, $length = NULL[, $encoding = NULL]])
+.. php:function:: mb_substr($str, $start[, $length = NULL[, $encoding = NULL]])
:param string $str: Input string
:param int $start: Position of first character
@@ -211,7 +211,7 @@ Dependencies
Function reference
==================
-.. function:: array_column(array $array, $column_key[, $index_key = NULL])
+.. php:function:: array_column(array $array, $column_key[, $index_key = NULL])
:param array $array: Array to fetch results from
:param mixed $column_key: Key of the column to return values from
@@ -222,7 +222,7 @@ Function reference
For more information, please refer to the `PHP manual for
array_column() <http://php.net/array_column>`_.
-.. function:: array_replace(array $array1[, ...])
+.. php:function:: array_replace(array $array1[, ...])
:param array $array1: Array in which to replace elements
:param array ...: Array (or multiple ones) from which to extract elements
@@ -232,7 +232,7 @@ Function reference
For more information, please refer to the `PHP manual for
array_replace() <http://php.net/array_replace>`_.
-.. function:: array_replace_recursive(array $array1[, ...])
+.. php:function:: array_replace_recursive(array $array1[, ...])
:param array $array1: Array in which to replace elements
:param array ...: Array (or multiple ones) from which to extract elements
@@ -245,7 +245,7 @@ Function reference
.. important:: Only PHP's native function can detect endless recursion.
Unless you are running PHP 5.3+, be careful with references!
-.. function:: hex2bin($data)
+.. php:function:: hex2bin($data)
:param array $data: Hexadecimal representation of data
:returns: Binary representation of the given data
@@ -254,7 +254,7 @@ Function reference
For more information, please refer to the `PHP manual for hex2bin()
<http://php.net/hex2bin>`_.
-.. function:: quoted_printable_encode($str)
+.. php:function:: quoted_printable_encode($str)
:param string $str: Input string
:returns: 8bit-encoded string
diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst
index 4428c65dc..9c190feb1 100644
--- a/user_guide_src/source/general/errors.rst
+++ b/user_guide_src/source/general/errors.rst
@@ -29,7 +29,7 @@ software keep track of your scripts and the health of your application.
The following functions let you generate errors:
-.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
+.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
:param mixed $message: Error message
:param int $status_code: HTTP Response status code
@@ -54,7 +54,7 @@ The following functions let you generate errors:
to ``EXIT_ERROR``.
You can check in *application/config/constants.php* for more detail.
-.. function:: show_404($page = '', $log_error = TRUE)
+.. php:function:: show_404($page = '', $log_error = TRUE)
:param string $page: URI string
:param bool $log_error: Whether to log the error
@@ -78,7 +78,7 @@ The following functions let you generate errors:
CodeIgniter automatically logs any ``show_404()`` calls. Setting the
optional second parameter to FALSE will skip logging.
-.. function:: log_message($level, $message, $php_error = FALSE)
+.. php:function:: log_message($level, $message, $php_error = FALSE)
:param string $level: Log level: 'error', 'debug' or 'info'
:param string $message: Message to log
diff --git a/user_guide_src/source/general/reserved_names.rst b/user_guide_src/source/general/reserved_names.rst
index 9da94b398..a7b0c3465 100644
--- a/user_guide_src/source/general/reserved_names.rst
+++ b/user_guide_src/source/general/reserved_names.rst
@@ -23,22 +23,22 @@ your controller any of these:
Functions
---------
-- :func:`is_php()`
-- :func:`is_really_writable()`
+- :php:func:`is_php()`
+- :php:func:`is_really_writable()`
- ``load_class()``
- ``is_loaded()``
- ``get_config()``
-- :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()`
+- :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()`
- ``_error_handler()``
- ``_exception_handler()``
- ``_stringify_attributes()``