From b4834cc72cf0c861fa5e67494328bf958c386ecf Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Thu, 29 Jan 2015 13:52:44 +0200 Subject: [ci skip] Clarify get_cookie(), CI_Input::cookie() docs Close #3527 Close #3528 --- user_guide_src/source/helpers/cookie_helper.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'user_guide_src/source/helpers/cookie_helper.rst') diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst index 22fd0f77f..4a3298fb9 100644 --- a/user_guide_src/source/helpers/cookie_helper.rst +++ b/user_guide_src/source/helpers/cookie_helper.rst @@ -37,12 +37,11 @@ The following functions are available: :param bool $httponly: Whether to hide the cookie from JavaScript :rtype: void - This helper function gives you view file friendly syntax to set browser - cookies. Refer to the :doc:`Input Library <../libraries/input>` for a - description of its use, as this function is an alias for + This helper function gives you friendlier syntax to set browser + cookies. Refer to the :doc:`Input Library <../libraries/input>` for + a description of its use, as this function is an alias for ``CI_Input::set_cookie()``. - .. function:: get_cookie($index[, $xss_clean = NULL]]) :param string $index: Cookie name @@ -50,10 +49,12 @@ The following functions are available: :returns: The cookie value or NULL if not found :rtype: mixed - This helper function gives you view file friendly syntax to get browser - cookies. Refer to the :doc:`Input Library <../libraries/input>` for a - description of its use, as this function is an alias for ``CI_Input::cookie()``. - + This helper function gives you friendlier syntax to get browser + cookies. Refer to the :doc:`Input Library <../libraries/input>` for + detailed description of its use, as this function acts very + similarly to ``CI_Input::cookie()``, except it will also prepend + the ``$config['cookie_prefix']`` that you might've set in your + *application/config/config.php* file. .. function:: delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]]]) @@ -75,4 +76,4 @@ The following functions are available: parameters. :: - delete_cookie($name, $domain, $path, $prefix) \ No newline at end of file + delete_cookie($name, $domain, $path, $prefix); -- cgit v1.2.3-24-g4f1b