From a63190d9c474f19bcc54c643fdd7424623e48c38 Mon Sep 17 00:00:00 2001 From: Drak Date: Sun, 26 Feb 2012 05:30:34 +0000 Subject: [PATCH] [sessionhandler] Added information about individual methods. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323551 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/session/sessionhandler.xml | 2 +- reference/session/sessionhandler/close.xml | 13 +++++++++++++ reference/session/sessionhandler/destroy.xml | 8 ++++++++ reference/session/sessionhandler/gc.xml | 8 ++++++++ reference/session/sessionhandler/open.xml | 13 +++++++++++++ reference/session/sessionhandler/read.xml | 14 ++++++++++++++ reference/session/sessionhandler/write.xml | 15 +++++++++++++++ 7 files changed, 72 insertions(+), 1 deletion(-) diff --git a/reference/session/sessionhandler.xml b/reference/session/sessionhandler.xml index d5982ffdec..957d3865da 100644 --- a/reference/session/sessionhandler.xml +++ b/reference/session/sessionhandler.xml @@ -17,7 +17,7 @@ wrap the six session save handler callbacks. By default PHP uses the files save handler as defined by session.save_handler. Others are provided by PHP extensions such as SQLite (as sqlite), - Memcache (as memcache), and Memcached. + Memcache (as memcache), and Memcached (as Memcached). This class can be extended, and it's methods overridden by inheritance including diff --git a/reference/session/sessionhandler/close.xml b/reference/session/sessionhandler/close.xml index 3ec7f4fcf2..f0af8d509a 100644 --- a/reference/session/sessionhandler/close.xml +++ b/reference/session/sessionhandler/close.xml @@ -17,6 +17,19 @@ Closes the current session. This function is automaticaly executed when closing the session, or explicitly via session_write_close. + + This method wraps the internal PHP save handler defined in the + session.save_handler ini setting that was set + before this handler was set by session_set_save_handler. + + + If this class is extended by inheritiance, calling the parent open 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. + + + For more information on what this method is expected to do, please refer to the documetation at SessionHandlerInterface::close. + diff --git a/reference/session/sessionhandler/destroy.xml b/reference/session/sessionhandler/destroy.xml index ec616258ba..db508f96d2 100644 --- a/reference/session/sessionhandler/destroy.xml +++ b/reference/session/sessionhandler/destroy.xml @@ -17,6 +17,14 @@ Destroys a session. Called by session_regenerate_id, session_destroy and when session_decode fails. + + This method wraps the internal PHP save handler defined in the + session.save_handler ini setting that was set + before this handler was set by session_set_save_handler. + + + For more information on what this method is expected to do, please refer to the documetation at SessionHandlerInterface::destroy. + diff --git a/reference/session/sessionhandler/gc.xml b/reference/session/sessionhandler/gc.xml index d711e05530..3a13efec71 100644 --- a/reference/session/sessionhandler/gc.xml +++ b/reference/session/sessionhandler/gc.xml @@ -18,6 +18,14 @@ based on session.gc_divisor and session.gc_probability settings. + + This method wraps the internal PHP save handler defined in the + session.save_handler ini setting that was set + before this handler was set by session_set_save_handler. + + + For more information on what this method is expected to do, please refer to the documetation at SessionHandlerInterface::gc. + diff --git a/reference/session/sessionhandler/open.xml b/reference/session/sessionhandler/open.xml index 2a4c3a2bec..263a04c6e3 100644 --- a/reference/session/sessionhandler/open.xml +++ b/reference/session/sessionhandler/open.xml @@ -18,6 +18,19 @@ Re-initialize existing session, or creates a new one. Called from session_start. + + This method wraps the internal PHP save handler defined in the + session.save_handler ini setting that was set + before this handler was set by session_set_save_handler. + + + If this class is extended by inheritiance, calling the parent open 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 more information on what this method is expected to do, please refer to the documetation at SessionHandlerInterface::open. + diff --git a/reference/session/sessionhandler/read.xml b/reference/session/sessionhandler/read.xml index 393be7d5ef..0c328a709b 100644 --- a/reference/session/sessionhandler/read.xml +++ b/reference/session/sessionhandler/read.xml @@ -17,6 +17,20 @@ Reads the session data from the session storage, and returns the results. Called right after session_start. + + This method wraps the internal PHP save handler defined in the + session.save_handler ini setting that was set + before this handler was set by session_set_save_handler. + + + If this class is extended by inheritiance, calling the parent read 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 $data value + returned by the parent read method). + + + For more information on what this method is expected to do, please refer to the documetation at SessionHandlerInterface::read. + diff --git a/reference/session/sessionhandler/write.xml b/reference/session/sessionhandler/write.xml index e4b1cb8746..ef3a7c3fa2 100644 --- a/reference/session/sessionhandler/write.xml +++ b/reference/session/sessionhandler/write.xml @@ -18,6 +18,21 @@ Writes the session data to the session storage. Called by session_write_close, when session_register_shutdown fails, and during request shutdown. + + This method wraps the internal PHP save handler defined in the + session.save_handler ini setting that was set + before this handler was set by session_set_save_handler. + + + If this class is extended by inheritiance, calling the parent write 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 $data value + before sending it to the parent write method). + + + For more information on what this method is expected to do, please refer to the documetation at SessionHandlerInterface::write. + +