From 155cf6aeea9ba7ecbc39face6442d3ce1b03ad8e Mon Sep 17 00:00:00 2001 From: Nils Schwabe Date: Wed, 4 Jun 2014 14:27:03 +0200 Subject: Add webinterface with functionallity --- .../lib/api/classDB_1_1Cursor.html | 999 +++++++++++++++++++++ 1 file changed, 999 insertions(+) create mode 100644 management-interface/lib/api/classDB_1_1Cursor.html (limited to 'management-interface/lib/api/classDB_1_1Cursor.html') diff --git a/management-interface/lib/api/classDB_1_1Cursor.html b/management-interface/lib/api/classDB_1_1Cursor.html new file mode 100644 index 0000000..3bc6d70 --- /dev/null +++ b/management-interface/lib/api/classDB_1_1Cursor.html @@ -0,0 +1,999 @@ + + + + + + + +Fat-Free Framework: DB\Cursor Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.2.2 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Attributes | +List of all members
+
+
DB\Cursor Class Reference
+
+
+ +

Simple cursor implementation. + More...

+
+ + Inheritance diagram for DB\Cursor:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

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

+Public Attributes

+ $ptr =0
 Current position.
 
+ $trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
+ + + + +

+Protected Attributes

+ $query =array()
 Query results.
 
+

Detailed Description

+

Simple cursor implementation.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
DB\Cursor::aftererase ( $func)
+
+

Define aftererase trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::afterinsert ( $func)
+
+

Define afterinsert trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::afterupdate ( $func)
+
+

Define afterupdate trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::beforeerase ( $func)
+
+

Define beforeerase trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::beforeinsert ( $func)
+
+

Define beforeinsert trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::beforeupdate ( $func)
+
+

Define beforeupdate trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
DB\Cursor::cast ( $obj = NULL)
+ 		+abstract
+
+

Return fields of mapper object as an associative array

+
Returns
array
+
Parameters
+ + +
$objobject
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
DB\Cursor::copyfrom ( $key,
 $func = NULL 
)
+ 		+abstract
+
+

Hydrate mapper object using hive array variable

+
Returns
NULL
+
Parameters
+ + + +
$keystring
$funccallback
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
DB\Cursor::copyto ( $key)
+ 		+abstract
+
+

Populate hive array variable with mapper fields

+
Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
DB\Cursor::count ( $filter = NULL,
 $ttl = 0 
)
+ 		+abstract
+
+

Count records that match criteria

+
Returns
int
+
Parameters
+ + + +
$filterarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DB\Cursor::dbtype ()
+ 		+abstract
+
+

Return database type

+
Returns
string
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::dry ()
+
+

Return TRUE if current cursor position is not mapped to any record

+
Returns
bool
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::erase ()
+
+

Delete current record

+
Returns
int|bool
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\Cursor::find ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+ 		+abstract
+
+

Return records (array of mapper objects) that match criteria

+
Returns
array
+
Parameters
+ + + + +
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\Cursor::findone ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Return first record (mapper object) that matches criteria

+
Returns
object|FALSE
+
Parameters
+ + + + +
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::first ()
+
+

Map to first record in cursor

+
Returns
mixed
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DB\Cursor::insert ()
+ 		+abstract
+
+

Insert new record

+
Returns
array
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::last ()
+
+

Map to last record in cursor

+
Returns
mixed
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\Cursor::load ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Map to first record that matches criteria

+
Returns
array|FALSE
+
Parameters
+ + + + +
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::next ()
+
+

Map next record

+
Returns
mixed
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::onerase ( $func)
+
+

Define onerase trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::oninsert ( $func)
+
+

Define oninsert trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::onload ( $func)
+
+

Define onload trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::onupdate ( $func)
+
+

Define onupdate trigger

+
Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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

+
Returns
array
+
Parameters
+ + + + + + +
$posint
$sizeint
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::prev ()
+
+

Map previous record

+
Returns
mixed
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::reset ()
+
+

Reset cursor

+
Returns
NULL
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::save ()
+
+

Save mapped record

+
Returns
mixed
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::skip ( $ofs = 1)
+
+

Map to nth record relative to current cursor position

+
Returns
mixed
+
Parameters
+ + +
$ofsint
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DB\Cursor::update ()
+ 		+abstract
+
+

Update current record

+
Returns
array
+ +
+
+
The documentation for this class was generated from the following file: +
-- cgit v1.2.3-55-g7522