DB\Mongo\Session Class Reference

MongoDB-managed session handler. More...

Inheritance diagram for DB\Mongo\Session:

Public Member Functions
	open ($path, $name)
	close ()
	read ($id)
	write ($id, $data)
	destroy ($id)
	cleanup ($max)
	ip ($id=NULL)
	stamp ($id=NULL)
	agent ($id=NULL)
	__construct (\DB\Mongo $db, $table='sessions')
Public Member Functions inherited from DB\Mongo\Mapper
	exists ($key)
	set ($key, $val)
	get ($key)
	clear ($key)
	cast ($obj=NULL)
	select ($fields=NULL, $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)
	copyto ($key)
	__construct (\DB\Mongo $db, $collection)
Public Member Functions inherited from DB\Cursor
	find ($filter=NULL, array $options=NULL)
	insert ()
	update ()
	dry ()
	findone ($filter=NULL, array $options=NULL, $ttl=0)
	paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL)
	load ($filter=NULL, array $options=NULL)
	first ()
	last ()
	skip ($ofs=1)
	next ()
	prev ()
	save ()
	erase ()
	reset ()
Public Member Functions inherited from Magic
	exists ($key)
	set ($key, $val)
	get ($key)
	clear ($key)
	offsetexists ($key)
	__isset ($key)
	offsetset ($key, $val)
	__set ($key, $val)
	offsetget ($key)
	__get ($key)
	offsetunset ($key)
	__unset ($key)

Additional Inherited Members
Public Attributes inherited from DB\Mongo\Mapper
	$collection
	Mongo collection.
	$document =array()
	Mongo document.
Protected Member Functions inherited from DB\Mongo\Mapper
	factory ($row)
Protected Attributes inherited from DB\Mongo\Mapper
	$db
	MongoDB wrapper.

Detailed Description

MongoDB-managed session handler.

Constructor & Destructor Documentation

DB\Mongo\Session::__construct	(	\DB\Mongo	$db,
			$table = 'sessions'
	)

Instantiate class

Parameters

$db	object
$table	string

Member Function Documentation

DB\Mongo\Session::agent

(

$id = NULL)

Return HTTP user agent associated with specified session ID

Returns

string|FALSE

Parameters

$id

string

DB\Mongo\Session::cleanup

(

$max)

Garbage collector

Returns

TRUE

Parameters

$max

int

DB\Mongo\Session::close

(

)

Close session

Returns

TRUE

DB\Mongo\Session::destroy

(

$id)

Destroy session

Returns

TRUE

Parameters

$id

string

DB\Mongo\Session::ip

(

$id = NULL)

Return IP address associated with specified session ID

Returns

string|FALSE

Parameters

$id

string

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

Open session

Returns

TRUE

Parameters

$path	string
$name	string

DB\Mongo\Session::read

(

$id)

Return session data in serialized format

Returns

string|FALSE

Parameters

$id

string

DB\Mongo\Session::stamp

(

$id = NULL)

Return Unix timestamp associated with specified session ID

Returns

string|FALSE

Parameters

$id

string

DB\Mongo\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/mongo/session.php