XCacheSession Class Reference
[XCache]

Redirect session to write to XCache. More...

Inheritance diagram for XCacheSession:

List of all members.

Public Member Functions
	close ()
	Close a session.
	destroy ($key)
	Delete a session.
	gc ($lifetime)
	Delete outdated sessions.
	open ($save_path, $session_name)
	Open a session.
	read ($key)
	Load session data from xcache.
	write ($key, $value)
	Write session data to XCache.
Protected Member Functions
	create_key ($key)

---

Detailed Description

Redirect session to write to XCache.

Author:

Gerd Riesselmann

Definition at line 8 of file session.xcache.impl.php.

---

Member Function Documentation

XCacheSession::close

(

)

Close a session.

Implements ISessionHandler.

Definition at line 19 of file session.xcache.impl.php.

                                {
                //Note that for security reasons the Debian and Ubuntu distributions of 
                //php do not call _gc to remove old sessions, but instead run /etc/cron.d/php*, 
                //which check the value of session.gc_maxlifetime in php.ini and delete the session 
                //files in /var/lib/php*.  This is all fine, but it means if you write your own 
                //session handlers you'll need to explicitly call your _gc function yourself.  
                //A good place to do this is in your _close function
                
                // Since XCache takes care of life time, no gc is needed
                //$this->gc(ini_get('session.gc_maxlifetime'));
                return true;
        }

XCacheSession::create_key

(

$

key

)

[protected]

Definition at line 75 of file session.xcache.impl.php.

                                            {
                return 'g$s' . Config::get_url(Config::URL_DOMAIN) . '_' . $key;
        } 

XCacheSession::destroy

(

$

key

)

Delete a session.

Implements ISessionHandler.

Definition at line 63 of file session.xcache.impl.php.

                                      {
                xcache_unset($this->create_key($key));
        }

XCacheSession::gc

(

$

lifetime

)

Delete outdated sessions.

Implements ISessionHandler.

Definition at line 70 of file session.xcache.impl.php.

                                      {
                // XCache does this for us
                return true;
        }

XCacheSession::open	(	$	save_path,
		$	session_name
	)

Open a session.

Implements ISessionHandler.

Definition at line 12 of file session.xcache.impl.php.

                                                        {
                return true;
        }

XCacheSession::read

(

$

key

)

Load session data from xcache.

Implements ISessionHandler.

Definition at line 35 of file session.xcache.impl.php.

                                   {
                // Write and Close handlers are called after destructing objects since PHP 5.0.5
                // Thus destructors can use sessions but session handler can't use objects.
                // So we are moving session closure before destructing objects.
                register_shutdown_function('session_write_close');
                $key = $this->create_key($key);
                if (xcache_isset($key)) {
                        return xcache_get($key);
                }
                return '';
        }

XCacheSession::write	(	$	key,
		$	value
	)

Write session data to XCache.

Implements ISessionHandler.

Definition at line 50 of file session.xcache.impl.php.

                                            {
                try {
                        xcache_set($this->create_key($key), $value, ini_get('session.gc_maxlifetime'));
                        return true;
                }
                catch(Exception $ex) {
                        return false;
                }       
        }

---

The documentation for this class was generated from the following file:

• contributions/cache.xcache/session.xcache.impl.php