ilSessionDBHandler Class Reference

Inheritance diagram for ilSessionDBHandler:

Collaboration diagram for ilSessionDBHandler:

Public Member Functions
	setSaveHandler ()
	Registers the session save handler session.save_handler must be 'user'. More...
	open ($path, $name)
	Opens session, normally a db connection would be opened here, but we use the standard ilias db connection, so nothing must be done here. More...
	close ()
	close session More...
	read ($id)
	Reads data of the session identified by $session_id and returns it as a serialised string. More...
	write ($id, $data)
	Writes serialized session data to the database. More...
	destroy ($id)
	Destroys session. More...
	gc (int $max_lifetime)
	Removes sessions that weren't updated for more than gc_maxlifetime seconds. More...

Detailed Description

Definition at line 21 of file class.ilSessionDBHandler.php.

Member Function Documentation

close()

ilSessionDBHandler::close

(

)

close session

for a db nothing has to be done here

Definition at line 55 of file class.ilSessionDBHandler.php.

                           : bool
    {
        return true;
    }

destroy()

ilSessionDBHandler::destroy

(

$id

)

Destroys session.

Parameters

string

$id

session id

Definition at line 87 of file class.ilSessionDBHandler.php.

                                : bool
    {
        return ilSession::_destroy($id);
    }

References $id, and ilSession\_destroy().

Here is the call graph for this function:

gc()

ilSessionDBHandler::gc

(

int

$max_lifetime

)

Removes sessions that weren't updated for more than gc_maxlifetime seconds.

Parameters

int

$max_lifetime

Sessions that have not updated for the last max_lifetime seconds will be removed.

Definition at line 96 of file class.ilSessionDBHandler.php.

                                         : int | false
    {
        return ilSession::_destroyExpiredSessions();
    }

References ilSession\_destroyExpiredSessions().

Here is the call graph for this function:

open()

ilSessionDBHandler::open	(		$path,
			$name
	)

Opens session, normally a db connection would be opened here, but we use the standard ilias db connection, so nothing must be done here.

Parameters

string	$path
string	$name	session name [PHPSESSID]

Definition at line 45 of file class.ilSessionDBHandler.php.

                                      : bool
    {
        return true;
    }

read()

ilSessionDBHandler::read

(

$id

)

Reads data of the session identified by $session_id and returns it as a serialised string.

If there is no session with this ID an empty string is returned

Parameters

string

$id

Definition at line 66 of file class.ilSessionDBHandler.php.

                             : string
    {
        return ilSession::_getData($id);
    }

References $id, and ilSession\_getData().

Here is the call graph for this function:

setSaveHandler()

ilSessionDBHandler::setSaveHandler

(

)

Registers the session save handler session.save_handler must be 'user'.

Definition at line 27 of file class.ilSessionDBHandler.php.

                                    : bool
    {
        if (session_status() === PHP_SESSION_ACTIVE) {
            return true;
        }
 
        return session_set_save_handler(
            $this,
            true // Registers session_write_close() as a register_shutdown_function() function.
        );
    }

write()

ilSessionDBHandler::write	(		$id,
			$data
	)

Writes serialized session data to the database.

Parameters

string	$id	session id
string	$data	session data

Definition at line 76 of file class.ilSessionDBHandler.php.

                                     : bool
    {
        chdir(IL_INITIAL_WD);
 
        return ilSession::_writeData($id, $data);
    }

References $data, and $id.

---

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

• components/ILIAS/Authentication/classes/class.ilSessionDBHandler.php