Documentation

SessionDriver

Session driver interface

Table of Contents

Methods

close()  : bool
Closes a session.
destroy()  : bool
Destroys a session.
gc()  : bool
Garbage collection.
open()  : bool
Opens a session.
read()  : string
Reads a session.
regenerate()  : string
Regenerates the session id.
write()  : bool
Writes a session.

Methods

close()

Closes a session.

public close() : bool
Return values
bool

destroy()

Destroys a session.

public destroy(string $id) : bool
Parameters
$id : string

Session id

Return values
bool

gc()

Garbage collection.

public gc(int|string $maxlifetime) : bool
Parameters
$maxlifetime : int|string

Session expiration period

Return values
bool

open()

Opens a session.

public open(string $path, string $name) : bool
Parameters
$path : string

Save path

$name : string

Session name

Return values
bool

read()

Reads a session.

public read(string $id) : string
Parameters
$id : string

Session id

Return values
string

regenerate()

Regenerates the session id.

public regenerate() : string
Return values
string

write()

Writes a session.

public write(string $id, string $data) : bool
Parameters
$id : string

Session id

$data : string

Session data

Return values
bool
On this page

Search results