[PHP-DOC] cvs: phpdoc /en/functions session.xml

[Yasuo Ohgaki]

yohgaki         Sun Jan 20 04:07:28 2002 EDT

  Modified files:              
    /phpdoc/en/functions        session.xml 
  Log:
  Added more warnings for mixed usage for track vars 
  ($HTTP_SESSION_VARS/$_SESSION) and functions for global vars
  session handleing functions (session_register/session_is_register/
  session_unregister)
  # These warnings are required since session module does not handle
  # PS(vars) and PS(http_session_vars) cocnsistent manner :)
  
  
Index: phpdoc/en/functions/session.xml
diff -u phpdoc/en/functions/session.xml:1.75 phpdoc/en/functions/session.xml:1.76
--- phpdoc/en/functions/session.xml:1.75        Sat Jan 19 02:48:07 2002
+++ phpdoc/en/functions/session.xml     Sun Jan 20 04:07:28 2002
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.75 $ -->
+<!-- $Revision: 1.76 $ -->
  <reference id="ref.session">
   <title>Session handling functions</title>
   <titleabbrev>Sessions</titleabbrev>
@@ -51,6 +51,8 @@
      linkend="ini.track-vars"><literal>track_vars</literal></link> is
      always turned on.
     </para>
+   </note>
+   <note>
     <para>
      As of PHP 4.1.0, $_SESSION is available as global variable just
      like $_POST, $_GET, $_REQUEST and so on.  Not like
@@ -94,7 +96,7 @@
     $HTTP_SESSION_VARS, there is no need to use
     session_register()/session_unregister()/session_is_registered()
     functions. Users can access session variable like a normal
-    variable.
+    variable. 
     <example>
      <title>
       Registering a variable with $_SESSION.
@@ -137,6 +139,15 @@
     variables with session_register() function while
     $HTTP_SESSION_VARS/$_SESSION does not need to use
     session_register().
+    <caution>
+     <para>
+      If you are using $HTTP_SESSION_VARS/$_SESSION, do not use
+      <function>session_register</function>,
+      <function>session_is_registered</function> and
+      <function>session_unregister</function> unless you know internal
+      of session module.
+     </para>
+    </caution>
     <example>
      <title>
       Registering a variable with <link
@@ -690,6 +701,14 @@
       arrays as noted below.
      </para>
     </caution>
+    <caution>
+     <para>
+      If you are using $HTTP_SESSION_VARS/$_SESSION, do not use
+      <function>session_register</function>,
+      <function>session_is_registered</function> and
+      <function>session_unregister</function>.
+     </para>
+    </caution>
     <para>
      This function returns &true; when all of the variables are successfully
      registered with the session.
@@ -780,6 +799,14 @@
       to remove the corresponding global variable.
      </para>
     </caution>
+    <caution>
+     <para>
+      If you are using $HTTP_SESSION_VARS/$_SESSION, do not use
+      <function>session_register</function>,
+      <function>session_is_registered</function> and
+      <function>session_unregister</function>.
+     </para>
+    </caution>
    </refsect1>
   </refentry>
   
@@ -839,6 +866,14 @@
       registered in $_SESSION.
      </para>
     </note>
+    <caution>
+     <para>
+      If you are using $HTTP_SESSION_VARS/$_SESSION, do not use
+      <function>session_register</function>,
+      <function>session_is_registered</function> and
+      <function>session_unregister</function>.
+     </para>
+    </caution>
    </refsect1>
   </refentry>