Fat-Free Framework: Session Class Reference

Fat-Free-Framework

Fat-Free Framework  3.1.0 API Reference
Session Class Reference

Cache-based session handler. More...

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 ()
 

Detailed Description

Cache-based session handler.

Constructor & Destructor Documentation

Session::__construct ( )

Instantiate class

Returns
object

Member Function Documentation

Session::agent (   $id = NULL)

Return HTTP user agent associated with specified session ID

Returns
string|FALSE
Parameters
$idstring
Session::cleanup (   $max)

Garbage collector

Returns
TRUE
Parameters
$maxint
Session::close ( )

Close session

Returns
TRUE
Session::destroy (   $id)

Destroy session

Returns
TRUE
Parameters
$idstring
Session::ip (   $id = NULL)

Return IP address associated with specified session ID

Returns
string|FALSE
Parameters
$idstring
Session::open (   $path,
  $name 
)

Open session

Returns
TRUE
Parameters
$pathstring
$namestring
Session::read (   $id)

Return session data in serialized format

Returns
string|FALSE
Parameters
$idstring
Session::stamp (   $id = NULL)

Return Unix timestamp associated with specified session ID

Returns
string|FALSE
Parameters
$idstring
Session::write (   $id,
  $data 
)

Write session data

Returns
TRUE
Parameters
$idstring
$datastring

The documentation for this class was generated from the following file:
  • session.php
Generated on Mon Aug 19 2013 21:27:51 for Fat-Free Framework by   doxygen 1.8.4