summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/libraries/input.rst
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/libraries/input.rst
parent7fd0c2d22ccbeb824419477ae8b506b84002ea13 (diff)
[ci skip] Fix #3515
Diffstat (limited to 'user_guide_src/source/libraries/input.rst')
-rw-r--r--user_guide_src/source/libraries/input.rst36
1 files changed, 18 insertions, 18 deletions
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index 3bc096705..967f69d13 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -112,9 +112,9 @@ a boolean value as the second parameter::
Class Reference
***************
-.. class:: CI_Input
+.. php:class:: CI_Input
- .. method:: post([$index = NULL[, $xss_clean = NULL]])
+ .. php:method:: post([$index = NULL[, $xss_clean = NULL]])
:param mixed $index: POST parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -157,7 +157,7 @@ Class Reference
$this->input->post(array('field1', 'field2'), TRUE);
- .. method:: get([$index = NULL[, $xss_clean = NULL]])
+ .. php:method:: get([$index = NULL[, $xss_clean = NULL]])
:param mixed $index: GET parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -190,7 +190,7 @@ Class Reference
$this->input->get(array('field1', 'field2'), TRUE);
- .. method:: post_get($index[, $xss_clean = NULL])
+ .. php:method:: post_get($index[, $xss_clean = NULL])
:param string $index: POST/GET parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -203,7 +203,7 @@ Class Reference
$this->input->post_get('some_data', TRUE);
- .. method:: get_post($index[, $xss_clean = NULL])
+ .. php:method:: get_post($index[, $xss_clean = NULL])
:param string $index: GET/POST parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -218,7 +218,7 @@ Class Reference
.. note:: This method used to act EXACTLY like ``post_get()``, but it's
behavior has changed in CodeIgniter 3.0.
- .. method:: cookie([$index = NULL[, $xss_clean = NULL]])
+ .. php:method:: cookie([$index = NULL[, $xss_clean = NULL]])
:param mixed $index: COOKIE name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -238,10 +238,10 @@ Class Reference
$this->input->cookie(array('some_cookie', 'some_cookie2'));
.. note:: Unlike the :doc:`Cookie Helper <../helpers/cookie_helper>`
- function :func:`get_cookie()`, this method does NOT prepend
+ function :php:func:`get_cookie()`, this method does NOT prepend
your configured ``$config['cookie_prefix']`` value.
- .. method:: server($index[, $xss_clean = NULL])
+ .. php:method:: server($index[, $xss_clean = NULL])
:param mixed $index: Value name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -259,7 +259,7 @@ Class Reference
$this->input->server(array('SERVER_PROTOCOL', 'REQUEST_URI'));
- .. method:: input_stream([$index = NULL[, $xss_clean = NULL]])
+ .. php:method:: input_stream([$index = NULL[, $xss_clean = NULL]])
:param mixed $index: Key name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -269,7 +269,7 @@ Class Reference
This method is identical to ``get()``, ``post()`` and ``cookie()``,
only it fetches the *php://input* stream data.
- .. method:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
+ .. php:method:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
:param mixed $name: Cookie name or an array of parameters
:param string $value: Cookie value
@@ -332,7 +332,7 @@ Class Reference
$this->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure);
- .. method:: ip_address()
+ .. php:method:: ip_address()
:returns: Visitor's IP address or '0.0.0.0' if not valid
:rtype: string
@@ -347,7 +347,7 @@ Class Reference
HTTP_CLIENT_IP, HTTP_X_CLIENT_IP or HTTP_X_CLUSTER_CLIENT_IP
address for the allowed IP addresses.
- .. method:: valid_ip($ip[, $which = ''])
+ .. php:method:: valid_ip($ip[, $which = ''])
:param string $ip: IP address
:param string $which: IP protocol ('ipv4' or 'ipv6')
@@ -374,7 +374,7 @@ Class Reference
Accepts an optional second string parameter of 'ipv4' or 'ipv6' to specify
an IP format. The default checks for both formats.
- .. method:: user_agent([$xss_clean = NULL])
+ .. php:method:: user_agent([$xss_clean = NULL])
:returns: User agent string or NULL if not set
:param bool $xss_clean: Whether to apply XSS filtering
@@ -389,7 +389,7 @@ Class Reference
See the :doc:`User Agent Class <user_agent>` for methods which extract
information from the user agent string.
- .. method:: request_headers([$xss_clean = FALSE])
+ .. php:method:: request_headers([$xss_clean = FALSE])
:param bool $xss_clean: Whether to apply XSS filtering
:returns: An array of HTTP request headers
@@ -403,7 +403,7 @@ Class Reference
$headers = $this->input->request_headers();
- .. method:: get_request_header($index[, $xss_clean = FALSE])
+ .. php:method:: get_request_header($index[, $xss_clean = FALSE])
:param string $index: HTTP request header name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -416,7 +416,7 @@ Class Reference
$this->input->get_request_header('some-header', TRUE);
- .. method:: is_ajax_request()
+ .. php:method:: is_ajax_request()
:returns: TRUE if it is an Ajax request, FALSE if not
:rtype: bool
@@ -424,7 +424,7 @@ Class Reference
Checks to see if the HTTP_X_REQUESTED_WITH server header has been
set, and returns boolean TRUE if it is or FALSE if not.
- .. method:: is_cli_request()
+ .. php:method:: is_cli_request()
:returns: TRUE if it is a CLI request, FALSE if not
:rtype: bool
@@ -443,7 +443,7 @@ Class Reference
.. note:: This method is DEPRECATED and is now just an alias for the
:func:`is_cli()` function.
- .. method:: method([$upper = FALSE])
+ .. php:method:: method([$upper = FALSE])
:param bool $upper: Whether to return the request method name in upper or lower case
:returns: HTTP request method