File: session-regenerate-id.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (80 lines) | stat: -rw-r--r-- 1,974 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
  <refentry id="function.session-regenerate-id">
   <refnamediv>
    <refname>session_regenerate_id</refname>
    <refpurpose>
     Update the current session id with a newly generated one
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>session_regenerate_id</methodname>
      <void />
     </methodsynopsis>
    <para>
     <function>session_regenerate_id</function> will replace the current
     session id with a new one, and keep the current session information.
    </para>
    <para>
     &return.success;
    </para>
    <para>
     <example>
      <title>A <function>session_regenerate_id</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
session_start();

$old_sessionid = session_id();

session_regenerate_id();

$new_sessionid = session_id();

echo "Old Session: $old_sessionid<br />";
echo "New Session: $new_sessionid<br />";

print_r($_SESSION);
?>
]]>
      </programlisting>
     </example>
    </para>
    <note>
     <para>
      As of PHP 4.3.3, if session cookies are enabled, use of
      <function>session_regenerate_id</function> will also submit a new
      session cookie with the new session id.
     </para>
    </note>
    <para>
     See also <function>session_id</function>,
     <function>session_start</function>, and 
     <function>session_name</function>.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->