[sessionhandler] Added information about individual methods.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323551 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Drak 2012-02-26 05:30:34 +00:00
parent 1baa10dc5d
commit a63190d9c4
7 changed files with 72 additions and 1 deletions

View file

@ -17,7 +17,7 @@
wrap the six session save handler callbacks. By default PHP uses the <parameter>files</parameter>
save handler as defined by <link linkend="ini.session.save-handler">session.save_handler</link>.
Others are provided by PHP extensions such as SQLite (as <parameter>sqlite</parameter>),
Memcache (as <parameter>memcache</parameter>), and <parameter>Memcached</parameter>.
Memcache (as <parameter>memcache</parameter>), and Memcached (as <parameter>Memcached</parameter>).
</para>
<para>
This class can be extended, and it's methods overridden by inheritance including

View file

@ -17,6 +17,19 @@
Closes the current session. This function is automaticaly executed when
closing the session, or explicitly via <function>session_write_close</function>.
</para>
<para>
This method wraps the internal PHP save handler defined in the
<link linkend="ini.session.save-handler">session.save_handler</link> ini setting that was set
before this handler was set by <function>session_set_save_handler</function>.
</para>
<para>
If this class is extended by inheritiance, calling the parent <parameter>open</parameter> method will invoke the
wrapper for this method and therefor invoke the associated internal callback. This allows this method to be
overidden and or intercepted.
</para>
<para>
For more information on what this method is expected to do, please refer to the documetation at <function>SessionHandlerInterface::close</function>.
</para>
</refsect1>

View file

@ -17,6 +17,14 @@
Destroys a session. Called by <function>session_regenerate_id</function>,
<function>session_destroy</function> and when <function>session_decode</function> fails.
</para>
<para>
This method wraps the internal PHP save handler defined in the
<link linkend="ini.session.save-handler">session.save_handler</link> ini setting that was set
before this handler was set by <function>session_set_save_handler</function>.
</para>
<para>
For more information on what this method is expected to do, please refer to the documetation at <function>SessionHandlerInterface::destroy</function>.
</para>
</refsect1>
<refsect1 role="parameters">

View file

@ -18,6 +18,14 @@
based on <link linkend="ini.session.gc-divisor">session.gc_divisor</link> and
<link linkend="ini.session.gc-probability">session.gc_probability</link> settings.
</para>
<para>
This method wraps the internal PHP save handler defined in the
<link linkend="ini.session.save-handler">session.save_handler</link> ini setting that was set
before this handler was set by <function>session_set_save_handler</function>.
</para>
<para>
For more information on what this method is expected to do, please refer to the documetation at <function>SessionHandlerInterface::gc</function>.
</para>
</refsect1>
<refsect1 role="parameters">

View file

@ -18,6 +18,19 @@
Re-initialize existing session, or creates a new one. Called from
<function>session_start</function>.
</para>
<para>
This method wraps the internal PHP save handler defined in the
<link linkend="ini.session.save-handler">session.save_handler</link> ini setting that was set
before this handler was set by <function>session_set_save_handler</function>.
</para>
<para>
If this class is extended by inheritiance, calling the parent <parameter>open</parameter> method will invoke the
wrapper for this method and therefor invoke the associated internal callback. This allows this method to be
overidden and or intercepted and filtered.
</para>
<para>
For more information on what this method is expected to do, please refer to the documetation at <function>SessionHandlerInterface::open</function>.
</para>
</refsect1>
<refsect1 role="parameters">

View file

@ -17,6 +17,20 @@
Reads the session data from the session storage, and returns the results.
Called right after <function>session_start</function>.
</para>
<para>
This method wraps the internal PHP save handler defined in the
<link linkend="ini.session.save-handler">session.save_handler</link> ini setting that was set
before this handler was set by <function>session_set_save_handler</function>.
</para>
<para>
If this class is extended by inheritiance, calling the parent <parameter>read</parameter> method will invoke the
wrapper for this method and therefor invoke the associated internal callback. This allows this method to be
overidden and or intercepted and filtered (for example, decrypting <parameter>$data</parameter> value
returned by the parent <parameter>read</parameter> method).
</para>
<para>
For more information on what this method is expected to do, please refer to the documetation at <function>SessionHandlerInterface::read</function>.
</para>
</refsect1>
<refsect1 role="parameters">

View file

@ -18,6 +18,21 @@
Writes the session data to the session storage. Called by
<function>session_write_close</function>, when <function>session_register_shutdown</function> fails, and during request shutdown.
</para>
<para>
This method wraps the internal PHP save handler defined in the
<link linkend="ini.session.save-handler">session.save_handler</link> ini setting that was set
before this handler was set by <function>session_set_save_handler</function>.
</para>
<para>
If this class is extended by inheritiance, calling the parent <parameter>write</parameter> method will invoke the
wrapper for this method and therefor invoke the associated internal callback. This allows this method to be
overidden and or intercepted and filtered (for example, encrypting the <parameter>$data</parameter> value
before sending it to the parent <parameter>write</parameter> method).
</para>
<para>
For more information on what this method is expected to do, please refer to the documetation at <function>SessionHandlerInterface::write</function>.
</para>
</refsect1>
<refsect1 role="parameters">