Slim_Session_Handler Class Reference

Inheritance diagram for Slim_Session_Handler:

Collaboration diagram for Slim_Session_Handler:

Public Member Functions
	register (Slim $app)
	Register session handler.
	open ($savePath, $sessionName)
	Open session.
	close ()
	Close session.
	read ($id)
	Read session data with ID.
	write ($id, $sessionData)
	Write session data with ID.
	destroy ($id)
	Destroy session with ID.
	gc ($maxLifetime)
	Session garbage collection.

Protected Attributes
	$app

Detailed Description

Definition at line 44 of file Handler.php.

Member Function Documentation

Slim_Session_Handler::close ( )

abstract

Close session.

Returns

mixed

Reimplemented in Slim_Session_Handler_Cookies.

Slim_Session_Handler::destroy (   $id )

abstract

Destroy session with ID.

Parameters

string

$id

The session identifier

Returns

mixed

Reimplemented in Slim_Session_Handler_Cookies.

Slim_Session_Handler::gc (   $maxLifetime )

abstract

Session garbage collection.

Executed when the PHP session garbage collector is invoked; should remove all session data older than the $maxLifetime.

Parameters

int

$maxLifetime

Returns

mixed

Reimplemented in Slim_Session_Handler_Cookies.

Slim_Session_Handler::open (   $savePath,   $sessionName  )

abstract

Open session.

Parameters

string	$savePath
string	$sessionName

Returns

mixed

Reimplemented in Slim_Session_Handler_Cookies.

Slim_Session_Handler::read (   $id )

abstract

Read session data with ID.

Parameters

string

$id

The session identifier

Returns

string

Reimplemented in Slim_Session_Handler_Cookies.

Slim_Session_Handler::register ( Slim  $app )

final

Register session handler.

Returns

bool

Definition at line 56 of file Handler.php.

References $app.

                                                {
        $this->app = $app;
        return session_set_save_handler(
            array($this, 'open'),
            array($this, 'close'),
            array($this, 'read'),
            array($this, 'write'),
            array($this, 'destroy'),
            array($this, 'gc')
        );
    }

Slim_Session_Handler::write (   $id,   $sessionData  )

abstract

Write session data with ID.

The "write" handler is not executed until after the output stream is closed. Thus, output from debugging statements in the "write" handler will never be seen in the browser. If debugging output is necessary, it is suggested that the debug output be written to a file instead.

Parameters

string	$id	The session identifier
mixed	$sessionData	The session data

Returns

mixed

Reimplemented in Slim_Session_Handler_Cookies.

Field Documentation

Slim_Session_Handler::$app

protected

Definition at line 49 of file Handler.php.

Referenced by register().

---

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

• Services/WebServices/Rest/lib/Slim/Session/Handler.php