cvs: phpdoc /en/reference/session/functions session-set-cookie-params.xml session-set-save-handler.xml
| From: | Kalle Sommer Nielsen | Date: | Thu, 14 Aug 2008 22:24:22 +0000 |
| Subject: | cvs: phpdoc /en/reference/session/functions session-set-cookie-params.xml session-set-save-handler.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2033@lists.php.net to get a copy of this message | ||
kalle Thu Aug 14 22:24:22 2008 UTC
Modified files:
/phpdoc/en/reference/session/functions
session-set-cookie-params.xml
session-set-save-handler.xml
Log:
Fixes #45164 (Missing descriptions of parameters)
Also adds missing parameters for session_set_save_handler()
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/session/functions/session-set-cookie-params.xml?r1=1.8&r2=1.9&diff_format=u
Index: phpdoc/en/reference/session/functions/session-set-cookie-params.xml
diff -u phpdoc/en/reference/session/functions/session-set-cookie-params.xml:1.8
phpdoc/en/reference/session/functions/session-set-cookie-params.xml:1.9
--- phpdoc/en/reference/session/functions/session-set-cookie-params.xml:1.8 Wed Jun 20 22:25:22 2007
+++ phpdoc/en/reference/session/functions/session-set-cookie-params.xml Thu Aug 14 22:24:21 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<refentry xmlns="http://docbook.org/ns/docbook"
xml:id="function.session-set-cookie-params">
<refnamediv>
<refname>session_set_cookie_params</refname>
@@ -32,6 +32,7 @@
<term><parameter>lifetime</parameter></term>
<listitem>
<para>
+ Lifetime of the session cookie, defined in seconds.
</para>
</listitem>
</varlistentry>
@@ -39,6 +40,8 @@
<term><parameter>path</parameter></term>
<listitem>
<para>
+ Path on the domain where the cookie will work. Use a single
+ slash ('/') for all paths on the domain.
</para>
</listitem>
</varlistentry>
@@ -46,6 +49,9 @@
<term><parameter>domain</parameter></term>
<listitem>
<para>
+ Cookie domain, for example 'www.php.net'. To make cookies visable
+ on all subdomains then the domain must be prefixed with a dot like
+ '.php.net'.
</para>
</listitem>
</varlistentry>
@@ -53,6 +59,7 @@
<term><parameter>secure</parameter></term>
<listitem>
<para>
+ If &true; cookie will only be sent over secure connections.
</para>
</listitem>
</varlistentry>
@@ -60,6 +67,8 @@
<term><parameter>httponly</parameter></term>
<listitem>
<para>
+ If set to &true; then PHP will attempt to send the httponly
+ flag when setting the session cookie.
</para>
</listitem>
</varlistentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/session/functions/session-set-save-handler.xml?r1=1.21&r2=1.22&diff_format=u
Index: phpdoc/en/reference/session/functions/session-set-save-handler.xml
diff -u phpdoc/en/reference/session/functions/session-set-save-handler.xml:1.21
phpdoc/en/reference/session/functions/session-set-save-handler.xml:1.22
--- phpdoc/en/reference/session/functions/session-set-save-handler.xml:1.21 Fri Aug 17 11:37:47 2007
+++ phpdoc/en/reference/session/functions/session-set-save-handler.xml Thu Aug 14 22:24:22 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.21 $ -->
+<!-- $Revision: 1.22 $ -->
<refentry xmlns="http://docbook.org/ns/docbook"
xml:id="function.session-set-save-handler">
<refnamediv>
<refname>session_set_save_handler</refname>
@@ -34,6 +34,10 @@
<term><parameter>open</parameter></term>
<listitem>
<para>
+ Open function, this works like a constructor in classes and is
+ executed when the session is being opened. The open function
+ expects two parameters, where the first is the save path and
+ the second is the session name.
</para>
</listitem>
</varlistentry>
@@ -41,6 +45,8 @@
<term><parameter>close</parameter></term>
<listitem>
<para>
+ Close function, this works like a destructor in classes and is
+ executed when the session operation is done.
</para>
</listitem>
</varlistentry>
@@ -75,6 +81,9 @@
<term><parameter>destroy</parameter></term>
<listitem>
<para>
+ The destroy handler, this is executed when a session is destroyed with
+ <function>session_destroy</function> and takes the session id as its
+ only parameter.
</para>
</listitem>
</varlistentry>
@@ -82,6 +91,8 @@
<term><parameter>gc</parameter></term>
<listitem>
<para>
+ The garbage collector, this is executed when the session garbage collector
+ is executed and takes the max session lifetime as its only parameter.
</para>
</listitem>
</varlistentry>