[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/objectcache/ -> ObjectCacheSessionHandler.php (summary)

Session storage in object cache. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 146 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ObjectCacheSessionHandler:: (10 methods):
  install()
  getCache()
  getKey()
  open()
  close()
  read()
  write()
  destroy()
  gc()
  handleShutdown()


Class: ObjectCacheSessionHandler  - X-Ref

Session storage in object cache.
Used if $wgSessionsInObjectCache is true.

install()   X-Ref
Install a session handler for the current web request


getCache()   X-Ref
Get the cache storage object to use for session storage

return: ObjectCache

getKey( $id )   X-Ref
Get a cache key for the given session id.

param: string $id Session id
return: string Cache key

open( $save_path, $session_name )   X-Ref
Callback when opening a session.

param: string $save_path Path used to store session files, unused
param: string $session_name Session name
return: bool Success

close()   X-Ref
Callback when closing a session.
NOP.

return: bool Success

read( $id )   X-Ref
Callback when reading session data.

param: string $id Session id
return: mixed Session data

write( $id, $data )   X-Ref
Callback when writing session data.

param: string $id Session id
param: mixed $data Session data
return: bool Success

destroy( $id )   X-Ref
Callback to destroy a session when calling session_destroy().

param: string $id Session id
return: bool Success

gc( $maxlifetime )   X-Ref
Callback to execute garbage collection.
NOP: Object caches perform garbage collection implicitly

param: int $maxlifetime Maximum session life time
return: bool Success

handleShutdown()   X-Ref
Shutdown function. See the comment inside ObjectCacheSessionHandler::install
for rationale.




Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1