DB\SQL\Session Class Reference

SQL-managed session handler. More...

Inheritance diagram for DB\SQL\Session:

Public Member Functions
	open ($path, $name)
	close ()
	read ($id)
	write ($id, $data)
	destroy ($id)
	cleanup ($max)
	csrf ()
	ip ()
	stamp ()
	agent ()
	__construct (\DB\SQL $db, $table='sessions', $force=TRUE)
Public Member Functions inherited from DB\SQL\Mapper
	dbtype ()
	exists ($key)
	set ($key, $val)
&	get ($key)
	clear ($key)
	type ($pdo)
	cast ($obj=NULL)
	select ($fields, $filter=NULL, array $options=NULL, $ttl=0)
	find ($filter=NULL, array $options=NULL, $ttl=0)
	count ($filter=NULL, $ttl=0)
	skip ($ofs=1)
	insert ()
	update ()
	erase ($filter=NULL)
	reset ()
	copyfrom ($key, $func=NULL)
	copyto ($key)
	schema ()
	fields ($adhoc=TRUE)
	getiterator ()
	__construct (\DB\SQL $db, $table, $fields=NULL, $ttl=60)
Public Member Functions inherited from DB\Cursor
	dbtype ()
	fields ()
	cast ($obj=NULL)
	find ($filter=NULL, array $options=NULL, $ttl=0)
	count ($filter=NULL, $ttl=0)
	insert ()
	update ()
	copyfrom ($key, $func=NULL)
	copyto ($key)
	dry ()
	findone ($filter=NULL, array $options=NULL, $ttl=0)
	paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
	load ($filter=NULL, array $options=NULL, $ttl=0)
	loaded ()
	first ()
	last ()
	skip ($ofs=1)
	next ()
	prev ()
	valid ()
	save ()
	erase ()
	onload ($func)
	beforeinsert ($func)
	afterinsert ($func)
	oninsert ($func)
	beforeupdate ($func)
	afterupdate ($func)
	onupdate ($func)
	beforesave ($func)
	aftersave ($func)
	onsave ($func)
	beforeerase ($func)
	aftererase ($func)
	onerase ($func)
	reset ()
Public Member Functions inherited from Magic
	exists ($key)
	set ($key, $val)
&	get ($key)
	clear ($key)
	offsetexists ($key)
	offsetset ($key, $val)
&	offsetget ($key)
	offsetunset ($key)
	__isset ($key)
	__set ($key, $val)
&	__get ($key)
	__unset ($key)

Protected Attributes
	$sid
	Session ID.
Protected Attributes inherited from DB\SQL\Mapper
	$db
	PDO wrapper.
Protected Attributes inherited from DB\Cursor
	$query =array()
	Query results.

Additional Inherited Members
Public Attributes inherited from DB\SQL\Mapper
	$engine
	Database engine.
	$source
	SQL table.
	$table
	SQL table (quoted)
	$_id
	Last insert ID.
	$fields
	Defined fields.
	$adhoc =array()
	Adhoc fields.
const	E_Adhoc ='Unable to process ad hoc field %s'
Public Attributes inherited from DB\Cursor
	$ptr =0
	Current position.
	$trigger =array()
	Event listeners.
const	E_Field ='Undefined field %s'
Protected Member Functions inherited from DB\SQL\Mapper
	factory ($row)

Detailed Description

SQL-managed session handler.

Constructor & Destructor Documentation

DB\SQL\Session::__construct	(	\DB\SQL	$db,
			$table = 'sessions',
			$force = TRUE
	)

Instantiate class

Parameters

$db	object
$table	string
$force	bool

Member Function Documentation

DB\SQL\Session::agent

(

)

Return HTTP user agent

Returns

string|FALSE

DB\SQL\Session::cleanup

(

$max

)

Garbage collector

Returns

TRUE

Parameters

$max

int

DB\SQL\Session::close

(

)

Close session

Returns

TRUE

DB\SQL\Session::csrf

(

)

Return anti-CSRF token

Returns

string|FALSE

DB\SQL\Session::destroy

(

$id

)

Destroy session

Returns

TRUE

Parameters

$id

string

DB\SQL\Session::ip

(

)

Return IP address

Returns

string|FALSE

DB\SQL\Session::open	(		$path,
			$name
	)

Open session

Returns

TRUE

Parameters

$path	string
$name	string

DB\SQL\Session::read

(

$id

)

Return session data in serialized format

Returns

string|FALSE

Parameters

$id

string

DB\SQL\Session::stamp

(

)

Return Unix timestamp

Returns

string|FALSE

DB\SQL\Session::write	(		$id,
			$data
	)

Write session data

Returns

TRUE

Parameters

$id	string
$data	string

---

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

• db/sql/session.php