Documentation

Cache
in package
implements SessionDriver

Session cache driver.

Cache library config goes in the session.storage config entry: $config['storage'] = array( 'driver' => 'apc', 'requests' => 10000 ); Lifetime does not need to be set as it is overridden by the session expiration setting.

Table of Contents

Interfaces

SessionDriver
Session driver interface

Properties

$cache  : Cache
$encrypt  : EncryptInterface

Methods

__construct()  : mixed
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.

Properties

Methods

__construct()

public __construct() : mixed

close()

Closes a session.

public close() : bool
Return values
bool

destroy()

Destroys a session.

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

Session id

Return values
bool

gc()

Garbage collection.

public gc(mixed $maxlifetime) : bool
Parameters
$maxlifetime : mixed

Session expiration period

Return values
bool

open()

Opens a session.

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

Save path

$name : mixed

Session name

Return values
bool

read()

Reads a session.

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

Session id

Return values
string

regenerate()

Regenerates the session id.

public regenerate() : string
Return values
string

write()

Writes a session.

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

Session id

$data : mixed

Session data

Return values
bool
On this page

Search results