summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2014-01-08 16:28:02 +0100
committerAndrey Andreev <narf@devilix.net>2014-01-08 16:28:02 +0100
commit88ebdf7ad98c2d24f9ba6b9839ab50c98cf0eb65 (patch)
treede6f02d88cb699be08bacf2535923ae9ab36ac18
parent69e1b4f054521bc055af9e2b377a3a578fc6cadc (diff)
[ci skip] Update the Input library and Cookie helper docs
default value is now NULL
-rw-r--r--user_guide_src/source/helpers/cookie_helper.rst2
-rw-r--r--user_guide_src/source/libraries/input.rst19
2 files changed, 11 insertions, 10 deletions
diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index 2e8db5f31..3b594170d 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -43,7 +43,7 @@ The following functions are available:
``CI_Input::set_cookie()``.
-.. function:: get_cookie($index[, $xss_clean = FALSE]])
+.. function:: get_cookie($index[, $xss_clean = NULL]])
:param string $index: Cookie name
:param bool $xss_clean: Whether to apply XSS filtering to the returned value
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index 39a0d0628..4d8fdaf15 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -105,7 +105,7 @@ Class Reference
.. class:: CI_Input
- .. method:: post([$index = NULL[, $xss_clean = FALSE]])
+ .. method:: post([$index = NULL[, $xss_clean = NULL]])
:param string $index: POST parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -120,7 +120,8 @@ Class Reference
does not exist.
The second optional parameter lets you run the data through the XSS
- filter. It's enabled by setting the second parameter to boolean TRUE.
+ filter. It's enabled by setting the second parameter to boolean TRUE
+ or by setting your ``$config['global_xss_filtering']`` to TRUE.
::
$this->input->post('some_data', TRUE);
@@ -132,9 +133,9 @@ Class Reference
::
$this->input->post(NULL, TRUE); // returns all POST items with XSS filter
- $this->input->post(); // returns all POST items without XSS filter
+ $this->input->post(NULL, FALSE); // returns all POST items without XSS filter
- .. method:: get([$index = NULL[, $xss_clean = FALSE]])
+ .. method:: get([$index = NULL[, $xss_clean = NULL]])
:param string $index: GET parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -152,9 +153,9 @@ Class Reference
::
$this->input->get(NULL, TRUE); // returns all GET items with XSS filter
- $this->input->get(); // returns all GET items without XSS filtering
+ $this->input->get(NULL, FALSE); // returns all GET items without XSS filtering
- .. method:: get_post([$index = ''[, $xss_clean = FALSE]])
+ .. method:: get_post([$index = ''[, $xss_clean = NULL]])
:param string $index: GET/POST parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -166,7 +167,7 @@ Class Reference
$this->input->get_post('some_data', TRUE);
- .. method:: cookie([$index = ''[, $xss_clean = FALSE]])
+ .. method:: cookie([$index = ''[, $xss_clean = NULL]])
:param string $index: COOKIE parameter name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -178,7 +179,7 @@ Class Reference
$this->input->cookie('some_cookie');
$this->input->cookie('some_cookie, TRUE); // with XSS filter
- .. method:: server([$index = ''[, $xss_clean = FALSE]])
+ .. method:: server([$index = ''[, $xss_clean = NULL]])
:param string $index: Value name
:param bool $xss_clean: Whether to apply XSS filtering
@@ -189,7 +190,7 @@ Class Reference
$this->input->server('some_data');
- .. method:: input_stream([$index = ''[, $xss_clean = FALSE]])
+ .. method:: input_stream([$index = ''[, $xss_clean = NULL]])
:param string $index: Key name
:param bool $xss_clean: Whether to apply XSS filtering