From 585542815dab2f717101f29661bf41d4eb49e2f2 Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Wed, 28 Nov 2012 10:13:19 -0500 Subject: [PATCH] Update docs --- docs/classes.svg | 421 +-- docs/classes/BadConnectionException.html | 226 ++ docs/classes/BadDBDriverException.html | 226 ++ docs/classes/DB_PDO.html | 80 +- docs/classes/DB_SQL.html | 61 +- docs/classes/DB_Util.html | 6 +- docs/classes/Firebird.html | 100 +- docs/classes/Firebird_Result.html | 6 +- docs/classes/Firebird_SQL.html | 81 +- docs/classes/Firebird_Util.html | 6 +- docs/classes/MySQL.html | 100 +- docs/classes/MySQL_SQL.html | 81 +- docs/classes/MySQL_Util.html | 6 +- docs/classes/ODBC.html | 102 +- docs/classes/ODBC_SQL.html | 81 +- docs/classes/ODBC_Util.html | 6 +- .../OpenSQLManager.Connection_Manager.html | 13 +- .../OpenSQLManager.Connection_Sidebar.html | 44 +- docs/classes/OpenSQLManager.DB_Reg.html | 6 +- docs/classes/OpenSQLManager.DB_tabs.html | 31 +- docs/classes/OpenSQLManager.Data_Grid.html | 6 +- docs/classes/OpenSQLManager.Main.html | 45 +- .../OpenSQLManager.OpenSQLManager.html | 6 +- docs/classes/OpenSQLManager.Settings.html | 6 +- docs/classes/PgSQL.html | 106 +- docs/classes/PgSQL_SQL.html | 81 +- docs/classes/PgSQL_Util.html | 6 +- docs/classes/Query_Builder.html | 272 +- docs/classes/Query_Parser.html | 152 + docs/classes/SQLite.html | 100 +- docs/classes/SQLite_SQL.html | 81 +- docs/classes/SQLite_Util.html | 6 +- docs/deprecated.html | 6 +- docs/errors.html | 184 +- docs/graph_class.html | 6 +- docs/index.html | 10 +- docs/markers.html | 30 +- docs/namespaces/OpenSQLManager.html | 60 +- docs/namespaces/default.html | 56 +- docs/packages/.html | 6 +- docs/packages/Default.html | 70 +- docs/packages/OpenSQLManager.Common.html | 6 +- docs/packages/OpenSQLManager.Widgets.html | 6 +- docs/packages/OpenSQLManager.Windows.html | 6 +- docs/packages/OpenSQLManager.html | 6 +- docs/packages/Query.Drivers.html | 6 +- docs/packages/Query.Query.html | 30 +- docs/packages/Query.html | 58 +- docs/structure.xml | 2752 ++++++++++------- 49 files changed, 3662 insertions(+), 2186 deletions(-) create mode 100644 docs/classes/BadConnectionException.html create mode 100644 docs/classes/BadDBDriverException.html create mode 100644 docs/classes/Query_Parser.html diff --git a/docs/classes.svg b/docs/classes.svg index 5bce772..d79e67c 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -4,380 +4,421 @@ - - + + G - + cluster_OpenSQLManager - - - - - - - - -OpenSQLManager + + + + + + + + +OpenSQLManager cluster_default - - - - - - - - + + + + + + + + \\OpenSQLManager\\OpenSQLManager - -OpenSQLManager + +OpenSQLManager -\\wxApp - -\wxApp +\\wxApp + +\wxApp \\OpenSQLManager\\OpenSQLManager->\\wxApp - - + + \\OpenSQLManager\\DB_Reg - -DB_Reg + +DB_Reg \\OpenSQLManager\\Settings - -Settings + +Settings \\OpenSQLManager\\Connection_Sidebar - -Connection_Sidebar + +Connection_Sidebar -\\wxPanel - -\wxPanel +\\wxPanel + +\wxPanel -\\OpenSQLManager\\Connection_Sidebar->\\wxPanel - - +\\OpenSQLManager\\Connection_Sidebar->\\wxPanel + + \\OpenSQLManager\\Data_Grid - -Data_Grid + +Data_Grid -\\wxGrid - -\wxGrid +\\wxGrid + +\wxGrid -\\OpenSQLManager\\Data_Grid->\\wxGrid - - +\\OpenSQLManager\\Data_Grid->\\wxGrid + + \\OpenSQLManager\\DB_tabs - -DB_tabs + +DB_tabs - -\\wxNotebook - -\wxNotebook + +\\wxAUINotebook + +\wxAUINotebook - -\\OpenSQLManager\\DB_tabs->\\wxNotebook - - + +\\OpenSQLManager\\DB_tabs->\\wxAUINotebook + + \\OpenSQLManager\\Connection_Manager - -Connection_Manager + +Connection_Manager -\\wxFrame - -\wxFrame +\\wxFrame + +\wxFrame -\\OpenSQLManager\\Connection_Manager->\\wxFrame - - +\\OpenSQLManager\\Connection_Manager->\\wxFrame + + \\OpenSQLManager\\Main - -Main + +Main -\\OpenSQLManager\\Main->\\wxFrame - - +\\OpenSQLManager\\Main->\\wxFrame + + + + +\\Query_Parser + + +Query_Parser + -\\DB_SQL +\\DB_SQL - -«abstract» -DB_SQL + +«abstract» +DB_SQL -\\DB_PDO +\\DB_PDO - -«abstract» -DB_PDO + +«abstract» +DB_PDO -\\PDO - -\PDO +\\PDO + +\PDO \\DB_PDO->\\PDO - - + + -\\Query_Builder +\\Query_Builder - -Query_Builder + +Query_Builder -\\DB_Util +\\DB_Util - -«abstract» -DB_Util + +«abstract» +DB_Util + +\\BadDBDriverException + + +BadDBDriverException + + + +\\InvalidArgumentException + +\InvalidArgumentException + + +\\BadDBDriverException->\\InvalidArgumentException + + + + +\\BadConnectionException + + +BadConnectionException + + + +\\UnexpectedValueException + +\UnexpectedValueException + + +\\BadConnectionException->\\UnexpectedValueException + + + -\\PgSQL_SQL +\\PgSQL_SQL - -PgSQL_SQL + +PgSQL_SQL -\\PgSQL_SQL->\\DB_SQL - - +\\PgSQL_SQL->\\DB_SQL + + -\\PgSQL_Util +\\PgSQL_Util - -PgSQL_Util + +PgSQL_Util -\\PgSQL_Util->\\DB_Util - - +\\PgSQL_Util->\\DB_Util + + -\\PgSQL +\\PgSQL - -PgSQL + +PgSQL -\\PgSQL->\\DB_PDO - - +\\PgSQL->\\DB_PDO + + -\\ODBC_Util +\\ODBC_Util - -ODBC_Util + +ODBC_Util -\\ODBC_Util->\\DB_Util - - +\\ODBC_Util->\\DB_Util + + -\\ODBC_SQL +\\ODBC_SQL - -ODBC_SQL + +ODBC_SQL -\\ODBC_SQL->\\DB_SQL - - +\\ODBC_SQL->\\DB_SQL + + -\\ODBC +\\ODBC - -ODBC + +ODBC -\\ODBC->\\DB_PDO - - +\\ODBC->\\DB_PDO + + -\\MySQL_Util +\\MySQL_Util - -MySQL_Util + +MySQL_Util -\\MySQL_Util->\\DB_Util - - +\\MySQL_Util->\\DB_Util + + -\\MySQL +\\MySQL - -MySQL + +MySQL -\\MySQL->\\DB_PDO - - +\\MySQL->\\DB_PDO + + -\\MySQL_SQL +\\MySQL_SQL - -MySQL_SQL + +MySQL_SQL -\\MySQL_SQL->\\DB_SQL - - +\\MySQL_SQL->\\DB_SQL + + -\\SQLite_Util +\\SQLite_Util - -SQLite_Util + +SQLite_Util -\\SQLite_Util->\\DB_Util - - +\\SQLite_Util->\\DB_Util + + -\\SQLite +\\SQLite - -SQLite + +SQLite -\\SQLite->\\DB_PDO - - +\\SQLite->\\DB_PDO + + -\\SQLite_SQL +\\SQLite_SQL - -SQLite_SQL + +SQLite_SQL -\\SQLite_SQL->\\DB_SQL - - +\\SQLite_SQL->\\DB_SQL + + -\\Firebird_SQL +\\Firebird_SQL - -Firebird_SQL + +Firebird_SQL -\\Firebird_SQL->\\DB_SQL - - +\\Firebird_SQL->\\DB_SQL + + -\\Firebird_Result +\\Firebird_Result - -Firebird_Result + +Firebird_Result -\\PDOStatement - -\PDOStatement +\\PDOStatement + +\PDOStatement -\\Firebird_Result->\\PDOStatement - - +\\Firebird_Result->\\PDOStatement + + -\\Firebird +\\Firebird - -Firebird + +Firebird -\\Firebird->\\DB_PDO - - +\\Firebird->\\DB_PDO + + -\\Firebird_Util +\\Firebird_Util - -Firebird_Util + +Firebird_Util -\\Firebird_Util->\\DB_Util - - +\\Firebird_Util->\\DB_Util + + diff --git a/docs/classes/BadConnectionException.html b/docs/classes/BadConnectionException.html new file mode 100644 index 0000000..00ee1a4 --- /dev/null +++ b/docs/classes/BadConnectionException.html @@ -0,0 +1,226 @@ + + + + + +OpenSQLManager » \BadConnectionException + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Generic exception for bad connection strings

+
+

+ + + + + + + + + +
packageQuery
subpackageQuery
+

+ Methods

+
+

__construct() +

+
__construct() 
+
+
+

+ + + +
inherited_fromException::__construct()
+
+
+
+

__toString() +

+
__toString() 
+
+
+

+ + + +
inherited_fromException::__toString()
+
+
+
+

getCode() +

+
getCode() 
+
+
+

+ + + +
inherited_fromException::getCode()
+
+
+
+

getFile() +

+
getFile() 
+
+
+

+ + + +
inherited_fromException::getFile()
+
+
+
+

getLine() +

+
getLine() 
+
+
+

+ + + +
inherited_fromException::getLine()
+
+
+
+

getMessage() +

+
getMessage() 
+
+
+

+ + + +
inherited_fromException::getMessage()
+
+
+
+

getPrevious() +

+
getPrevious() 
+
+
+

+ + + +
inherited_fromException::getPrevious()
+
+
+
+

getTrace() +

+
getTrace() 
+
+
+

+ + + +
inherited_fromException::getTrace()
+
+
+
+

getTraceAsString() +

+
getTraceAsString() 
+
+
+

+ + + +
inherited_fromException::getTraceAsString()
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/BadDBDriverException.html b/docs/classes/BadDBDriverException.html new file mode 100644 index 0000000..5ae28d6 --- /dev/null +++ b/docs/classes/BadDBDriverException.html @@ -0,0 +1,226 @@ + + + + + +OpenSQLManager » \BadDBDriverException + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Generic exception for bad drivers

+
+

+ + + + + + + + + +
packageQuery
subpackageQuery
+

+ Methods

+
+

__construct() +

+
__construct() 
+
+
+

+ + + +
inherited_fromException::__construct()
+
+
+
+

__toString() +

+
__toString() 
+
+
+

+ + + +
inherited_fromException::__toString()
+
+
+
+

getCode() +

+
getCode() 
+
+
+

+ + + +
inherited_fromException::getCode()
+
+
+
+

getFile() +

+
getFile() 
+
+
+

+ + + +
inherited_fromException::getFile()
+
+
+
+

getLine() +

+
getLine() 
+
+
+

+ + + +
inherited_fromException::getLine()
+
+
+
+

getMessage() +

+
getMessage() 
+
+
+

+ + + +
inherited_fromException::getMessage()
+
+
+
+

getPrevious() +

+
getPrevious() 
+
+
+

+ + + +
inherited_fromException::getPrevious()
+
+
+
+

getTrace() +

+
getTrace() 
+
+
+

+ + + +
inherited_fromException::getTrace()
+
+
+
+

getTraceAsString() +

+
getTraceAsString() 
+
+
+

+ + + +
inherited_fromException::getTraceAsString()
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/DB_PDO.html b/docs/classes/DB_PDO.html index a797bcc..5c89941 100644 --- a/docs/classes/DB_PDO.html +++ b/docs/classes/DB_PDO.html @@ -33,10 +33,10 @@ Reports
@@ -511,6 +515,10 @@ the connection/database

+ + + +
see\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110

Returns

int
@@ -608,6 +616,21 @@ the connection/database
string
+
+

Quote database table name, and set prefix

+
quote_table(string $table) : string
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
string
+
+

rollBack()

@@ -660,6 +683,21 @@ the connection/database
+
+

Sets the table prefix on the passed string

+
_prefix(string $str) : string
+
+
+

+

Parameters

+
+

$str

+string +
+

Returns

+
string
+
+

Helper method for quote_ident

_quote(mixed $str) : mixed
@@ -677,27 +715,39 @@ the connection/database

 Properties

+ 
+

$last_query

+
$last_query 
+
+

+
 
-

Reference to sql sub class

-
$sql : Object
+

$sql

+
$sql 
+
+

+
+ 
+

$table_prefix

+
$table_prefix 

 
-

Reference to util sub class

-
$util : Object
+

$util

+
$util 

 
-

Character to escape identifiers

-
$escape_char : string
+

$escape_char

+
$escape_char 

 
-

Reference to the last executed query

-
$statement : mixed
+

$statement

+
$statement 

@@ -708,7 +758,7 @@ the connection/database
+ generated on 2012-11-28T10:12:57-05:00.
diff --git a/docs/classes/DB_SQL.html b/docs/classes/DB_SQL.html index 94be339..eeb9603 100644 --- a/docs/classes/DB_SQL.html +++ b/docs/classes/DB_SQL.html @@ -33,10 +33,10 @@ Reports