diff options
Diffstat (limited to 'user_guide_src/source/libraries/sessions.rst')
| -rw-r--r-- | user_guide_src/source/libraries/sessions.rst | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst index 91dafdee8..bf0d7a49c 100644 --- a/user_guide_src/source/libraries/sessions.rst +++ b/user_guide_src/source/libraries/sessions.rst @@ -768,9 +768,9 @@ configuration value to 'dummy' and use your own driver. Congratulations! Class Reference *************** -.. class:: CI_Session +.. php:class:: CI_Session - .. method:: userdata([$key = NULL]) + .. php:method:: userdata([$key = NULL]) :param mixed $key: Session item key or NULL :returns: Value of the specified item key, or an array of all userdata @@ -783,7 +783,7 @@ Class Reference compatibility with older applications. You should directly access ``$_SESSION`` instead. - .. method:: all_userdata() + .. php:method:: all_userdata() :returns: An array of all userdata :rtype: array @@ -793,7 +793,7 @@ Class Reference .. note:: This method is DEPRECATED. Use ``userdata()`` with no parameters instead. - .. method:: &get_usedata() + .. php:method:: &get_usedata() :returns: A reference to ``$_SESSION`` :rtype: array @@ -803,7 +803,7 @@ Class Reference .. note:: This is a legacy method kept only for backwards compatibility with older applications. - .. method:: has_userdata($key) + .. php:method:: has_userdata($key) :param string $key: Session item key :returns: TRUE if the specified key exists, FALSE if not @@ -816,7 +816,7 @@ Class Reference an alias for ``isset($_SESSION[$key])`` - please use that instead. - .. method:: set_userdata($data[, $value = NULL]) + .. php:method:: set_userdata($data[, $value = NULL]) :param mixed $data: An array of key/value pairs to set as session data, or the key for a single item :param mixed $value: The value to set for a specific session item, if $data is a key @@ -827,7 +827,7 @@ Class Reference .. note:: This is a legacy method kept only for backwards compatibility with older applications. - .. method:: unset_userdata($key) + .. php:method:: unset_userdata($key) :param mixed $key: Key for the session data item to unset, or an array of multiple keys :rtype: void @@ -840,7 +840,7 @@ Class Reference an alias for ``unset($_SESSION[$key])`` - please use that instead. - .. method:: mark_as_flash($key) + .. php:method:: mark_as_flash($key) :param mixed $key: Key to mark as flashdata, or an array of multiple keys :returns: TRUE on success, FALSE on failure @@ -849,7 +849,7 @@ Class Reference Marks a ``$_SESSION`` item key (or multiple ones) as "flashdata". - .. method:: get_flash_keys() + .. php:method:: get_flash_keys() :returns: Array containing the keys of all "flashdata" items. :rtype: array @@ -857,7 +857,7 @@ Class Reference Gets a list of all ``$_SESSION`` that have been marked as "flashdata". - .. method:: umark_flash($key) + .. php:method:: umark_flash($key) :param mixed $key: Key to be un-marked as flashdata, or an array of multiple keys :rtype: void @@ -865,7 +865,7 @@ Class Reference Unmarks a ``$_SESSION`` item key (or multiple ones) as "flashdata". - .. method:: flashdata([$key = NULL]) + .. php:method:: flashdata([$key = NULL]) :param mixed $key: Flashdata item key or NULL :returns: Value of the specified item key, or an array of all flashdata @@ -879,7 +879,7 @@ Class Reference compatibility with older applications. You should directly access ``$_SESSION`` instead. - .. method:: keep_flashdata($key) + .. php:method:: keep_flashdata($key) :param mixed $key: Flashdata key to keep, or an array of multiple keys :returns: TRUE on success, FALSE on failure @@ -892,7 +892,7 @@ Class Reference compatibility with older applications. It is just an alias for the ``mark_as_flash()`` method. - .. method:: set_flashdata($data[, $value = NULL]) + .. php:method:: set_flashdata($data[, $value = NULL]) :param mixed $data: An array of key/value pairs to set as flashdata, or the key for a single item :param mixed $value: The value to set for a specific session item, if $data is a key @@ -904,7 +904,7 @@ Class Reference .. note:: This is a legacy method kept only for backwards compatibility with older applications. - .. method:: mark_as_temp($key[, $ttl = 300]) + .. php:method:: mark_as_temp($key[, $ttl = 300]) :param mixed $key: Key to mark as tempdata, or an array of multiple keys :param int $ttl: Time-to-live value for the tempdata, in seconds @@ -914,7 +914,7 @@ Class Reference Marks a ``$_SESSION`` item key (or multiple ones) as "tempdata". - .. method:: get_temp_keys() + .. php:method:: get_temp_keys() :returns: Array containing the keys of all "tempdata" items. :rtype: array @@ -922,7 +922,7 @@ Class Reference Gets a list of all ``$_SESSION`` that have been marked as "tempdata". - .. method:: umark_temp($key) + .. php:method:: umark_temp($key) :param mixed $key: Key to be un-marked as tempdata, or an array of multiple keys :rtype: void @@ -930,7 +930,7 @@ Class Reference Unmarks a ``$_SESSION`` item key (or multiple ones) as "tempdata". - .. method:: tempdata([$key = NULL]) + .. php:method:: tempdata([$key = NULL]) :param mixed $key: Tempdata item key or NULL :returns: Value of the specified item key, or an array of all tempdata @@ -944,7 +944,7 @@ Class Reference compatibility with older applications. You should directly access ``$_SESSION`` instead. - .. method:: set_tempdata($data[, $value = NULL]) + .. php:method:: set_tempdata($data[, $value = NULL]) :param mixed $data: An array of key/value pairs to set as tempdata, or the key for a single item :param mixed $value: The value to set for a specific session item, if $data is a key @@ -957,7 +957,7 @@ Class Reference .. note:: This is a legacy method kept only for backwards compatibility with older applications. - .. method:: sess_regenerate([$destroy = FALSE]) + .. php:method:: sess_regenerate([$destroy = FALSE]) :param bool $destroy: Whether to destroy session data :rtype: void @@ -969,7 +969,7 @@ Class Reference `session_regenerate_id() <http://php.net/session_regenerate_id>`_ function. - .. method:: sess_destroy() + .. php:method:: sess_destroy() :rtype: void @@ -983,7 +983,7 @@ Class Reference `session_destroy() <http://php.net/session_destroy>`_ function. - .. method:: __get($key) + .. php:method:: __get($key) :param string $key: Session item key :returns: The requested session data item, or NULL if it doesn't exist @@ -997,7 +997,7 @@ Class Reference ``session_id()`` if you try to access ``$this->session->session_id``. - .. method:: __set($key, $value) + .. php:method:: __set($key, $value) :param string $key: Session item key :param mixed $value: Value to assign to the session item key |