Use Doxygen @addtogroup instead of phpdoc @package && @subpackage
[lhc/web/wiklou.git] / includes / MemcachedSessions.php
1 <?php
2 /**
3 * This file gets included if $wgSessionsInMemcache is set in the config.
4 * It redirects session handling functions to store their data in memcached
5 * instead of the local filesystem. Depending on circumstances, it may also
6 * be necessary to change the cookie settings to work across hostnames.
7 * See: http://www.php.net/manual/en/function.session-set-save-handler.php
8 *
9 */
10
11 /**
12 * @todo document
13 */
14 function memsess_key( $id ) {
15 return wfMemcKey( 'session', $id );
16 }
17
18 /**
19 * @todo document
20 */
21 function memsess_open( $save_path, $session_name ) {
22 # NOP, $wgMemc should be set up already
23 return true;
24 }
25
26 /**
27 * @todo document
28 */
29 function memsess_close() {
30 # NOP
31 return true;
32 }
33
34 /**
35 * @todo document
36 */
37 function memsess_read( $id ) {
38 global $wgMemc;
39 $data = $wgMemc->get( memsess_key( $id ) );
40 if( ! $data ) return '';
41 return $data;
42 }
43
44 /**
45 * @todo document
46 */
47 function memsess_write( $id, $data ) {
48 global $wgMemc;
49 $wgMemc->set( memsess_key( $id ), $data, 3600 );
50 return true;
51 }
52
53 /**
54 * @todo document
55 */
56 function memsess_destroy( $id ) {
57 global $wgMemc;
58 $wgMemc->delete( memsess_key( $id ) );
59 return true;
60 }
61
62 /**
63 * @todo document
64 */
65 function memsess_gc( $maxlifetime ) {
66 # NOP: Memcached performs garbage collection.
67 return true;
68 }
69
70 session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read', 'memsess_write', 'memsess_destroy', 'memsess_gc' );
71
72 ?>