PHP Class DB\Jig\Session

Inheritance: extends Mapper

Datei anzeigen Open project: bcosca/fatfree-core

Protected Properties

Property	Type	Description
$_agent
$_csrf
$_ip
$onsuspect
$sid

Public Methods

Method	Description
__construct ( Jig $db, $file = 'sessions', $onsuspect = NULL, $key = NULL )	Instantiate class
agent ( ) : string \| FALSE	Return HTTP user agent
cleanup ( $max ) : TRUE	Garbage collector
close ( ) : TRUE	Close session
csrf ( ) : string	Return anti-CSRF token
destroy ( $id ) : TRUE	Destroy session
ip ( ) : string	Return IP address
open ( $path, $name ) : TRUE	Open session
read ( $id ) : string \| FALSE	Return session data in serialized format
sid ( ) : string \| null	Return session id (if session has started)
stamp ( ) : string \| FALSE	Return Unix timestamp
write ( $id, $data ) : TRUE	Write session data

Method Details

__construct() public method

Instantiate class

public __construct ( Jig $db, $file = 'sessions', $onsuspect = NULL, $key = NULL )
$db	DB\Jig	\DB\Jig
$file		string
$onsuspect		callback
$key		string

agent() public method

Return HTTP user agent

public agent ( ) : string \| FALSE
return	string \| FALSE

cleanup() public method

Garbage collector

public cleanup ( $max ) : TRUE
$max		int
return	TRUE

close() public method

Close session

public close ( ) : TRUE
return	TRUE

csrf() public method

Return anti-CSRF token

public csrf ( ) : string
return	string

destroy() public method

Destroy session

public destroy ( $id ) : TRUE
$id		string
return	TRUE

ip() public method

Return IP address

public ip ( ) : string
return	string

open() public method

Open session

public open ( $path, $name ) : TRUE
$path		string
$name		string
return	TRUE

read() public method

Return session data in serialized format

public read ( $id ) : string \| FALSE
$id		string
return	string \| FALSE

sid() public method

Return session id (if session has started)

public sid ( ) : string \| null
return	string \| null

stamp() public method

Return Unix timestamp

public stamp ( ) : string \| FALSE
return	string \| FALSE

write() public method

Write session data

public write ( $id, $data ) : TRUE
$id		string
$data		string
return	TRUE

Property Details

$_agent protected_oe property

protected $_agent

$_csrf protected_oe property

protected $_csrf

$_ip protected_oe property

protected $_ip

$onsuspect protected_oe property

protected $onsuspect

$sid protected_oe property

protected $sid