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_1SQL_1_1Mapper.html | 838 +++++++++++++++++++++ 1 file changed, 838 insertions(+) create mode 100644 management-interface/lib/api/classDB_1_1SQL_1_1Mapper.html (limited to 'management-interface/lib/api/classDB_1_1SQL_1_1Mapper.html') diff --git a/management-interface/lib/api/classDB_1_1SQL_1_1Mapper.html b/management-interface/lib/api/classDB_1_1SQL_1_1Mapper.html new file mode 100644 index 0000000..b3f3f0c --- /dev/null +++ b/management-interface/lib/api/classDB_1_1SQL_1_1Mapper.html @@ -0,0 +1,838 @@ + + + + + + + +Fat-Free Framework: DB\SQL\Mapper Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.2.2 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
DB\SQL\Mapper Class Reference
+
+
+ +

SQL data mapper. + More...

+
+ + Inheritance diagram for DB\SQL\Mapper:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 dbtype ()
 
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 type ($pdo)
 
 cast ($obj=NULL)
 
 select ($fields, $filter=NULL, array $options=NULL, $ttl=0)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 skip ($ofs=1)
 
 insert ()
 
 update ()
 
 erase ($filter=NULL)
 
 reset ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 schema ()
 
 fields ($adhoc=TRUE)
 
 __construct (\DB\SQL $db, $table, $fields=NULL, $ttl=60)
 
- 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)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

+ $engine
 Database engine.
 
+ $source
 SQL table.
 
+ $table
 SQL table (quoted)
 
+ $_id
 Last insert ID.
 
+ $fields
 Defined fields.
 
+ $adhoc =array()
 Adhoc fields.
 
+const E_Adhoc ='Unable to process ad hoc field %s'
 
- Public Attributes inherited from DB\Cursor
+ $ptr =0
 Current position.
 
+ $trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
+ + + +

+Protected Member Functions

 factory ($row)
 
+ + + + + + + + +

+Protected Attributes

+ $db
 PDO wrapper.
 
- Protected Attributes inherited from DB\Cursor
+ $query =array()
 Query results.
 
+

Detailed Description

+

SQL data mapper.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::__construct (\DB\SQL $db,
 $table,
 $fields = NULL,
 $ttl = 60 
)
+
+

Instantiate class

+
Parameters
+ + + + + +
$dbobject
$tablestring
$fieldsarray|string
$ttlint
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
DB\SQL\Mapper::cast ( $obj = NULL)
+
+

Return fields of mapper object as an associative array

+
Returns
array
+
Parameters
+ + +
$objobject
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::clear ( $key)
+
+

Clear value of field

+
Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::copyfrom ( $key,
 $func = NULL 
)
+
+

Hydrate mapper object using hive array variable

+
Returns
NULL
+
Parameters
+ + + +
$keystring
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::copyto ( $key)
+
+

Populate hive array variable with mapper fields

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

Count records that match criteria

+
Returns
int
+
Parameters
+ + + +
$filterstring|array
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::dbtype ()
+
+

Return database type

+
Returns
string
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::erase ( $filter = NULL)
+
+

Delete current record

+
Returns
int
+
Parameters
+ + +
$filterstring|array
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::exists ( $key)
+
+

Return TRUE if field is defined

+
Returns
bool
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
DB\SQL\Mapper::factory ( $row)
+ 		+protected
+
+

Convert array to mapper object

+
Returns
object
+
Parameters
+ + +
$rowarray
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::fields ( $adhoc = TRUE)
+
+

Return field names

+
Returns
array
+
Parameters
+ + +
$adhocbool
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::find ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Return records that match criteria

+
Returns
array
+
Parameters
+ + + + +
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::get ( $key)
+
+

Retrieve value of field

+
Returns
scalar
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::insert ()
+
+

Insert new record

+
Returns
object
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::reset ()
+
+

Reset cursor

+
Returns
NULL
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::schema ()
+
+

Return schema

+
Returns
array
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::select ( $fields,
 $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Build query string and execute

+
Returns
array
+
Parameters
+ + + + + +
$fieldsstring
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::set ( $key,
 $val 
)
+
+

Assign value to field

+
Returns
scalar
+
Parameters
+ + + +
$keystring
$valscalar
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::skip ( $ofs = 1)
+
+

Return record at specified offset using same criteria as previous load() call and make it active

+
Returns
array
+
Parameters
+ + +
$ofsint
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::type ( $pdo)
+
+

Get PHP type equivalent of PDO constant

+
Returns
string
+
Parameters
+ + +
$pdostring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::update ()
+
+

Update current record

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