ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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. More...
 
 open ( $savePath, $sessionName)
 Open session. More...
 
 close ()
 Close session. More...
 
 read ( $id)
 Read session data with ID. More...
 
 write ( $id, $sessionData)
 Write session data with ID. More...
 
 destroy ( $id)
 Destroy session with ID. More...
 
 gc ( $maxLifetime)
 Session garbage collection. More...
 

Protected Attributes

 $app
 

Detailed Description

Definition at line 44 of file Handler.php.

Member Function Documentation

◆ close()

Slim_Session_Handler::close ( )
abstract

Close session.

Returns
mixed

Reimplemented in Slim_Session_Handler_Cookies.

◆ destroy()

Slim_Session_Handler::destroy (   $id)
abstract

Destroy session with ID.

Parameters
string$idThe session identifier
Returns
mixed

Reimplemented in Slim_Session_Handler_Cookies.

◆ gc()

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.

◆ open()

Slim_Session_Handler::open (   $savePath,
  $sessionName 
)
abstract

Open session.

Parameters
string$savePath
string$sessionName
Returns
mixed

Reimplemented in Slim_Session_Handler_Cookies.

◆ read()

Slim_Session_Handler::read (   $id)
abstract

Read session data with ID.

Parameters
string$idThe session identifier
Returns
string

Reimplemented in Slim_Session_Handler_Cookies.

◆ register()

Slim_Session_Handler::register ( Slim  $app)
final

Register session handler.

Returns
bool

Definition at line 56 of file Handler.php.

56 {
57 $this->app = $app;
58 return session_set_save_handler(
59 array($this, 'open'),
60 array($this, 'close'),
61 array($this, 'read'),
62 array($this, 'write'),
63 array($this, 'destroy'),
64 array($this, 'gc')
65 );
66 }

References $app.

◆ write()

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$idThe session identifier
mixed$sessionDataThe session data
Returns
mixed

Reimplemented in Slim_Session_Handler_Cookies.

Field Documentation

◆ $app

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: