Fat-Free Framework
3.4.0
|
Simple cursor implementation. More...
Public Member Functions | |
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 () | |
![]() | |
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) | |
Public Attributes | |
$ptr =0 | |
Current position. | |
$trigger =array() | |
Event listeners. | |
const | E_Field ='Undefined field %s' |
Protected Attributes | |
$query =array() | |
Query results. | |
Simple cursor implementation.
DB\Cursor::aftererase | ( | $func | ) |
Define aftererase trigger
$func | callback |
DB\Cursor::afterinsert | ( | $func | ) |
Define afterinsert trigger
$func | callback |
DB\Cursor::aftersave | ( | $func | ) |
Define aftersave trigger
$func | callback |
DB\Cursor::afterupdate | ( | $func | ) |
Define afterupdate trigger
$func | callback |
DB\Cursor::beforeerase | ( | $func | ) |
Define beforeerase trigger
$func | callback |
DB\Cursor::beforeinsert | ( | $func | ) |
Define beforeinsert trigger
$func | callback |
DB\Cursor::beforesave | ( | $func | ) |
Define beforesave trigger
$func | callback |
DB\Cursor::beforeupdate | ( | $func | ) |
Define beforeupdate trigger
$func | callback |
|
abstract |
Return fields of mapper object as an associative array
$obj | object |
|
abstract |
Hydrate mapper object using hive array variable
$key | string |
$func | callback |
|
abstract |
Populate hive array variable with mapper fields
$key | string |
|
abstract |
Count records that match criteria
$filter | array |
$ttl | int |
|
abstract |
Return database type
DB\Cursor::dry | ( | ) |
Get cursor's equivalent external iterator Causes a fatal error in PHP 5.3.5if uncommented return ArrayIterator Return TRUE if current cursor position is not mapped to any record
DB\Cursor::erase | ( | ) |
Delete current record
|
abstract |
Return field names
|
abstract |
Return records (array of mapper objects) that match criteria
$filter | string|array |
$options | array |
$ttl | int |
DB\Cursor::findone | ( | $filter = NULL , |
|
array | $options = NULL , |
||
$ttl = 0 |
|||
) |
Return first record (mapper object) that matches criteria
$filter | string|array |
$options | array |
$ttl | int |
DB\Cursor::first | ( | ) |
Map to first record in cursor
|
abstract |
Insert new record
DB\Cursor::last | ( | ) |
Map to last record in cursor
DB\Cursor::load | ( | $filter = NULL , |
|
array | $options = NULL , |
||
$ttl = 0 |
|||
) |
Map to first record that matches criteria
$filter | string|array |
$options | array |
$ttl | int |
DB\Cursor::loaded | ( | ) |
Return the count of records loaded
DB\Cursor::next | ( | ) |
Map next record
DB\Cursor::onerase | ( | $func | ) |
Define onerase trigger
$func | callback |
DB\Cursor::oninsert | ( | $func | ) |
Define oninsert trigger
$func | callback |
DB\Cursor::onload | ( | $func | ) |
Define onload trigger
$func | callback |
DB\Cursor::onsave | ( | $func | ) |
Define onsave trigger
$func | callback |
DB\Cursor::onupdate | ( | $func | ) |
Define onupdate trigger
$func | callback |
DB\Cursor::paginate | ( | $pos = 0 , |
|
$size = 10 , |
|||
$filter = NULL , |
|||
array | $options = NULL , |
||
$ttl = 0 |
|||
) |
Return array containing subset of records matching criteria, total number of records in superset, specified limit, number of subsets available, and actual subset position
$pos | int |
$size | int |
$filter | string|array |
$options | array |
$ttl | int |
DB\Cursor::prev | ( | ) |
Map previous record
DB\Cursor::reset | ( | ) |
Reset cursor
DB\Cursor::save | ( | ) |
Save mapped record
DB\Cursor::skip | ( | $ofs = 1 | ) |
Map to nth record relative to current cursor position
$ofs | int |
|
abstract |
Update current record
DB\Cursor::valid | ( | ) |
Return whether current iterator position is valid.