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

[Yasuo Ohgaki]

yohgaki         Thu Jan 10 02:37:38 2002 EDT

  Modified files:              
    /phpdoc/en/functions        session.xml 
  Log:
  Clarify user session save handlers return values 
  
  
Index: phpdoc/en/functions/session.xml
diff -u phpdoc/en/functions/session.xml:1.71 phpdoc/en/functions/session.xml:1.72
--- phpdoc/en/functions/session.xml:1.71        Mon Jan  7 06:23:25 2002
+++ phpdoc/en/functions/session.xml     Thu Jan 10 02:37:38 2002
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.71 $ -->
+<!-- $Revision: 1.72 $ -->
  <reference id="ref.session">
   <title>Session handling functions</title>
   <titleabbrev>Sessions</titleabbrev>
@@ -1011,6 +1011,12 @@
      supported database engine.
     </para>
     <para>
+     Read function must return string value always to make save
+     handler work as expected. Return empty string if there is no data
+     to read. Return values from other handlers are converted to
+     boolean expression. TRUE for success, FALSE for failure.
+    </para>
+    <para>
      <example>
       <title>
        <function>session_set_save_handler</function> example
@@ -1038,7 +1044,7 @@
     $sess_data = fread($fp, filesize($sess_file));
     return($sess_data);
   } else {
-    return(""); // Must return ("") here.
+    return(""); // Must return "" here.
   }
 
 }