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) | |
| csrf () | |
| ip () | |
| stamp () | |
| agent () | |
| __construct (\DB\Jig $db, $table='sessions') | |
| Public Member Functions inherited from DB\Jig\Mapper | |
| dbtype () | |
| 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, $func=NULL) | |
| copyto ($key) | |
| fields () | |
| __construct (\DB\Jig $db, $file) | |
| Public Member Functions inherited from DB\Cursor | |
| dbtype () | |
| 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) | |
| first () | |
| last () | |
| skip ($ofs=1) | |
| next () | |
| prev () | |
| save () | |
| erase () | |
| onload ($func) | |
| beforeinsert ($func) | |
| afterinsert ($func) | |
| oninsert ($func) | |
| beforeupdate ($func) | |
| afterupdate ($func) | |
| onupdate ($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) | |
| __isset ($key) | |
| offsetset ($key, $val) | |
| __set ($key, $val) | |
| offsetget ($key) | |
| __get ($key) | |
| offsetunset ($key) | |
| __unset ($key) | |
Protected Attributes | |
| $sid | |
| Session ID. | |
| Protected Attributes inherited from DB\Jig\Mapper | |
| $db | |
| Flat-file DB wrapper. | |
| Protected Attributes inherited from DB\Cursor | |
| $query =array() | |
| Query results. | |
Additional Inherited Members | |
| Public Attributes inherited from DB\Jig\Mapper | |
| $file | |
| Data file. | |
| $id | |
| Document identifier. | |
| $document =array() | |
| Document contents. | |
| 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\Jig\Mapper | |
| factory ($id, $row) | |
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 | ( | ) |
Return HTTP user agent
- Returns
- string|FALSE
| DB\Jig\Session::cleanup | ( | $max | ) |
Garbage collector
- Returns
- TRUE
- Parameters
-
$max int
| DB\Jig\Session::close | ( | ) |
Close session
- Returns
- TRUE
| DB\Jig\Session::csrf | ( | ) |
Return anti-CSRF token
- Returns
- string|FALSE
| DB\Jig\Session::destroy | ( | $id | ) |
Destroy session
- Returns
- TRUE
- Parameters
-
$id string
| DB\Jig\Session::ip | ( | ) |
Return IP address
- Returns
- string|FALSE
| 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 | ( | ) |
Return Unix timestamp
- Returns
- string|FALSE
| 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