1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. Lib
  9. \
  10. Session
  11. \
  12. SqlSessionHandler

SqlSessionHandler

class SqlSessionHandler implements SessionHandlerInterface, SessionDirtyFlagStorageInterface, SessionManagementInterface

Class sql_session_handler

Properties

int $life_time

Methods

__construct(Session $xf_session, $db)

sql_session_handler constructor.

mixed
clean_user_session($session_id)

No description

bool
close()

Closes the current session

bool
connect()

No description

bool
destroy($session_id)

No description

bool
gc(int $maxlifetime)

Garbage Collector to remove old Sessions (called based on session.gc_probability)

array
get_current_sessions()

No description

bool
is_dirty()

Dirty?

logout_all_users()

No description

logout_user($user_ids)

No description

bool
open(string $save_path, string $session_name)

No description

pollute_user_session($user_ids)

No description

string
read($session_id)

Read the passed session and returns the stored data

bool
write($session_id, $session_data)

No description

Details

at line 54
__construct(Session $xf_session, $db)

sql_session_handler constructor.

Parameters

Session $xf_session

Link to the session object (not using XF due to early initialization)
$db

at line 339
mixed clean_user_session($session_id)

No description

Parameters

$session_id

Return Value

mixed

at line 81
bool close()

Closes the current session

Return Value

bool

at line 383
bool connect()

No description

Return Value

bool

True if Handler is available and successfully connected, false otherwise

at line 295
bool destroy($session_id)

No description

Parameters

$session_id

Return Value

bool

at line 305
bool gc(int $maxlifetime)

Garbage Collector to remove old Sessions (called based on session.gc_probability)

Parameters

int $maxlifetime

Return Value

bool

at line 374
array get_current_sessions()

No description

Return Value

array

at line 60
bool is_dirty()

Dirty?

Return Value

bool

at line 351
logout_all_users()

No description

at line 360
logout_user($user_ids)

No description

Parameters

$user_ids

at line 73
bool open(string $save_path, string $session_name)

No description

Parameters

string $save_path
string $session_name

Return Value

bool

at line 326
pollute_user_session($user_ids)

No description

Parameters

$user_ids

at line 93
string read($session_id)

Read the passed session and returns the stored data

Parameters

$session_id

Return Value

string

Exceptions

Exception

at line 143
bool write($session_id, $session_data)

No description

Parameters

$session_id
$session_data

Return Value

bool

Exceptions

Exception