|
Fat-Free Framework
3.1.0 API Reference
|
DB\Jig\Session Class Reference
Jig-managed session handler. More...
Inheritance diagram for DB\Jig\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\Jig $db, $table='sessions') | |
 Public Member Functions inherited from DB\Jig\Mapper | |
| exists ($key) | |
| set ($key, $val) | |
| get ($key) | |
| clear ($key) | |
| cast ($obj=NULL) | |
| token ($str) | |
| find ($filter=NULL, array $options=NULL, $ttl=0, $log=TRUE) | |
| count ($filter=NULL, $ttl=0) | |
| skip ($ofs=1) | |
| insert () | |
| update () | |
| erase ($filter=NULL) | |
| reset () | |
| copyfrom ($key) | |
| copyto ($key) | |
| __construct (\DB\Jig $db, $file) | |
| 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\Jig\Mapper | |
| $file | |
| Data file. | |
| $id | |
| Document identifier. | |
| $document =array() | |
| Document contents. | |
| Protected Member Functions inherited from DB\Jig\Mapper | |
| factory ($id, $row) | |
| Protected Attributes inherited from DB\Jig\Mapper | |
| $db | |
| Flat-file DB wrapper. | |
Detailed Description
Jig-managed session handler.
Constructor & Destructor Documentation
| DB\Jig\Session::__construct | ( | \DB\Jig | $db, |
$table = 'sessions' |
|||
| ) |
Instantiate class
- Parameters
-
$db object $table string
Member Function Documentation
| DB\Jig\Session::agent | ( | $id = NULL) |
Return HTTP user agent associated with specified session ID
- Returns
- string|FALSE
- Parameters
-
$id string
| DB\Jig\Session::cleanup | ( | $max) |
Garbage collector
- Returns
- TRUE
- Parameters
-
$max int
| DB\Jig\Session::close | ( | ) |
Close session
- Returns
- TRUE
| DB\Jig\Session::destroy | ( | $id) |
Destroy session
- Returns
- TRUE
- Parameters
-
$id string
| DB\Jig\Session::ip | ( | $id = NULL) |
Return IP address associated with specified session ID
- Returns
- string|FALSE
- Parameters
-
$id string
| DB\Jig\Session::open | ( | $path, | |
| $name | |||
| ) |
Open session
- Returns
- TRUE
- Parameters
-
$path string $name string
| DB\Jig\Session::read | ( | $id) |
Return session data in serialized format
- Returns
- string|FALSE
- Parameters
-
$id string
| DB\Jig\Session::stamp | ( | $id = NULL) |
Return Unix timestamp associated with specified session ID
- Returns
- string|FALSE
- Parameters
-
$id string
| DB\Jig\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/jig/session.php
Generated on Mon Aug 19 2013 21:28:02 for Fat-Free Framework by
1.8.4