Merge "Fixes to Special:WithoutInterwiki form"
[lhc/web/wiklou.git] / includes / objectcache / ObjectCacheSessionHandler.php
index e6c6881..bc76294 100644 (file)
@@ -1,5 +1,5 @@
 <?php
-/*
+/**
  * Session storage in object cache.
  *
  * This program is free software; you can redistribute it and/or modify
  * @file
  * @ingroup Cache
  */
+
+/**
+ * Session storage in object cache.
+ * Used if $wgSessionsInObjectCache is true.
+ *
+ * @ingroup Cache
+ */
 class ObjectCacheSessionHandler {
        /**
         * Install a session handler for the current web request
@@ -51,7 +58,7 @@ class ObjectCacheSessionHandler {
        /**
         * Get a cache key for the given session id.
         *
-        * @param $id String: session id
+        * @param string $id session id
         * @return String: cache key
         */
        static function getKey( $id ) {
@@ -82,7 +89,7 @@ class ObjectCacheSessionHandler {
        /**
         * Callback when reading session data.
         *
-        * @param $id String: session id
+        * @param string $id session id
         * @return Mixed: session data
         */
        static function read( $id ) {
@@ -96,7 +103,7 @@ class ObjectCacheSessionHandler {
        /**
         * Callback when writing session data.
         *
-        * @param $id String: session id
+        * @param string $id session id
         * @param $data Mixed: session data
         * @return Boolean: success
         */
@@ -109,7 +116,7 @@ class ObjectCacheSessionHandler {
        /**
         * Callback to destroy a session when calling session_destroy().
         *
-        * @param $id String: session id
+        * @param string $id session id
         * @return Boolean: success
         */
        static function destroy( $id ) {
@@ -129,7 +136,7 @@ class ObjectCacheSessionHandler {
        }
 
        /**
-        * Shutdown function. See the comment inside ObjectCacheSessionHandler::install 
+        * Shutdown function. See the comment inside ObjectCacheSessionHandler::install
         * for rationale.
         */
        static function handleShutdown() {