From 87cdfc1751d1e2f16cf651393049c5f6fb1a8efb Mon Sep 17 00:00:00 2001 From: friendica Date: Sat, 15 Nov 2014 14:03:28 -0800 Subject: doc updates --- doc/html/classdba__driver.html | 260 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 256 insertions(+), 4 deletions(-) (limited to 'doc/html/classdba__driver.html') diff --git a/doc/html/classdba__driver.html b/doc/html/classdba__driver.html index e70d8bf1f..33b6d16db 100644 --- a/doc/html/classdba__driver.html +++ b/doc/html/classdba__driver.html @@ -114,38 +114,69 @@ $(document).ready(function(){initNavTree('classdba__driver.html','');});
dba_driver Class Reference
+ +

abstract database driver class. + More...

Inheritance diagram for dba_driver:
-dba_mysql -dba_mysqli +dba_mysql +dba_mysqli +dba_postgres
+ + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 connect ($server, $port, $user, $pass, $db)
 Connect to the database. More...
 
 q ($sql)
 Perform a DB query with the SQL statement $sql. More...
 
 escape ($str)
 Escape a string before being passed to a DB query. More...
 
 close ()
 Close the database connection. More...
 
 __construct ($server, $port, $user, $pass, $db, $install=false)
 
 get_null_date ()
 
 get_install_script ()
 
 utcnow ()
 
 install ($server, $user, $pass, $db)
 
 dbg ($dbg)
 Sets the database driver's debugging state. More...
 
 __destruct ()
 
 quote_interval ($txt)
 
 optimize_table ($table)
 
 concat ($fld, $sep)
 
 escapebin ($str)
 
 unescapebin ($str)
 
+ + + + + + @@ -158,7 +189,10 @@ Protected Attributes

Public Attributes

const INSTALL_SCRIPT ='install/schema_mysql.sql'
 
const NULL_DATE = '0000-00-00 00:00:00'
 
const UTC_NOW = 'UTC_TIMESTAMP()'
 
 $connected = false
 
 $error = false
 $db
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

abstract database driver class.

+

This class gets extended by the real database driver classes, e.g. dba_mysql, dba_mysqli.

+

Constructor & Destructor Documentation

@@ -246,8 +280,37 @@ Protected Attributes
+

Close the database connection.

+

This abstract function needs to be implemented in the real driver.

+

Referenced by __destruct().

+
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
dba_driver::concat ( $fld,
 $sep 
)
+
+
@@ -300,6 +363,20 @@ Protected Attributes
+

Connect to the database.

+

This abstract function needs to be implemented in the real driver.

+
Parameters
+ + + + + + +
string$serverDB server name
string$portDB port
string$userDB username
string$passDB password
string$dbdatabase name
+
+
+
Returns
bool
+

Referenced by __construct().

@@ -318,6 +395,14 @@ Protected Attributes
+

Sets the database driver's debugging state.

+
Parameters
+ + +
int$dbg0 to disable debugging
+
+
+
@@ -342,6 +427,61 @@ Protected Attributes
+

Escape a string before being passed to a DB query.

+

This abstract function needs to be implemented in the real driver.

+
Parameters
+ + +
string$strThe string to escape.
+
+
+ +
+ + +
+
+ + + + + + + + +
dba_driver::escapebin ( $str)
+
+ +
+
+ +
+
+ + + + + + + +
dba_driver::get_install_script ()
+
+ +
+
+ +
+
+ + + + + + + +
dba_driver::get_null_date ()
+
+
@@ -382,6 +522,22 @@ Protected Attributes

Referenced by __construct().

+ + + +
+
+ + + + + + + + +
dba_driver::optimize_table ( $table)
+
+
@@ -406,6 +562,64 @@ Protected Attributes
+

Perform a DB query with the SQL statement $sql.

+

This abstract function needs to be implemented in the real driver.

+
Parameters
+ + +
string$sqlThe SQL query to execute
+
+
+ +

Referenced by optimize_table().

+ +
+ + +
+
+ + + + + + + + +
dba_driver::quote_interval ( $txt)
+
+ +
+
+ +
+
+ + + + + + + + +
dba_driver::unescapebin ( $str)
+
+ +
+
+ +
+
+ + + + + + + +
dba_driver::utcnow ()
+
+

Member Data Documentation

@@ -419,6 +633,8 @@ Protected Attributes
+

Referenced by dba_postgres\connect().

+
@@ -439,7 +655,7 @@ Protected Attributes
-

Referenced by __construct(), dba_mysqli\connect(), and dba_mysql\connect().

+

Referenced by __construct(), dba_mysqli\connect(), dba_mysql\connect(), and dba_postgres\connect().

@@ -473,6 +689,42 @@ Protected Attributes
+
+ + +
+
+ + + + +
const dba_driver::INSTALL_SCRIPT ='install/schema_mysql.sql'
+
+ +
+
+ +
+
+ + + + +
const dba_driver::NULL_DATE = '0000-00-00 00:00:00'
+
+ +
+
+ +
+
+ + + + +
const dba_driver::UTC_NOW = 'UTC_TIMESTAMP()'
+
+
The documentation for this class was generated from the following file: