MediaWiki 1.17.0

[autoinstallsdev/mediawiki.git] / includes / MemcachedSessions.php

diff --git a/includes/MemcachedSessions.php b/includes/MemcachedSessions.php
index af49109ce91218d21fe2c5eb293b73ebb7d2424c..4f10f99c66e5073f667a5ad0ca773cb7a5055951 100644 (file)
--- a/includes/MemcachedSessions.php
+++ b/includes/MemcachedSessions.php
@@ -6,35 +6,47 @@
  * be necessary to change the cookie settings to work across hostnames.
  * See: http://www.php.net/manual/en/function.session-set-save-handler.php
  *
- * @package MediaWiki
+ * @file
+ * @ingroup Cache
  */
 
 /**
- * @todo document
+ * Get a cache key for the given session id.
+ *
+ * @param $id String: session id
+ * @return String: cache key
  */
 function memsess_key( $id ) {
-       global $wgDBname;
-       return "$wgDBname:session:$id";
+       return wfMemcKey( 'session', $id );
 }
 
 /**
- * @todo document
+ * Callback when opening a session.
+ * NOP: $wgMemc should be set up already.
+ *
+ * @param $save_path String: path used to store session files, unused
+ * @param $session_name String: session name
+ * @return Boolean: success
  */
 function memsess_open( $save_path, $session_name ) {
-       # NOP, $wgMemc should be set up already
        return true;
 }
 
 /**
- * @todo document
+ * Callback when closing a session.
+ * NOP.
+ *
+ * @return Boolean: success
  */
 function memsess_close() {
-       # NOP
        return true;
 }
 
 /**
- * @todo document
+ * Callback when reading session data.
+ *
+ * @param $id String: session id
+ * @return Mixed: session data
  */
 function memsess_read( $id ) {
        global $wgMemc;
@@ -44,7 +56,11 @@ function memsess_read( $id ) {
 }
 
 /**
- * @todo document
+ * Callback when writing session data.
+ *
+ * @param $id String: session id
+ * @param $data Mixed: session data
+ * @return Boolean: success
  */
 function memsess_write( $id, $data ) {
        global $wgMemc;
@@ -53,22 +69,27 @@ function memsess_write( $id, $data ) {
 }
 
 /**
- * @todo document
+ * Callback to destroy a session when calling session_destroy().
+ *
+ * @param $id String: session id
+ * @return Boolean: success
  */
 function memsess_destroy( $id ) {
        global $wgMemc;
+
        $wgMemc->delete( memsess_key( $id ) );
        return true;
 }
 
 /**
- * @todo document
+ * Callback to execute garbage collection.
+ * NOP: Memcached performs garbage collection.
+ *
+ * @param $maxlifetime Integer: maximum session life time
+ * @return Boolean: success
  */
 function memsess_gc( $maxlifetime ) {
-       # NOP: Memcached performs garbage collection.
        return true;
 }
 
 session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read', 'memsess_write', 'memsess_destroy', 'memsess_gc' );
-
-?>