From 13593cb848991fac95014d91792a171c5bd1d9ac Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Wed, 6 Jun 2012 16:47:57 -0400 Subject: [PATCH] Update docs --- docs/classes.svg | 372 +- docs/classes/DB_PDO.html | 714 +++ docs/classes/DB_SQL.html | 306 + docs/classes/DB_Util.html | 217 + docs/classes/Firebird.html | 876 +++ docs/classes/Firebird_Result.html | 512 ++ docs/classes/Firebird_SQL.html | 316 + docs/classes/Firebird_Util.html | 220 + docs/classes/MySQL.html | 912 +++ docs/classes/MySQL_SQL.html | 321 + docs/classes/MySQL_Util.html | 216 + docs/classes/ODBC.html | 914 +++ docs/classes/ODBC_SQL.html | 316 + docs/classes/ODBC_Util.html | 211 + .../OpenSQLManager.Connection_Manager.html | 7 +- .../OpenSQLManager.Connection_Sidebar.html | 7 +- docs/classes/OpenSQLManager.DB_Reg.html | 7 +- docs/classes/OpenSQLManager.DB_tabs.html | 7 +- docs/classes/OpenSQLManager.Data_Grid.html | 7 +- docs/classes/OpenSQLManager.Main.html | 7 +- .../OpenSQLManager.OpenSQLManager.html | 7 +- docs/classes/OpenSQLManager.Settings.html | 7 +- docs/classes/PgSQL.html | 914 +++ docs/classes/PgSQL_SQL.html | 316 + docs/classes/PgSQL_Util.html | 216 + docs/classes/Query_Builder.html | 1230 ++++ docs/classes/SQLite.html | 929 +++ docs/classes/SQLite_SQL.html | 316 + docs/classes/SQLite_Util.html | 216 + docs/deprecated.html | 7 +- docs/errors.html | 28 +- docs/graph_class.html | 7 +- docs/index.html | 13 +- docs/markers.html | 109 +- docs/namespaces/OpenSQLManager.html | 19 +- docs/namespaces/default.html | 290 + docs/packages/.html | 7 +- docs/packages/Default.html | 35 +- docs/packages/OpenSQLManager.Common.html | 7 +- docs/packages/OpenSQLManager.Widgets.html | 7 +- docs/packages/OpenSQLManager.Windows.html | 7 +- docs/packages/OpenSQLManager.html | 7 +- docs/packages/Query.Drivers.html | 219 + docs/packages/Query.Query.html | 123 + docs/packages/Query.html | 310 + docs/structure.xml | 5197 ++++++++++++++++- phpdoc.dist.xml | 4 +- 47 files changed, 16877 insertions(+), 135 deletions(-) create mode 100644 docs/classes/DB_PDO.html create mode 100644 docs/classes/DB_SQL.html create mode 100644 docs/classes/DB_Util.html create mode 100644 docs/classes/Firebird.html create mode 100644 docs/classes/Firebird_Result.html create mode 100644 docs/classes/Firebird_SQL.html create mode 100644 docs/classes/Firebird_Util.html create mode 100644 docs/classes/MySQL.html create mode 100644 docs/classes/MySQL_SQL.html create mode 100644 docs/classes/MySQL_Util.html create mode 100644 docs/classes/ODBC.html create mode 100644 docs/classes/ODBC_SQL.html create mode 100644 docs/classes/ODBC_Util.html create mode 100644 docs/classes/PgSQL.html create mode 100644 docs/classes/PgSQL_SQL.html create mode 100644 docs/classes/PgSQL_Util.html create mode 100644 docs/classes/Query_Builder.html create mode 100644 docs/classes/SQLite.html create mode 100644 docs/classes/SQLite_SQL.html create mode 100644 docs/classes/SQLite_Util.html create mode 100644 docs/namespaces/default.html create mode 100644 docs/packages/Query.Drivers.html create mode 100644 docs/packages/Query.Query.html create mode 100644 docs/packages/Query.html diff --git a/docs/classes.svg b/docs/classes.svg index e57f0a7..5bce772 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -4,132 +4,380 @@ - - + + G - + cluster_OpenSQLManager - - - - - - - - -OpenSQLManager + + + + + + + + +OpenSQLManager + +cluster_default + + + + + + + + \\OpenSQLManager\\OpenSQLManager - -OpenSQLManager + +OpenSQLManager -\\wxApp - -\wxApp +\\wxApp + +\wxApp -\\OpenSQLManager\\OpenSQLManager->\\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 +\\wxNotebook + +\wxNotebook -\\OpenSQLManager\\DB_tabs->\\wxNotebook - - +\\OpenSQLManager\\DB_tabs->\\wxNotebook + + \\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 + + + + +\\DB_SQL + + +«abstract» +DB_SQL + + + +\\DB_PDO + + +«abstract» +DB_PDO + + + +\\PDO + +\PDO + + +\\DB_PDO->\\PDO + + + + +\\Query_Builder + + +Query_Builder + + + +\\DB_Util + + +«abstract» +DB_Util + + + +\\PgSQL_SQL + + +PgSQL_SQL + + + +\\PgSQL_SQL->\\DB_SQL + + + + +\\PgSQL_Util + + +PgSQL_Util + + + +\\PgSQL_Util->\\DB_Util + + + + +\\PgSQL + + +PgSQL + + + +\\PgSQL->\\DB_PDO + + + + +\\ODBC_Util + + +ODBC_Util + + + +\\ODBC_Util->\\DB_Util + + + + +\\ODBC_SQL + + +ODBC_SQL + + + +\\ODBC_SQL->\\DB_SQL + + + + +\\ODBC + + +ODBC + + + +\\ODBC->\\DB_PDO + + + + +\\MySQL_Util + + +MySQL_Util + + + +\\MySQL_Util->\\DB_Util + + + + +\\MySQL + + +MySQL + + + +\\MySQL->\\DB_PDO + + + + +\\MySQL_SQL + + +MySQL_SQL + + + +\\MySQL_SQL->\\DB_SQL + + + + +\\SQLite_Util + + +SQLite_Util + + + +\\SQLite_Util->\\DB_Util + + + + +\\SQLite + + +SQLite + + + +\\SQLite->\\DB_PDO + + + + +\\SQLite_SQL + + +SQLite_SQL + + + +\\SQLite_SQL->\\DB_SQL + + + + +\\Firebird_SQL + + +Firebird_SQL + + + +\\Firebird_SQL->\\DB_SQL + + + + +\\Firebird_Result + + +Firebird_Result + + + +\\PDOStatement + +\PDOStatement + + +\\Firebird_Result->\\PDOStatement + + + + +\\Firebird + + +Firebird + + + +\\Firebird->\\DB_PDO + + + + +\\Firebird_Util + + +Firebird_Util + + + +\\Firebird_Util->\\DB_Util + + diff --git a/docs/classes/DB_PDO.html b/docs/classes/DB_PDO.html new file mode 100644 index 0000000..a797bcc --- /dev/null +++ b/docs/classes/DB_PDO.html @@ -0,0 +1,714 @@ + + + + + +OpenSQLManager » \DB_PDO + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Base Database class

+
+

Extends PDO to simplify cross-database issues

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

+ Methods

+
+

PDO constructor wrapper

+
__construct(string $dsn, string $username, string $password, array $driver_options) 
+
+
+

+

Parameters

+
+

$dsn

+string +
+
+

$username

+string +
+
+

$password

+string +
+
+

$driver_options

+array +
+
+
+
+

__sleep() +

+
__sleep() 
+
+
+

+ + + +
inherited_fromPDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
+
+

+ + + +
inherited_fromPDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
+
+

+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

beginTransaction() +

+
beginTransaction() 
+
+
+

+ + + +
inherited_fromPDO::beginTransaction()
+
+
+
+

commit() +

+
commit() 
+
+
+

+ + + +
inherited_fromPDO::commit()
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

errorCode() +

+
errorCode() 
+
+
+

+ + + +
inherited_fromPDO::errorCode()
+
+
+
+

errorInfo() +

+
errorInfo() 
+
+
+

+ + + +
inherited_fromPDO::errorInfo()
+
+
+
+

exec() +

+
exec() 
+
+
+

+ + + +
inherited_fromPDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
+
+

+ + + +
inherited_fromPDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
+
+

+ + + +
inherited_fromPDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
+
+

+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
+
+

+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
+
+

+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
+
+

+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
+
+

+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
+
+

+ + + +
inherited_fromPDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
+
+

+ + + +
inherited_fromPDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
+
+

+

Returns

+
int
+
+
+
+

prepare() +

+
prepare() 
+
+
+

+ + + +
inherited_fromPDO::prepare()
+
+
+
+

Create and execute a prepared statement with the provided parameters

+
prepare_execute(string $sql, array $params) : \PDOStatement
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
\PDOStatement
+
+
+
+

Simplifies prepared statements for database queries

+
prepare_query(string $sql, array $data) : mixed
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$data

+array +
+

Returns

+
+mixedPDOStatement / FALSE
+
+
+
+

query() +

+
query() 
+
+
+

+ + + +
inherited_fromPDO::query()
+
+
+
+

quote() +

+
quote() 
+
+
+

+ + + +
inherited_fromPDO::quote()
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
+
+

+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

rollBack() +

+
rollBack() 
+
+
+

+ + + +
inherited_fromPDO::rollBack()
+
+
+
+

setAttribute() +

+
setAttribute() 
+
+
+

+ + + +
inherited_fromPDO::setAttribute()
+
+
+
+

Connect to a different database

+
switch_db(string $name) : void
+
+
+

+

Parameters

+
+

$name

+string +
+
+
+
+

Empty the passed table

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
+
+

+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
+

+
+ 
+

Reference to util sub class

+
$util : Object
+
+

+
+ 
+

Character to escape identifiers

+
$escape_char : string
+
+

+
+ 
+

Reference to the last executed query

+
$statement : mixed
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/DB_SQL.html b/docs/classes/DB_SQL.html new file mode 100644 index 0000000..94be339 --- /dev/null +++ b/docs/classes/DB_SQL.html @@ -0,0 +1,306 @@ + + + + + +OpenSQLManager » \DB_SQL + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Abstract parent for database manipulation subclasses

+
+

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

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get information about the columns in the +specified table

+
column_list($table) : string
+
+
+

+

Parameters

+
+

$table

+

string

+

Returns

+
string
+
+
+
+

Returns sql to list other databases

+
db_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get database specific sql for limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+ + + +
abstract
+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the sql for random ordering

+
random() : string
+
+
+

+ + + +
abstract
+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list system tables

+
system_table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list tables

+
table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list triggers

+
trigger_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list database field types

+
type_list() : mixed
+
+
+

+

Returns

+
mixed
+
+
+
+

Returns sql to list views

+
view_list() : string
+
+
+

+

Returns

+
string
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/DB_Util.html b/docs/classes/DB_Util.html new file mode 100644 index 0000000..9c511a9 --- /dev/null +++ b/docs/classes/DB_Util.html @@ -0,0 +1,217 @@ + + + + + +OpenSQLManager » \DB_Util + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Abstract class defining database / table creation methods

+
+

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

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
+
+

+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the connection object for later use

+
__construct(object $conn) 
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Return an SQL file with the database data as insert statements

+
backup_data() : string
+
+
+

+ + + +
abstract
+

Returns

+
string
+
+
+
+

Return an SQL file with the database table structure

+
backup_structure() : string
+
+
+

+ + + +
abstract
+

Returns

+
string
+
+
+
+

Get database-specific sql to create a new table

+
create_table(string $name, array $columns, array $constraints, array $indexes) : string
+
+
+

+ + + +
abstract
+

Parameters

+
+

$name

+string +
+
+

$columns

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Get database-specific sql to drop a table

+
delete_table(string $name) : string
+
+
+

+ + + +
abstract
+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Firebird.html b/docs/classes/Firebird.html new file mode 100644 index 0000000..cd6efb8 --- /dev/null +++ b/docs/classes/Firebird.html @@ -0,0 +1,876 @@ + + + + + +OpenSQLManager » \Firebird + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Firebird Database class

+
+

PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Open the link to the database

+
__construct(string $dbpath, string $user, string $pass) 
+
+
+

+

Parameters

+
+

$dbpath

+string +
+
+

$user

+string +
+
+

$pass

+string +
+
+
+
+

__sleep() +

+
__sleep() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__sleep()
inherited_from\DB_PDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__wakeup()
inherited_from\DB_PDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::affected_rows()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

Start a database transaction

+
beginTransaction() : bool
+
+
+

+

Returns

+
bool
+
+
+
+

Commit a database transaction

+
commit() : bool
+
+
+

+

Returns

+
bool
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::driver_query()
+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::empty_table()
+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

Method to emulate PDO->errorCode

+
errorCode() : array
+
+
+

+

Returns

+
array
+
+
+
+

Method to emulate PDO->errorInfo / PDOStatement->errorInfo

+
errorInfo() : array
+
+
+

+

Returns

+
array
+
+
+
+

exec() +

+
exec() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::exec()
inherited_from\DB_PDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAttribute()
inherited_from\DB_PDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAvailableDrivers()
inherited_from\DB_PDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_columns()
+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_dbs()
+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_functions()
+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_last_error()
+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_procedures()
+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_query_data()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_schemas()
+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_sequences()
+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_system_tables()
+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_tables()
+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_triggers()
+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_types()
+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_views()
+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::inTransaction()
inherited_from\DB_PDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::lastInsertId()
inherited_from\DB_PDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::num_rows()
+

Returns

+
int
+
+
+
+

Emulate PDO prepare

+
prepare(string $query, array $options) : \Firebird
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$query

+string +
+
+

$options

+array +
+

Returns

+
\Firebird
+
+
+
+

Prepare and execute a query

+
prepare_execute(string $sql, array $args) : resource
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$args

+array +
+

Returns

+
resource
+
+
+
+

Bind a prepared query with arguments for executing

+
prepare_query(string $sql, array $params) : FALSE
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
FALSE
+
+
+
+

Wrapper public function to better match PDO

+
query(string $sql) : \Firebird
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$sql

+string +
+

Returns

+
\Firebird
+
+
+
+

Method to emulate PDO->quote

+
quote(string $str, int $param_type) : string
+
+
+

+

Parameters

+
+

$str

+string +
+
+

$param_type

+int +
+

Returns

+
string
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::quote_ident()
+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

Rollback a transaction

+
rollBack() : bool
+
+
+

+

Returns

+
bool
+
+
+
+

setAttribute() +

+
setAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::setAttribute()
inherited_from\DB_PDO::setAttribute()
+
+
+
+

Doesn't apply to Firebird

+
switch_db(string $name) : FALSE
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
FALSE
+
+
+
+

Empty a database table

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::_quote()
+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$sql
+
+
+ 
+

Reference to util sub class

+
$util : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$util
+
+
+ 
+

Reference to the connection resource

+
$conn : resource
+
+

+
+ 
+

Character to escape identifiers

+
$escape_char : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$escape_char
+
+
+ 
+

Reference to the last query executed

+
$statement : object
+
+

+
+ 
+

Reference to the resource returned by +the last query executed

+
$statement_link : resource
+
+

+
+ 
+

Reference to the current transaction

+
$trans : resource
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Firebird_Result.html b/docs/classes/Firebird_Result.html new file mode 100644 index 0000000..0a652c5 --- /dev/null +++ b/docs/classes/Firebird_Result.html @@ -0,0 +1,512 @@ + + + + + +OpenSQLManager » \Firebird_Result + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Firebird result class to emulate PDOStatement Class - only implements +data-fetching methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Create the object by passing the resource for +the query

+
__construct(resource $link) 
+
+
+

+

Parameters

+
+

$link

+resource +
+
+
+
+

__sleep() +

+
__sleep() 
+
+
+

+ + + +
inherited_fromPDOStatement::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
+
+

+ + + +
inherited_fromPDOStatement::__wakeup()
+
+
+
+

Invalidate method for data consistency

+
bindColumn(mixed $column, mixed $param, int $type, mixed $maxlen, array $driverdata) : FALSE
+
+
+

+

Parameters

+
+

$column

+mixed +
+
+

$param

+mixed

&$param

+
+
+

$type

+int +
+
+

$maxlen

+mixed +
+
+

$driverdata

+array +
+

Returns

+
FALSE
+
+
+
+

Invalidate method for data consistency

+
bindParam(mixed $parameter, mixed $variable, int $data_type, mixed $maxlen, array $driverdata) : FALSE
+
+
+

+

Parameters

+
+

$parameter

+mixed +
+
+

$variable

+mixed

&$variable

+
+
+

$data_type

+int +
+
+

$maxlen

+mixed +
+
+

$driverdata

+array +
+

Returns

+
FALSE
+
+
+
+

Invalidate method for data consistency

+
bindValue(mixed $parameter, mixed $variable, int $data_type) : FALSE
+
+
+

+

Parameters

+
+

$parameter

+mixed +
+
+

$variable

+mixed

&$variable

+
+
+

$data_type

+int +
+

Returns

+
FALSE
+
+
+
+

closeCursor() +

+
closeCursor() 
+
+
+

+ + + +
inherited_fromPDOStatement::closeCursor()
+
+
+
+

columnCount() +

+
columnCount() 
+
+
+

+ + + +
inherited_fromPDOStatement::columnCount()
+
+
+
+

debugDumpParams() +

+
debugDumpParams() 
+
+
+

+ + + +
inherited_fromPDOStatement::debugDumpParams()
+
+
+
+

Method to emulate PDOStatement->errorCode

+
errorCode() : string
+
+
+

+

Returns

+
string
+
+
+
+

Method to emulate PDO->errorInfo / PDOStatement->errorInfo

+
errorInfo() : array
+
+
+

+

Returns

+
array
+
+
+
+

Run a prepared statement query

+
execute(array $args) : bool
+
+
+

+

Parameters

+
+

$args

+array +
+

Returns

+
bool
+
+
+
+

Emulate PDO fetch public function

+
fetch(int $fetch_style, mixed $statement, mixed $offset) : mixed
+
+
+

+

Parameters

+
+

$fetch_style

+int +
+
+

$statement

+mixed +
+
+

$offset

+mixed +
+

Returns

+
mixed
+
+
+
+

Emulate PDO fetchAll public function

+
fetchAll(int $fetch_style, mixed $statement, mixed $ctor_args) : mixed
+
+
+

+

Parameters

+
+

$fetch_style

+int +
+
+

$statement

+mixed +
+
+

$ctor_args

+mixed +
+

Returns

+
mixed
+
+
+
+

Emulate PDOStatement::fetchColumn

+
fetchColumn(int $column_num) : mixed
+
+
+

+

Parameters

+
+

$column_num

+int +
+

Returns

+
mixed
+
+
+
+

Emulate PDOStatement::fetchObject, but only for the default use

+
fetchObject(string $class_name, array $ctor_args) : \stdClass
+
+
+

+

Parameters

+
+

$class_name

+string +
+
+

$ctor_args

+array +
+

Returns

+
\stdClass
+
+
+
+

getAttribute() +

+
getAttribute() 
+
+
+

+ + + +
inherited_fromPDOStatement::getAttribute()
+
+
+
+

getColumnMeta() +

+
getColumnMeta() 
+
+
+

+ + + +
inherited_fromPDOStatement::getColumnMeta()
+
+
+
+

nextRowset() +

+
nextRowset() 
+
+
+

+ + + +
inherited_fromPDOStatement::nextRowset()
+
+
+
+

Return the number of rows affected by the previous query

+
rowCount() : int
+
+
+

+

Returns

+
int
+
+
+
+

setAttribute() +

+
setAttribute() 
+
+
+

+ + + +
inherited_fromPDOStatement::setAttribute()
+
+
+
+

setFetchMode() +

+
setFetchMode() 
+
+
+

+ + + +
inherited_fromPDOStatement::setFetchMode()
+
+
+

+ Properties

+ 
+

Data pulled from query

+
$result 
+
+
+

+ + + +
param<p>mixed</p>
+
+
+ 
+

Current row in result array

+
$row : int
+
+

+
+ 
+

Reference to fbird resource

+
$statement : resource
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Firebird_SQL.html b/docs/classes/Firebird_SQL.html new file mode 100644 index 0000000..543b937 --- /dev/null +++ b/docs/classes/Firebird_SQL.html @@ -0,0 +1,316 @@ + + + + + +OpenSQLManager » \Firebird_SQL + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Firebird Specific SQL

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::avg()
+

Returns

+
string
+
+
+
+

Return sql to list columns of the specified table

+
column_list(string $table) : string
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
string
+
+
+
+

Returns sql to list other databases

+
db_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::distinct()
+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::max()
+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::min()
+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Random ordering keyword

+
random() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::sum()
+

Returns

+
string
+
+
+
+

Returns sql to list system tables

+
system_table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list tables

+
table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list triggers

+
trigger_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

SQL to show list of field types

+
type_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list views

+
view_list() : string
+
+
+

+

Returns

+
string
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Firebird_Util.html b/docs/classes/Firebird_Util.html new file mode 100644 index 0000000..3f8198c --- /dev/null +++ b/docs/classes/Firebird_Util.html @@ -0,0 +1,220 @@ + + + + + +OpenSQLManager » \Firebird_Util + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Firebird-specific backup, import and creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::__call()
+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the current connection object

+
__construct(object $conn) : void
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Create an SQL backup file for the current database's data

+
backup_data(array $exclude, bool $system_tables) : string
+
+
+

+

Parameters

+
+

$exclude

+array +
+
+

$system_tables

+bool +
+

Returns

+
string
+
+
+
+

Create an SQL backup file for the current database's structure

+
backup_structure() : string
+
+
+

+

Returns

+
string
+
+
+
+

Convienience public function to generate sql for creating a db table

+
create_table(string $name, array $fields, array $constraints, array $indexes) : string
+
+
+

+

Parameters

+
+

$name

+string +
+
+

$fields

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Drop the selected table

+
delete_table(string $name) : string
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::$$conn
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/MySQL.html b/docs/classes/MySQL.html new file mode 100644 index 0000000..10113ba --- /dev/null +++ b/docs/classes/MySQL.html @@ -0,0 +1,912 @@ + + + + + +OpenSQLManager » \MySQL + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

MySQL specific class

+
+

Extends PDO to simplify cross-database issues

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Connect to MySQL Database

+
__construct(string $dsn, string $username, string $password, array $options) 
+
+
+

+

Parameters

+
+

$dsn

+string +
+
+

$username

+string +
+
+

$password

+string +
+
+

$options

+array +
+
+
+
+

__sleep() +

+
__sleep() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__sleep()
inherited_from\DB_PDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__wakeup()
inherited_from\DB_PDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::affected_rows()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

beginTransaction() +

+
beginTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::beginTransaction()
inherited_from\DB_PDO::beginTransaction()
+
+
+
+

commit() +

+
commit() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::commit()
inherited_from\DB_PDO::commit()
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::driver_query()
+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::empty_table()
+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

errorCode() +

+
errorCode() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorCode()
inherited_from\DB_PDO::errorCode()
+
+
+
+

errorInfo() +

+
errorInfo() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorInfo()
inherited_from\DB_PDO::errorInfo()
+
+
+
+

exec() +

+
exec() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::exec()
inherited_from\DB_PDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAttribute()
inherited_from\DB_PDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAvailableDrivers()
inherited_from\DB_PDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_columns()
+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_dbs()
+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_functions()
+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_last_error()
+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_procedures()
+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_query_data()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_schemas()
+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_sequences()
+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_system_tables()
+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_tables()
+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_triggers()
+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_types()
+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_views()
+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::inTransaction()
inherited_from\DB_PDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::lastInsertId()
inherited_from\DB_PDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::num_rows()
+

Returns

+
int
+
+
+
+

prepare() +

+
prepare() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::prepare()
inherited_from\DB_PDO::prepare()
+
+
+
+

Create and execute a prepared statement with the provided parameters

+
prepare_execute(string $sql, array $params) : \PDOStatement
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_execute()
+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
\PDOStatement
+
+
+
+

Simplifies prepared statements for database queries

+
prepare_query(string $sql, array $data) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_query()
+

Parameters

+
+

$sql

+string +
+
+

$data

+array +
+

Returns

+
+mixedPDOStatement / FALSE
+
+
+
+

query() +

+
query() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::query()
inherited_from\DB_PDO::query()
+
+
+
+

quote() +

+
quote() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::quote()
inherited_from\DB_PDO::quote()
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::quote_ident()
+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

rollBack() +

+
rollBack() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::rollBack()
inherited_from\DB_PDO::rollBack()
+
+
+
+

setAttribute() +

+
setAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::setAttribute()
inherited_from\DB_PDO::setAttribute()
+
+
+
+

Connect to a different database

+
switch_db(string $name) : void
+
+
+

+

Parameters

+
+

$name

+string +
+
+
+
+

Empty a table

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::_quote()
+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$sql
+
+
+ 
+

Reference to util sub class

+
$util : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$util
+
+
+ 
+

Set the backtick as the MySQL escape character

+
$escape_char : string
+
+

+
+ 
+

Reference to the last executed query

+
$statement : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$statement
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/MySQL_SQL.html b/docs/classes/MySQL_SQL.html new file mode 100644 index 0000000..0ae1805 --- /dev/null +++ b/docs/classes/MySQL_SQL.html @@ -0,0 +1,321 @@ + + + + + +OpenSQLManager » \MySQL_SQL + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

MySQL specifc SQL

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::avg()
+

Returns

+
string
+
+
+
+

SQL to show infromation about columns in a table

+
column_list(string $table) : string
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
string
+
+
+
+

Returns sql to list other databases

+
db_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::distinct()
+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::max()
+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::min()
+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Random ordering keyword

+
random() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::sum()
+

Returns

+
string
+
+
+
+

Overridden in MySQL class

+
system_table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list tables

+
table_list(string $database) : string
+
+
+

+

Parameters

+
+

$database

+string +
+

Returns

+
string
+
+
+
+

Returns sql to list triggers

+
trigger_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

SQL to show list of field types

+
type_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list views

+
view_list() : string
+
+
+

+

Returns

+
string
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/MySQL_Util.html b/docs/classes/MySQL_Util.html new file mode 100644 index 0000000..b3dbb00 --- /dev/null +++ b/docs/classes/MySQL_Util.html @@ -0,0 +1,216 @@ + + + + + +OpenSQLManager » \MySQL_Util + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

MySQL-specific backup, import and creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::__call()
+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the current connection object

+
__construct(object $conn) : void
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Create an SQL backup file for the current database's data

+
backup_data(array $exclude) : string
+
+
+

+

Parameters

+
+

$exclude

+array +
+

Returns

+
string
+
+
+
+

Create an SQL backup file for the current database's structure

+
backup_structure() : string
+
+
+

+

Returns

+
string
+
+
+
+

Convienience public function for creating a new MySQL table

+
create_table(string $name, array $columns, array $constraints, array $indexes) : string
+
+
+

+

Parameters

+
+

$name

+string +
+
+

$columns

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Convience public function for droping a table

+
delete_table(string $name) : string
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::$$conn
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/ODBC.html b/docs/classes/ODBC.html new file mode 100644 index 0000000..54c70f4 --- /dev/null +++ b/docs/classes/ODBC.html @@ -0,0 +1,914 @@ + + + + + +OpenSQLManager » \ODBC + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

ODBC Database Driver

+
+

For general database access for databases not specified by the main drivers

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Use ODBC to connect to a database

+
__construct(string $dsn, string $username, string $password, array $options) 
+
+
+

+

Parameters

+
+

$dsn

+string +
+
+

$username

+string +
+
+

$password

+string +
+
+

$options

+array +
+
+
+
+

__sleep() +

+
__sleep() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__sleep()
inherited_from\DB_PDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__wakeup()
inherited_from\DB_PDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::affected_rows()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

beginTransaction() +

+
beginTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::beginTransaction()
inherited_from\DB_PDO::beginTransaction()
+
+
+
+

commit() +

+
commit() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::commit()
inherited_from\DB_PDO::commit()
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::driver_query()
+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::empty_table()
+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

errorCode() +

+
errorCode() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorCode()
inherited_from\DB_PDO::errorCode()
+
+
+
+

errorInfo() +

+
errorInfo() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorInfo()
inherited_from\DB_PDO::errorInfo()
+
+
+
+

exec() +

+
exec() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::exec()
inherited_from\DB_PDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAttribute()
inherited_from\DB_PDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAvailableDrivers()
inherited_from\DB_PDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_columns()
+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_dbs()
+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_functions()
+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_last_error()
+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_procedures()
+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_query_data()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_schemas()
+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_sequences()
+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_system_tables()
+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_tables()
+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_triggers()
+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_types()
+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_views()
+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::inTransaction()
inherited_from\DB_PDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::lastInsertId()
inherited_from\DB_PDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::num_rows()
+

Returns

+
int
+
+
+
+

prepare() +

+
prepare() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::prepare()
inherited_from\DB_PDO::prepare()
+
+
+
+

Create and execute a prepared statement with the provided parameters

+
prepare_execute(string $sql, array $params) : \PDOStatement
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_execute()
+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
\PDOStatement
+
+
+
+

Simplifies prepared statements for database queries

+
prepare_query(string $sql, array $data) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_query()
+

Parameters

+
+

$sql

+string +
+
+

$data

+array +
+

Returns

+
+mixedPDOStatement / FALSE
+
+
+
+

query() +

+
query() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::query()
inherited_from\DB_PDO::query()
+
+
+
+

quote() +

+
quote() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::quote()
inherited_from\DB_PDO::quote()
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::quote_ident()
+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

rollBack() +

+
rollBack() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::rollBack()
inherited_from\DB_PDO::rollBack()
+
+
+
+

setAttribute() +

+
setAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::setAttribute()
inherited_from\DB_PDO::setAttribute()
+
+
+
+

Doesn't apply to ODBC

+
switch_db(string $name) : bool
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
bool
+
+
+
+

Empty the current database

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::_quote()
+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$sql
+
+
+ 
+

Reference to util sub class

+
$util : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$util
+
+
+ 
+

Don't define the escape char - or define it in sub-drivers in a refactor

+
$escape_char : string
+
+

+
+ 
+

Reference to the last executed query

+
$statement : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$statement
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/ODBC_SQL.html b/docs/classes/ODBC_SQL.html new file mode 100644 index 0000000..cfada6a --- /dev/null +++ b/docs/classes/ODBC_SQL.html @@ -0,0 +1,316 @@ + + + + + +OpenSQLManager » \ODBC_SQL + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

ODBC SQL Class

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::avg()
+

Returns

+
string
+
+
+
+

SQL to show infromation about columns in a table

+
column_list(string $table) : FALSE
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
FALSE
+
+
+
+

Returns sql to list other databases

+
db_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::distinct()
+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::max()
+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::min()
+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Random ordering keyword

+
random() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::sum()
+

Returns

+
string
+
+
+
+

Returns sql to list system tables

+
system_table_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Returns sql to list tables

+
table_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Returns sql to list triggers

+
trigger_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

SQL to show list of field types

+
type_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Returns sql to list views

+
view_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/ODBC_Util.html b/docs/classes/ODBC_Util.html new file mode 100644 index 0000000..086a788 --- /dev/null +++ b/docs/classes/ODBC_Util.html @@ -0,0 +1,211 @@ + + + + + +OpenSQLManager » \ODBC_Util + + + + + + + + + +
+
+OpenSQLManager
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

ODBC-specific backup, import and creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::__call()
+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the current connection object

+
__construct(object $conn) : void
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Create an SQL backup file for the current database's data

+
backup_data() : string
+
+
+

+

Returns

+
string
+
+
+
+

Create an SQL backup file for the current database's structure

+
backup_structure() : string
+
+
+

+

Returns

+
string
+
+
+
+

Database-specific method to create a new table

+
create_table(string $name, array $columns, array $constraints, array $indexes) : string
+
+
+

+

Parameters

+
+

$name

+string +
+
+

$columns

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Remove a table from the database

+
delete_table(string $name) : string
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::$$conn
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/OpenSQLManager.Connection_Manager.html b/docs/classes/OpenSQLManager.Connection_Manager.html index 70f4d38..bc82357 100644 --- a/docs/classes/OpenSQLManager.Connection_Manager.html +++ b/docs/classes/OpenSQLManager.Connection_Manager.html @@ -22,6 +22,7 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • +
  •  Query
  •  Errors  0
  •  Markers  -
      • +
    •  Deprecated elements  0
      • @@ -292,7 +295,7 @@
      + generated on 2012-06-06T16:47:37-04:00.
      diff --git a/docs/classes/OpenSQLManager.Connection_Sidebar.html b/docs/classes/OpenSQLManager.Connection_Sidebar.html index 78423d3..82fadd7 100644 --- a/docs/classes/OpenSQLManager.Connection_Sidebar.html +++ b/docs/classes/OpenSQLManager.Connection_Sidebar.html @@ -22,6 +22,7 @@
    • Packages
    •  Default
    •  OpenSQLManager
      • +
    •  Query
    •  Errors  0
    •  Markers  -
        • +
      •  Deprecated elements  0
        • @@ -246,7 +249,7 @@
        + generated on 2012-06-06T16:47:37-04:00.
        diff --git a/docs/classes/OpenSQLManager.DB_Reg.html b/docs/classes/OpenSQLManager.DB_Reg.html index 7ee64dc..d79fe96 100644 --- a/docs/classes/OpenSQLManager.DB_Reg.html +++ b/docs/classes/OpenSQLManager.DB_Reg.html @@ -22,6 +22,7 @@
      • Packages
      •  Default
      •  OpenSQLManager
        • +
      •  Query
      •  Errors  0
      •  Markers  -
          • +
        •  Deprecated elements  0
          • @@ -160,7 +163,7 @@ and organizes database connections

          + generated on 2012-06-06T16:47:37-04:00.
          diff --git a/docs/classes/OpenSQLManager.DB_tabs.html b/docs/classes/OpenSQLManager.DB_tabs.html index 7ff3c16..62bca03 100644 --- a/docs/classes/OpenSQLManager.DB_tabs.html +++ b/docs/classes/OpenSQLManager.DB_tabs.html @@ -22,6 +22,7 @@
        • Packages
        •  Default
        •  OpenSQLManager
          • +
        •  Query
        •  Errors  0
        •  Markers  -
            • +
          •  Deprecated elements  0
            • @@ -146,7 +149,7 @@
            + generated on 2012-06-06T16:47:37-04:00.
            diff --git a/docs/classes/OpenSQLManager.Data_Grid.html b/docs/classes/OpenSQLManager.Data_Grid.html index 3ab4f90..b84d04e 100644 --- a/docs/classes/OpenSQLManager.Data_Grid.html +++ b/docs/classes/OpenSQLManager.Data_Grid.html @@ -22,6 +22,7 @@
          • Packages
          •  Default
          •  OpenSQLManager
            • +
          •  Query
          •  Errors  0
          •  Markers  -
              • +
            •  Deprecated elements  0
              • @@ -104,7 +107,7 @@
              + generated on 2012-06-06T16:47:37-04:00.
              diff --git a/docs/classes/OpenSQLManager.Main.html b/docs/classes/OpenSQLManager.Main.html index 431a81b..5209550 100644 --- a/docs/classes/OpenSQLManager.Main.html +++ b/docs/classes/OpenSQLManager.Main.html @@ -22,6 +22,7 @@
            • Packages
            •  Default
            •  OpenSQLManager
              • +
            •  Query
            •  Errors  0
            •  Markers  -
                • +
              •  Deprecated elements  0
                • @@ -164,7 +167,7 @@ Create menus, hboxes, vboxs and other widgets
                + generated on 2012-06-06T16:47:37-04:00.
                diff --git a/docs/classes/OpenSQLManager.OpenSQLManager.html b/docs/classes/OpenSQLManager.OpenSQLManager.html index 831e86b..85d6e06 100644 --- a/docs/classes/OpenSQLManager.OpenSQLManager.html +++ b/docs/classes/OpenSQLManager.OpenSQLManager.html @@ -22,6 +22,7 @@
              • Packages
              •  Default
              •  OpenSQLManager
                • +
              •  Query
              •  Errors  0
              •  Markers  -
                  • +
                •  Deprecated elements  0
                  • @@ -107,7 +110,7 @@
                  + generated on 2012-06-06T16:47:37-04:00.
                  diff --git a/docs/classes/OpenSQLManager.Settings.html b/docs/classes/OpenSQLManager.Settings.html index 116eae2..25cc8bd 100644 --- a/docs/classes/OpenSQLManager.Settings.html +++ b/docs/classes/OpenSQLManager.Settings.html @@ -22,6 +22,7 @@
                • Packages
                •  Default
                •  OpenSQLManager
                  • +
                •  Query
                •  Errors  0
                •  Markers  -
                    • +
                  •  Deprecated elements  0
                    • @@ -252,7 +255,7 @@ directly - the settings should be safe!
                    + generated on 2012-06-06T16:47:37-04:00.
                    diff --git a/docs/classes/PgSQL.html b/docs/classes/PgSQL.html new file mode 100644 index 0000000..d52efe6 --- /dev/null +++ b/docs/classes/PgSQL.html @@ -0,0 +1,914 @@ + + + + + +OpenSQLManager » \PgSQL + + + + + + + + + +
                    +
                    +OpenSQLManager
                    +
                    +
                    Back to top  
                    +
                    +
                    + +
                    +
                    +
                    + +
                    + +
                    +
                    +
                    +

                    PostgreSQL specifc class

                    +
                    +

                    Extends PDO to simplify cross-database issues

                    + + + + + + + + + +
                    packageQuery
                    subpackageDrivers
                    +

                    + Methods

                    +
                    +

                    Connect to a PosgreSQL database

                    +
                    __construct(string $dsn, string $username, string $password, array $options) 
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $dsn

                    +string +
                    +
                    +

                    $username

                    +string +
                    +
                    +

                    $password

                    +string +
                    +
                    +

                    $options

                    +array +
                    +
                    +
                    +
                    +

                    __sleep() +

                    +
                    __sleep() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::__sleep()
                    inherited_from\DB_PDO::__sleep()
                    +
                    +
                    +
                    +

                    __wakeup() +

                    +
                    __wakeup() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::__wakeup()
                    inherited_from\DB_PDO::__wakeup()
                    +
                    +
                    +
                    +

                    Returns number of rows affected by an INSERT, UPDATE, DELETE type query

                    +
                    affected_rows(\PDOStatement $statement) : int
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::affected_rows()
                    +

                    Parameters

                    +
                    +

                    $statement

                    +\PDOStatement +
                    +

                    Returns

                    +
                    int
                    +
                    +
                    +
                    +

                    beginTransaction() +

                    +
                    beginTransaction() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::beginTransaction()
                    inherited_from\DB_PDO::beginTransaction()
                    +
                    +
                    +
                    +

                    commit() +

                    +
                    commit() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::commit()
                    inherited_from\DB_PDO::commit()
                    +
                    +
                    +
                    +

                    Method to simplify retreiving db results for meta-data queries

                    +
                    driver_query(string $sql, bool $filtered_index) : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::driver_query()
                    +

                    Parameters

                    +
                    +

                    $sql

                    +string +
                    +
                    +

                    $filtered_index

                    +bool +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

                    +
                    empty_table(string $table) : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::empty_table()
                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    errorCode() +

                    +
                    errorCode() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::errorCode()
                    inherited_from\DB_PDO::errorCode()
                    +
                    +
                    +
                    +

                    errorInfo() +

                    +
                    errorInfo() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::errorInfo()
                    inherited_from\DB_PDO::errorInfo()
                    +
                    +
                    +
                    +

                    exec() +

                    +
                    exec() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::exec()
                    inherited_from\DB_PDO::exec()
                    +
                    +
                    +
                    +

                    getAttribute() +

                    +
                    getAttribute() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::getAttribute()
                    inherited_from\DB_PDO::getAttribute()
                    +
                    +
                    +
                    +

                    getAvailableDrivers() +

                    +
                    getAvailableDrivers() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::getAvailableDrivers()
                    inherited_from\DB_PDO::getAvailableDrivers()
                    +
                    +
                    +
                    +

                    Retrieve column information for the current database table

                    +
                    get_columns(string $table) : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_columns()
                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of dbs for the current connection, if possible

                    +
                    get_dbs() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_dbs()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of function for the current database

                    +
                    get_functions() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_functions()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return the last error for the current database connection

                    +
                    get_last_error() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_last_error()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return list of stored procedures for the current database

                    +
                    get_procedures() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_procedures()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Retreives the data from a select query

                    +
                    get_query_data(\PDOStatement $statement) : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_query_data()
                    +

                    Parameters

                    +
                    +

                    $statement

                    +\PDOStatement +
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Get a list of schemas for the current connection

                    +
                    get_schemas() : array
                    +
                    +
                    +

                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of sequences for the current database, if they exist

                    +
                    get_sequences() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_sequences()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Retreives an array of non-user-created tables for +the connection/database

                    +
                    get_system_tables() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_system_tables()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of tables for the current database

                    +
                    get_tables() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_tables()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of triggers for the current database

                    +
                    get_triggers() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_triggers()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Retrieve list of data types for the database

                    +
                    get_types() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_types()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of views for the current database

                    +
                    get_views() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_views()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    inTransaction() +

                    +
                    inTransaction() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::inTransaction()
                    inherited_from\DB_PDO::inTransaction()
                    +
                    +
                    +
                    +

                    lastInsertId() +

                    +
                    lastInsertId() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::lastInsertId()
                    inherited_from\DB_PDO::lastInsertId()
                    +
                    +
                    +
                    +

                    Return the number of rows returned for a SELECT query

                    +
                    num_rows() : int
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::num_rows()
                    +

                    Returns

                    +
                    int
                    +
                    +
                    +
                    +

                    prepare() +

                    +
                    prepare() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::prepare()
                    inherited_from\DB_PDO::prepare()
                    +
                    +
                    +
                    +

                    Create and execute a prepared statement with the provided parameters

                    +
                    prepare_execute(string $sql, array $params) : \PDOStatement
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::prepare_execute()
                    +

                    Parameters

                    +
                    +

                    $sql

                    +string +
                    +
                    +

                    $params

                    +array +
                    +

                    Returns

                    +
                    \PDOStatement
                    +
                    +
                    +
                    +

                    Simplifies prepared statements for database queries

                    +
                    prepare_query(string $sql, array $data) : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::prepare_query()
                    +

                    Parameters

                    +
                    +

                    $sql

                    +string +
                    +
                    +

                    $data

                    +array +
                    +

                    Returns

                    +
                    +mixedPDOStatement / FALSE
                    +
                    +
                    +
                    +

                    query() +

                    +
                    query() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::query()
                    inherited_from\DB_PDO::query()
                    +
                    +
                    +
                    +

                    quote() +

                    +
                    quote() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::quote()
                    inherited_from\DB_PDO::quote()
                    +
                    +
                    +
                    +

                    Surrounds the string with the databases identifier escape characters

                    +
                    quote_ident(mixed $ident) : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::quote_ident()
                    +

                    Parameters

                    +
                    +

                    $ident

                    +mixed +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    rollBack() +

                    +
                    rollBack() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::rollBack()
                    inherited_from\DB_PDO::rollBack()
                    +
                    +
                    +
                    +

                    setAttribute() +

                    +
                    setAttribute() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::setAttribute()
                    inherited_from\DB_PDO::setAttribute()
                    +
                    +
                    +
                    +

                    Connect to a different database

                    +
                    switch_db(string $name) : void
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $name

                    +string +
                    +
                    +
                    +
                    +

                    Empty a table

                    +
                    truncate(string $table) : void
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +
                    +
                    +
                    +

                    Helper method for quote_ident

                    +
                    _quote(mixed $str) : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::_quote()
                    +

                    Parameters

                    +
                    +

                    $str

                    +mixed +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +

                    + Properties

                    + 
                    +

                    Reference to sql sub class

                    +
                    $sql : Object
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::$$sql
                    +
                    +
                    + 
                    +

                    Reference to util sub class

                    +
                    $util : Object
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::$$util
                    +
                    +
                    + 
                    +

                    Character to escape identifiers

                    +
                    $escape_char : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::$$escape_char
                    +
                    +
                    + 
                    +

                    Reference to the last executed query

                    +
                    $statement : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::$$statement
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    + + diff --git a/docs/classes/PgSQL_SQL.html b/docs/classes/PgSQL_SQL.html new file mode 100644 index 0000000..6a12591 --- /dev/null +++ b/docs/classes/PgSQL_SQL.html @@ -0,0 +1,316 @@ + + + + + +OpenSQLManager » \PgSQL_SQL + + + + + + + + + +
                    +
                    +OpenSQLManager
                    +
                    +
                    Back to top  
                    +
                    +
                    + +
                    +
                    +
                    + +
                    + +
                    +
                    +
                    +

                    PostgreSQL specifc SQL

                    +
                    +

                    + + + + + + + + + +
                    packageQuery
                    subpackageDrivers
                    +

                    + Methods

                    +
                    +

                    Get the 'average' keyword

                    +
                    avg() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::avg()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return sql to list columns of the specified table

                    +
                    column_list(string $table) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Returns sql to list other databases

                    +
                    db_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Get the 'distinct' keyword

                    +
                    distinct() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::distinct()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return sql to list functions

                    +
                    function_list() : FALSE
                    +
                    +
                    +

                    +

                    Returns

                    +
                    FALSE
                    +
                    +
                    +
                    +

                    Limit clause

                    +
                    limit(string $sql, int $limit, int $offset) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $sql

                    +string +
                    +
                    +

                    $limit

                    +int +
                    +
                    +

                    $offset

                    +int +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Get the max keyword sql

                    +
                    max() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::max()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Get the min keyword sql

                    +
                    min() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::min()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return sql to list stored procedures

                    +
                    procedure_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Random ordering keyword

                    +
                    random() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return sql to list sequences

                    +
                    sequence_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Get the 'sum' keyword

                    +
                    sum() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::sum()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Returns sql to list system tables

                    +
                    system_table_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Returns sql to list tables

                    +
                    table_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Returns sql to list triggers

                    +
                    trigger_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    SQL to show list of field types

                    +
                    type_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Returns sql to list views

                    +
                    view_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    + + diff --git a/docs/classes/PgSQL_Util.html b/docs/classes/PgSQL_Util.html new file mode 100644 index 0000000..d3fc4cd --- /dev/null +++ b/docs/classes/PgSQL_Util.html @@ -0,0 +1,216 @@ + + + + + +OpenSQLManager » \PgSQL_Util + + + + + + + + + +
                    +
                    +OpenSQLManager
                    +
                    +
                    Back to top  
                    +
                    +
                    + +
                    +
                    +
                    + +
                    + +
                    +
                    +
                    +

                    Posgres-specific backup, import and creation methods

                    +
                    +

                    + + + + + + + + + +
                    packageQuery
                    subpackageDrivers
                    +

                    + Methods

                    +
                    +

                    Enable calling driver methods

                    +
                    __call(string $method, array $args) 
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_Util::__call()
                    +

                    Parameters

                    +
                    +

                    $method

                    +string +
                    +
                    +

                    $args

                    +array +
                    +
                    +
                    +
                    +

                    Save a reference to the current connection object

                    +
                    __construct(object $conn) : void
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $conn

                    +object

                    &$conn

                    +
                    +
                    +
                    +
                    +

                    Create an SQL backup file for the current database's data

                    +
                    backup_data(array $exclude) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $exclude

                    +array +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Create an SQL backup file for the current database's structure

                    +
                    backup_structure() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Database-specific method to create a new table

                    +
                    create_table(string $name, array $columns, array $constraints, array $indexes) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $name

                    +string +
                    +
                    +

                    $columns

                    +array +
                    +
                    +

                    $constraints

                    +array +
                    +
                    +

                    $indexes

                    +array +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Database-specific SQL for dropping a table

                    +
                    delete_table(string $name) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $name

                    +string +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +

                    + Properties

                    + 
                    +

                    Reference to the current connection object

                    +
                    $conn 
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_Util::$$conn
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    + + diff --git a/docs/classes/Query_Builder.html b/docs/classes/Query_Builder.html new file mode 100644 index 0000000..6fc2cae --- /dev/null +++ b/docs/classes/Query_Builder.html @@ -0,0 +1,1230 @@ + + + + + +OpenSQLManager » \Query_Builder + + + + + + + + + +
                    +
                    +OpenSQLManager
                    +
                    +
                    Back to top  
                    +
                    +
                    + +
                    +
                    +
                    + +
                    + +
                    +
                    +
                    +

                    Convienience class for creating sql queries - also the class that +instantiates the specific db driver

                    +
                    +

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

                    + Methods

                    +
                    +

                    Calls a function further down the inheritence chain

                    +
                    __call(string $name, array $params) : mixed
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $name

                    +string +
                    +
                    +

                    $params

                    +array +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    Constructor

                    +
                    __construct(object $params) 
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $params

                    +object
                      +
                    • the connection parametere
                      • +
                    +
                    +
                    +
                    +
                    +

                    Retreive the number of rows in the selected table

                    +
                    count_all(string $table) : int
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    int
                    +
                    +
                    +
                    +

                    Retrieve the number of results for the generated query - used +in place of the get() method

                    +
                    count_all_results(string $table) : int
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    int
                    +
                    +
                    +
                    +

                    Deletes data from a table

                    +
                    delete(string $table, mixed $where) : mixed
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +
                    +

                    $where

                    +mixed +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    Adds the 'distinct' keyword to a query

                    +
                    distinct() : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Specify the database table to select from

                    +
                    from(string $dbname) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $dbname

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Select and retrieve all records from the current table, and/or +execute current compiled query

                    +
                    get($table, int $limit, int $offset) : object
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    + +
                    +
                    +

                    $limit

                    +int +
                    +
                    +

                    $offset

                    +int +
                    +

                    Returns

                    +
                    object
                    +
                    +
                    +
                    +

                    Convience method for get() with a where clause

                    +
                    get_where(string $table, array $where, int $limit, int $offset) : object
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +
                    +

                    $where

                    +array +
                    +
                    +

                    $limit

                    +int +
                    +
                    +

                    $offset

                    +int +
                    +

                    Returns

                    +
                    object
                    +
                    +
                    +
                    +

                    Group the results by the selected field(s)

                    +
                    group_by(mixed $field) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Ends a query group

                    +
                    group_end() : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Adds a paren to the current query for query grouping

                    +
                    group_start() : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Generates a 'Having' clause

                    +
                    having(mixed $key, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $key

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Creates an insert clause, and executes it

                    +
                    insert(string $table, mixed $data) : mixed
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +
                    +

                    $data

                    +mixed +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    Creates a join phrase in a compiled query

                    +
                    join(string $table, string $condition, string $type) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +
                    +

                    $condition

                    +string +
                    +
                    +

                    $type

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    + +
                    +

                    Set a limit on the current sql statement

                    +
                    limit(int $limit, int $offset) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $limit

                    +int +
                    +
                    +

                    $offset

                    +int +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Generates a NOT LIKE clause

                    +
                    not_like(string $field, mixed $val, string $pos) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $val

                    +mixed +
                    +
                    +

                    $pos

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Adds a paren to the current query for query grouping, +prefixed with 'OR'

                    +
                    or_group_start() : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Generates a 'Having' clause prefixed with 'OR'

                    +
                    or_having(mixed $key, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $key

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Generates an OR Like clause

                    +
                    or_like(string $field, mixed $val, string $pos) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $val

                    +mixed +
                    +
                    +

                    $pos

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Adds a paren to the current query for query grouping, +prefixed with 'OR NOT'

                    +
                    or_not_group_start() : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Generates a OR NOT LIKE clause

                    +
                    or_not_like(string $field, mixed $val, string $pos) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $val

                    +mixed +
                    +
                    +

                    $pos

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Where clause prefixed with "OR"

                    +
                    or_where(string $key, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $key

                    +string +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Where in statement prefixed with "or"

                    +
                    or_where_in(string $field, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    OR WHERE NOT IN (FOO) clause

                    +
                    or_where_not_in(string $field, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Order the results by the selected field(s)

                    +
                    order_by(string $field, string $type) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $type

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Specifies rows to select in a query

                    +
                    select(string $fields) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $fields

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Selects the average value of a field from a query

                    +
                    select_avg(string $field, string $as) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $as

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Selects the maximum value of a field from a query

                    +
                    select_max(string $field, string $as) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $as

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Selects the minimum value of a field from a query

                    +
                    select_min(string $field, string $as) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $as

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Selects the sum of a field from a query

                    +
                    select_sum(string $field, string $as) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $as

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Sets values for inserts / updates / deletes

                    +
                    set(mixed $key, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $key

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Creates an update clause, and executes it

                    +
                    update(string $table, mixed $data) : mixed
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +
                    +

                    $data

                    +mixed +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    Specify condition(s) in the where clause of a query +Note: this function works with key / value, or a +passed array with key / value pairs

                    +
                    where(mixed $key, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $key

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Where clause with 'IN' statement

                    +
                    where_in(mixed $field, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    WHERE NOT IN (FOO) clause

                    +
                    where_not_in(string $field, mixed $val) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    String together the sql statements for sending to the db

                    +
                    _compile(string $type, string $table) : \$string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $type

                    +string +
                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    \$string
                    +
                    +
                    +
                    +

                    Simplify building having clauses

                    +
                    _having(mixed $key, mixed $val, string $conj) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $key

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +
                    +

                    $conj

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Simplify 'like' methods

                    +
                    _like(string $field, mixed $val, string $pos, string $like, string $conj) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $val

                    +mixed +
                    +
                    +

                    $pos

                    +string +
                    +
                    +

                    $like

                    +string +
                    +
                    +

                    $conj

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Clear out the class variables, so the next query can be run

                    +
                    _reset() : void
                    +
                    +

                    +
                    +
                    +

                    Method to simplify select_ methods

                    +
                    _select(string $field, string $as) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $field

                    +string +
                    +
                    +

                    $as

                    +string +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Do all the repeditive stuff for where/having type methods

                    +
                    _where(mixed $key, mixed $val) : array
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $key

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Simplify where_in methods

                    +
                    _where_in(mixed $key, mixed $val, $in, $conj) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $key

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +
                    +

                    $in

                    +

                    string

                    +
                    +

                    $conj

                    +

                    string

                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +
                    +

                    Simplify generating where string

                    +
                    _where_string(mixed $key, mixed $val, string $conj) : \Query_Builder
                    +
                    +
                    +

                    + + + +
                    fluentThis method is part of a fluent interface and will return the same instance
                    +

                    Parameters

                    +
                    +

                    $key

                    +mixed +
                    +
                    +

                    $val

                    +mixed +
                    +
                    +

                    $conj

                    +string +
                    +

                    Returns

                    +
                    \Query_Builder
                    +
                    +
                    +

                    + Properties

                    + 
                    +

                    Convenience property for connection management

                    +
                    $conn_name : string
                    +
                    +

                    +
                    + 
                    +

                    Alias to $this->db->sql

                    +
                    $sql : \DB_PDO
                    +
                    +

                    +
                    + 
                    +

                    Compiled 'from' clause

                    +
                    $from_string : string
                    +
                    +

                    +
                    + 
                    +

                    Key/val pairs for group by clause

                    +
                    $group_array : array
                    +
                    +

                    +
                    + 
                    +

                    Group by clause

                    +
                    $group_string : string
                    +
                    +

                    +
                    + 
                    +

                    Map for having clause

                    +
                    $having_map : array
                    +
                    +

                    +
                    + 
                    +

                    Value for limit string

                    +
                    $limit : int
                    +
                    +

                    +
                    + 
                    +

                    Value for offset in limit string

                    +
                    $offset : int
                    +
                    +

                    +
                    + 
                    +

                    Key/val pairs for order by clause

                    +
                    $order_array : array
                    +
                    +

                    +
                    + 
                    +

                    Order by clause

                    +
                    $order_string : string
                    +
                    +

                    +
                    + 
                    +

                    Query component order mapping +for complex select queries

                    +
                    $query_map : array
                    +
                    +

                    Format:

                    + +

                    array( + 'type' => 'where', + 'conjunction' => ' AND ', + 'string' => 'k=?' +)

                    +
                    + 
                    +

                    Compiled 'select' clause

                    +
                    $select_string : string
                    +
                    +

                    +
                    + 
                    +

                    Keys for insert/update statement

                    +
                    $set_array_keys : array
                    +
                    +

                    +
                    + 
                    +

                    Compiled arguments for insert / update

                    +
                    $set_string : string
                    +
                    +

                    +
                    + 
                    +

                    Values to apply to prepared statements

                    +
                    $values : array
                    +
                    +

                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    + + diff --git a/docs/classes/SQLite.html b/docs/classes/SQLite.html new file mode 100644 index 0000000..6ba1bf6 --- /dev/null +++ b/docs/classes/SQLite.html @@ -0,0 +1,929 @@ + + + + + +OpenSQLManager » \SQLite + + + + + + + + + +
                    +
                    +OpenSQLManager
                    +
                    +
                    Back to top  
                    +
                    +
                    + +
                    +
                    +
                    + +
                    + +
                    +
                    +
                    +

                    SQLite specific class

                    +
                    +

                    Extends PDO to simplify cross-database issues

                    + + + + + + + + + +
                    packageQuery
                    subpackageDrivers
                    +

                    + Methods

                    +
                    +

                    Open SQLite Database

                    +
                    __construct(string $dsn, string $user, string $pass) 
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $dsn

                    +string +
                    +
                    +

                    $user

                    +string +
                    +
                    +

                    $pass

                    +string +
                    +
                    +
                    +
                    +

                    __sleep() +

                    +
                    __sleep() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::__sleep()
                    inherited_from\DB_PDO::__sleep()
                    +
                    +
                    +
                    +

                    __wakeup() +

                    +
                    __wakeup() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::__wakeup()
                    inherited_from\DB_PDO::__wakeup()
                    +
                    +
                    +
                    +

                    Returns number of rows affected by an INSERT, UPDATE, DELETE type query

                    +
                    affected_rows(\PDOStatement $statement) : int
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::affected_rows()
                    +

                    Parameters

                    +
                    +

                    $statement

                    +\PDOStatement +
                    +

                    Returns

                    +
                    int
                    +
                    +
                    +
                    +

                    beginTransaction() +

                    +
                    beginTransaction() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::beginTransaction()
                    inherited_from\DB_PDO::beginTransaction()
                    +
                    +
                    +
                    +

                    commit() +

                    +
                    commit() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::commit()
                    inherited_from\DB_PDO::commit()
                    +
                    +
                    +
                    +

                    Method to simplify retreiving db results for meta-data queries

                    +
                    driver_query(string $sql, bool $filtered_index) : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::driver_query()
                    +

                    Parameters

                    +
                    +

                    $sql

                    +string +
                    +
                    +

                    $filtered_index

                    +bool +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

                    +
                    empty_table(string $table) : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::empty_table()
                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    errorCode() +

                    +
                    errorCode() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::errorCode()
                    inherited_from\DB_PDO::errorCode()
                    +
                    +
                    +
                    +

                    errorInfo() +

                    +
                    errorInfo() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::errorInfo()
                    inherited_from\DB_PDO::errorInfo()
                    +
                    +
                    +
                    +

                    exec() +

                    +
                    exec() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::exec()
                    inherited_from\DB_PDO::exec()
                    +
                    +
                    +
                    +

                    getAttribute() +

                    +
                    getAttribute() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::getAttribute()
                    inherited_from\DB_PDO::getAttribute()
                    +
                    +
                    +
                    +

                    getAvailableDrivers() +

                    +
                    getAvailableDrivers() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::getAvailableDrivers()
                    inherited_from\DB_PDO::getAvailableDrivers()
                    +
                    +
                    +
                    +

                    Retrieve column information for the current database table

                    +
                    get_columns(string $table) : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_columns()
                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of dbs for the current connection, if possible

                    +
                    get_dbs() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_dbs()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of function for the current database

                    +
                    get_functions() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_functions()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return the last error for the current database connection

                    +
                    get_last_error() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_last_error()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return list of stored procedures for the current database

                    +
                    get_procedures() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_procedures()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Retreives the data from a select query

                    +
                    get_query_data(\PDOStatement $statement) : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_query_data()
                    +

                    Parameters

                    +
                    +

                    $statement

                    +\PDOStatement +
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return schemas for databases that list them

                    +
                    get_schemas() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_schemas()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of sequences for the current database, if they exist

                    +
                    get_sequences() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_sequences()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    List system tables for the current database

                    +
                    get_system_tables() : array
                    +
                    +
                    +

                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    List tables for the current database

                    +
                    get_tables() : mixed
                    +
                    +
                    +

                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +
                    +

                    Return list of triggers for the current database

                    +
                    get_triggers() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_triggers()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Retrieve list of data types for the database

                    +
                    get_types() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_types()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Return list of views for the current database

                    +
                    get_views() : array
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::get_views()
                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    inTransaction() +

                    +
                    inTransaction() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::inTransaction()
                    inherited_from\DB_PDO::inTransaction()
                    +
                    +
                    +
                    +

                    lastInsertId() +

                    +
                    lastInsertId() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::lastInsertId()
                    inherited_from\DB_PDO::lastInsertId()
                    +
                    +
                    +
                    +

                    Load a database for the current connection

                    +
                    load_database(string $db, string $name) 
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $db

                    +string +
                    +
                    +

                    $name

                    +string +
                    +
                    +
                    +
                    +

                    Return the number of rows returned for a SELECT query

                    +
                    num_rows() : int
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::num_rows()
                    +

                    Returns

                    +
                    int
                    +
                    +
                    +
                    +

                    prepare() +

                    +
                    prepare() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::prepare()
                    inherited_from\DB_PDO::prepare()
                    +
                    +
                    +
                    +

                    Create and execute a prepared statement with the provided parameters

                    +
                    prepare_execute(string $sql, array $params) : \PDOStatement
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::prepare_execute()
                    +

                    Parameters

                    +
                    +

                    $sql

                    +string +
                    +
                    +

                    $params

                    +array +
                    +

                    Returns

                    +
                    \PDOStatement
                    +
                    +
                    +
                    +

                    Simplifies prepared statements for database queries

                    +
                    prepare_query(string $sql, array $data) : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::prepare_query()
                    +

                    Parameters

                    +
                    +

                    $sql

                    +string +
                    +
                    +

                    $data

                    +array +
                    +

                    Returns

                    +
                    +mixedPDOStatement / FALSE
                    +
                    +
                    +
                    +

                    query() +

                    +
                    query() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::query()
                    inherited_from\DB_PDO::query()
                    +
                    +
                    +
                    +

                    quote() +

                    +
                    quote() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::quote()
                    inherited_from\DB_PDO::quote()
                    +
                    +
                    +
                    +

                    Surrounds the string with the databases identifier escape characters

                    +
                    quote_ident(mixed $ident) : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::quote_ident()
                    +

                    Parameters

                    +
                    +

                    $ident

                    +mixed +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    rollBack() +

                    +
                    rollBack() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::rollBack()
                    inherited_from\DB_PDO::rollBack()
                    +
                    +
                    +
                    +

                    setAttribute() +

                    +
                    setAttribute() 
                    +
                    Inherited
                    +
                    +

                    + + + + + + + + + +
                    inherited_fromPDO::setAttribute()
                    inherited_from\DB_PDO::setAttribute()
                    +
                    +
                    +
                    +

                    Doesn't apply to sqlite

                    +
                    switch_db(string $name) : void
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $name

                    +string +
                    +
                    +
                    +
                    +

                    Empty a table

                    +
                    truncate(string $table) : void
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +
                    +
                    +
                    +

                    Unload a database from the current connection

                    +
                    unload_database(string $name) 
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $name

                    +string +
                    +
                    +
                    +
                    +

                    Helper method for quote_ident

                    +
                    _quote(mixed $str) : mixed
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::_quote()
                    +

                    Parameters

                    +
                    +

                    $str

                    +mixed +
                    +

                    Returns

                    +
                    mixed
                    +
                    +
                    +

                    + Properties

                    + 
                    +

                    Reference to sql sub class

                    +
                    $sql : Object
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::$$sql
                    +
                    +
                    + 
                    +

                    Reference to util sub class

                    +
                    $util : Object
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::$$util
                    +
                    +
                    + 
                    +

                    Character to escape identifiers

                    +
                    $escape_char : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_PDO::$$escape_char
                    +
                    +
                    + 
                    +

                    Reference to the last executed sql query

                    +
                    $statement : \PDOStatement
                    +
                    +

                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    + + diff --git a/docs/classes/SQLite_SQL.html b/docs/classes/SQLite_SQL.html new file mode 100644 index 0000000..86e0bad --- /dev/null +++ b/docs/classes/SQLite_SQL.html @@ -0,0 +1,316 @@ + + + + + +OpenSQLManager » \SQLite_SQL + + + + + + + + + +
                    +
                    +OpenSQLManager
                    +
                    +
                    Back to top  
                    +
                    +
                    + +
                    +
                    +
                    + +
                    + +
                    +
                    +
                    +

                    SQLite Specific SQL

                    +
                    +

                    + + + + + + + + + +
                    packageQuery
                    subpackageDrivers
                    +

                    + Methods

                    +
                    +

                    Get the 'average' keyword

                    +
                    avg() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::avg()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    SQL to show infromation about columns in a table

                    +
                    column_list(string $table) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $table

                    +string +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Returns sql to list other databases

                    +
                    db_list() : FALSE
                    +
                    +
                    +

                    +

                    Returns

                    +
                    FALSE
                    +
                    +
                    +
                    +

                    Get the 'distinct' keyword

                    +
                    distinct() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::distinct()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return sql to list functions

                    +
                    function_list() : FALSE
                    +
                    +
                    +

                    +

                    Returns

                    +
                    FALSE
                    +
                    +
                    +
                    +

                    Limit clause

                    +
                    limit(string $sql, int $limit, int $offset) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $sql

                    +string +
                    +
                    +

                    $limit

                    +int +
                    +
                    +

                    $offset

                    +int +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Get the max keyword sql

                    +
                    max() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::max()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Get the min keyword sql

                    +
                    min() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::min()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return sql to list stored procedures

                    +
                    procedure_list() : FALSE
                    +
                    +
                    +

                    +

                    Returns

                    +
                    FALSE
                    +
                    +
                    +
                    +

                    Random ordering keyword

                    +
                    random() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Return sql to list sequences

                    +
                    sequence_list() : FALSE
                    +
                    +
                    +

                    +

                    Returns

                    +
                    FALSE
                    +
                    +
                    +
                    +

                    Get the 'sum' keyword

                    +
                    sum() : string
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_SQL::sum()
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Overridden in SQLite class

                    +
                    system_table_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Returns sql to list tables

                    +
                    table_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Returns sql to list triggers

                    +
                    trigger_list() : FALSE
                    +
                    +
                    +

                    +

                    Returns

                    +
                    FALSE
                    +
                    +
                    +
                    +

                    SQL to show list of field types

                    +
                    type_list() : array
                    +
                    +
                    +

                    +

                    Returns

                    +
                    array
                    +
                    +
                    +
                    +

                    Returns sql to list views

                    +
                    view_list() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    + + diff --git a/docs/classes/SQLite_Util.html b/docs/classes/SQLite_Util.html new file mode 100644 index 0000000..92f3fae --- /dev/null +++ b/docs/classes/SQLite_Util.html @@ -0,0 +1,216 @@ + + + + + +OpenSQLManager » \SQLite_Util + + + + + + + + + +
                    +
                    +OpenSQLManager
                    +
                    +
                    Back to top  
                    +
                    +
                    + +
                    +
                    +
                    + +
                    + +
                    +
                    +
                    +

                    SQLite-specific backup, import and creation methods

                    +
                    +

                    + + + + + + + + + +
                    packageQuery
                    subpackageDrivers
                    +

                    + Methods

                    +
                    +

                    Enable calling driver methods

                    +
                    __call(string $method, array $args) 
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_Util::__call()
                    +

                    Parameters

                    +
                    +

                    $method

                    +string +
                    +
                    +

                    $args

                    +array +
                    +
                    +
                    +
                    +

                    Save a reference to the current connection object

                    +
                    __construct(object $conn) : void
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $conn

                    +object

                    &$conn

                    +
                    +
                    +
                    +
                    +

                    Create an SQL backup file for the current database's data

                    +
                    backup_data(array $excluded) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $excluded

                    +array +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Create an SQL backup file for the current database's structure

                    +
                    backup_structure() : string
                    +
                    +
                    +

                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    Convenience public function to create a new table

                    +
                    create_table(string $name, array $columns, array $constraints, array $indexes) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $name

                    +string

                    //Name of the table

                    +
                    +
                    +

                    $columns

                    +array

                    //columns as straight array and/or column => type pairs

                    +
                    +
                    +

                    $constraints

                    +array

                    // column => constraint pairs

                    +
                    +
                    +

                    $indexes

                    +array

                    // column => index pairs

                    +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +
                    +

                    SQL to drop the specified table

                    +
                    delete_table(string $name) : string
                    +
                    +
                    +

                    +

                    Parameters

                    +
                    +

                    $name

                    +string +
                    +

                    Returns

                    +
                    string
                    +
                    +
                    +

                    + Properties

                    + 
                    +

                    Reference to the current connection object

                    +
                    $conn 
                    +
                    Inherited
                    +
                    +

                    + + + +
                    inherited_from\DB_Util::$$conn
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    +
                    + + diff --git a/docs/deprecated.html b/docs/deprecated.html index 4fe0be0..de5db1f 100644 --- a/docs/deprecated.html +++ b/docs/deprecated.html @@ -22,6 +22,7 @@
                  • Packages
                  •  Default
                  •  OpenSQLManager
                    • +
                  •  Query
                  •  Errors  0
                  •  Markers  -
                      • +
                    •  Deprecated elements  0
                      • @@ -66,7 +69,7 @@
                      + generated on 2012-06-06T16:47:37-04:00.
                      diff --git a/docs/errors.html b/docs/errors.html index 639dc3b..297afcd 100644 --- a/docs/errors.html +++ b/docs/errors.html @@ -22,6 +22,7 @@
                    • Packages
                    •  Default
                    •  OpenSQLManager
                      • +
                    •  Query
                    •  Errors  0
                    •  Markers  -
                        • +
                      •  Deprecated elements  0
                        • @@ -73,12 +76,33 @@
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        +
                        + generated on 2012-06-06T16:47:37-04:00.
                        diff --git a/docs/graph_class.html b/docs/graph_class.html index 7fcd165..a1018c2 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -22,6 +22,7 @@
                      • Packages
                      •  Default
                      •  OpenSQLManager
                        • +
                      •  Query
                      •  Errors  0
                      •  Markers  -
                          • +
                        •  Deprecated elements  0
                          • @@ -63,7 +66,7 @@
                          + generated on 2012-06-06T16:47:37-04:00.
                          diff --git a/docs/index.html b/docs/index.html index 35e0bc6..573c4db 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,6 +22,7 @@
                        • Packages
                        •  Default
                        •  OpenSQLManager
                          • +
                        •  Query
                        •  Errors  0
                        •  Markers  -
                            • +
                          •  Deprecated elements  0
                            • @@ -57,11 +60,13 @@
                            @@ -75,7 +80,9 @@
                          •  Errors  0
                          •  Markers  -
                              • +
                            •  Deprecated elements  0
                              • @@ -84,7 +91,7 @@
                              + generated on 2012-06-06T16:47:36-04:00.
                              diff --git a/docs/markers.html b/docs/markers.html index b95474d..c88bee7 100644 --- a/docs/markers.html +++ b/docs/markers.html @@ -22,6 +22,7 @@
                            • Packages
                            •  Default
                            •  OpenSQLManager
                              • +
                            •  Query
                            •  Errors  0
                            •  Markers  -
                                • +
                              •  Deprecated elements  0
                                • @@ -49,7 +52,14 @@ if Javascript is enabled.
                                -
                                • Navigation
                                +
                                • @@ -57,18 +67,105 @@
                                • Markers
                                -
                                No markers have been found in this project.
                                The following markers were found: -
                                  +
                                  • todo  + 5 +
                                  +
                                  +
                                  +
                                  +

                                  +sys/db/classes/query_builder.php1 +

                                  +
                                  + + + + + + + + + + +
                                  TypeLineDescription
                                  todo805make able to handle operators without spaces
                                  +
                                  +
                                  +

                                  +sys/db/drivers/pgsql/pgsql_util.php1 +

                                  +
                                  + + + + + + + + + + +
                                  TypeLineDescription
                                  todo114Implement Backup function
                                  +
                                  +
                                  +

                                  +sys/db/drivers/pgsql/pgsql_driver.php1 +

                                  +
                                  + + + + + + + + + + +
                                  TypeLineDescription
                                  todo46Implement
                                  +
                                  +
                                  +

                                  +sys/db/drivers/mysql/mysql_driver.php1 +

                                  +
                                  + + + + + + + + + + +
                                  TypeLineDescription
                                  todo57Implement
                                  +
                                  +
                                  +

                                  +sys/db/drivers/firebird/firebird_util.php1 +

                                  +
                                  + + + + + + + + + + +
                                  TypeLineDescription
                                  todo117Implement Backup structure function
                                  +
                                  -
                                  + generated on 2012-06-06T16:47:37-04:00.
                                  diff --git a/docs/namespaces/OpenSQLManager.html b/docs/namespaces/OpenSQLManager.html index 06921f3..d7ab37e 100644 --- a/docs/namespaces/OpenSQLManager.html +++ b/docs/namespaces/OpenSQLManager.html @@ -22,6 +22,7 @@
                                • Packages
                                •  Default
                                •  OpenSQLManager
                                  • +
                                •  Query
                                •  Errors  0
                                •  Markers  -
                                    • +
                                  •  Deprecated elements  0
                                    • @@ -256,12 +259,24 @@ with array_map and glob

                                    + 
                                    +

                                    PLATFORM

                                    +
                                    PLATFORM 
                                    +
                                    +

                                    +
                                     

                                    PROGRAM_NAME

                                    PROGRAM_NAME 

                                    + 
                                    +

                                    RESOURCE_DIR

                                    +
                                    RESOURCE_DIR 
                                    +
                                    +

                                    +
                                     

                                    SETTINGS_DIR

                                    SETTINGS_DIR 
                                    @@ -280,7 +295,7 @@ with array_map and glob
                                    + generated on 2012-06-06T16:47:37-04:00.
                                    diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html new file mode 100644 index 0000000..6ae4a4b --- /dev/null +++ b/docs/namespaces/default.html @@ -0,0 +1,290 @@ + + + + + +OpenSQLManager » default + + + + + + + + + +
                                    +
                                    +OpenSQLManager
                                    +
                                    +
                                    Back to top  
                                    +
                                    +
                                    + +
                                    +
                                    +
                                    + +
                                    + +
                                    +
                                    + +
                                    +

                                    + Functions

                                    +
                                    +

                                    Filter out db rows into one array

                                    +
                                    db_filter(array $array, mixed $index) : array
                                    +
                                    +
                                    +

                                    +

                                    Parameters

                                    +
                                    +

                                    $array

                                    +array +
                                    +
                                    +

                                    $index

                                    +mixed +
                                    +

                                    Returns

                                    +
                                    array
                                    +
                                    +
                                    +
                                    +

                                    Bulk directory loading workaround for use +with array_map and glob

                                    +
                                    do_include(string $path) : void
                                    +
                                    +
                                    +

                                    +

                                    Parameters

                                    +
                                    +

                                    $path

                                    +string +
                                    +
                                    +
                                    +
                                    +

                                    Load a Query class

                                    +
                                    query_autoload(string $class) 
                                    +
                                    +
                                    +

                                    +

                                    Parameters

                                    +
                                    +

                                    $class

                                    +string +
                                    +
                                    +
                                    +

                                    + Classes and interfaces

                                    +
                                    +

                                    DB_PDO +

                                    +

                                    Base Database class

                                    +
                                    +« More » +
                                    +
                                    +

                                    DB_SQL +

                                    +

                                    Abstract parent for database manipulation subclasses

                                    +
                                    +« More » +
                                    +
                                    +

                                    DB_Util +

                                    +

                                    Abstract class defining database / table creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    Firebird +

                                    +

                                    Firebird Database class

                                    +
                                    +« More » +
                                    +
                                    +

                                    Firebird_Result +

                                    +

                                    Firebird result class to emulate PDOStatement Class - only implements +data-fetching methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    Firebird_SQL +

                                    +

                                    Firebird Specific SQL

                                    +
                                    +« More » +
                                    +
                                    +

                                    Firebird_Util +

                                    +

                                    Firebird-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    MySQL +

                                    +

                                    MySQL specific class

                                    +
                                    +« More » +
                                    +
                                    +

                                    MySQL_SQL +

                                    +

                                    MySQL specifc SQL

                                    +
                                    +« More » +
                                    +
                                    +

                                    MySQL_Util +

                                    +

                                    MySQL-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    ODBC +

                                    +

                                    ODBC Database Driver

                                    +
                                    +« More » +
                                    +
                                    +

                                    ODBC_SQL +

                                    +

                                    ODBC SQL Class

                                    +
                                    +« More » +
                                    +
                                    +

                                    ODBC_Util +

                                    +

                                    ODBC-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    PgSQL +

                                    +

                                    PostgreSQL specifc class

                                    +
                                    +« More » +
                                    +
                                    +

                                    PgSQL_SQL +

                                    +

                                    PostgreSQL specifc SQL

                                    +
                                    +« More » +
                                    +
                                    +

                                    PgSQL_Util +

                                    +

                                    Posgres-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    Query_Builder +

                                    +

                                    Convienience class for creating sql queries - also the class that +instantiates the specific db driver

                                    +
                                    +« More » +
                                    +
                                    +

                                    SQLite +

                                    +

                                    SQLite specific class

                                    +
                                    +« More » +
                                    +
                                    +

                                    SQLite_SQL +

                                    +

                                    SQLite Specific SQL

                                    +
                                    +« More » +
                                    +
                                    +

                                    SQLite_Util +

                                    +

                                    SQLite-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +

                                    + Constants

                                    + 
                                    +

                                    Reference to root path

                                    +
                                    QBASE_PATH 
                                    +
                                    +

                                    +
                                    + 
                                    +

                                    Path to driver classes

                                    +
                                    QDRIVER_PATH 
                                    +
                                    +

                                    +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + diff --git a/docs/packages/.html b/docs/packages/.html index 273b691..4f5ac58 100644 --- a/docs/packages/.html +++ b/docs/packages/.html @@ -22,6 +22,7 @@
                                  • Packages
                                  •  Default
                                  •  OpenSQLManager
                                    • +
                                  •  Query
                                  •  Errors  0
                                  •  Markers  -
                                      • +
                                    •  Deprecated elements  0
                                      • @@ -66,7 +69,7 @@
                                      + generated on 2012-06-06T16:47:37-04:00.
                                      diff --git a/docs/packages/Default.html b/docs/packages/Default.html index be01928..b9e34ad 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -22,6 +22,7 @@
                                    • Packages
                                    •  Default
                                    •  OpenSQLManager
                                      • +
                                    •  Query
                                    •  Errors  0
                                    •  Markers  -
                                        • +
                                      •  Deprecated elements  0
                                        • @@ -62,7 +65,11 @@
                                      • Constants
                                      • BASE_DIR
                                        BASE_DIR
                                        • +
                                      • PLATFORM
                                        PLATFORM
                                      • PROGRAM_NAME
                                        PROGRAM_NAME
                                        • +
                                      • Reference to root path
                                        QBASE_PATH
                                        • +
                                      • Path to driver classes
                                        QDRIVER_PATH
                                        • +
                                      • RESOURCE_DIR
                                        RESOURCE_DIR
                                      • SETTINGS_DIR
                                        SETTINGS_DIR
                                      • VERSION
                                        VERSION
                                        • @@ -83,12 +90,36 @@

                                        + 
                                        +

                                        PLATFORM

                                        +
                                        PLATFORM 
                                        +
                                        +

                                        +
                                         

                                        PROGRAM_NAME

                                        PROGRAM_NAME 

                                        + 
                                        +

                                        Reference to root path

                                        +
                                        QBASE_PATH 
                                        +
                                        +

                                        +
                                        + 
                                        +

                                        Path to driver classes

                                        +
                                        QDRIVER_PATH 
                                        +
                                        +

                                        +
                                        + 
                                        +

                                        RESOURCE_DIR

                                        +
                                        RESOURCE_DIR 
                                        +
                                        +

                                        +
                                         

                                        SETTINGS_DIR

                                        SETTINGS_DIR 
                                        @@ -107,7 +138,7 @@
                                        + generated on 2012-06-06T16:47:37-04:00.
                                        diff --git a/docs/packages/OpenSQLManager.Common.html b/docs/packages/OpenSQLManager.Common.html index c68731b..f69bbbb 100644 --- a/docs/packages/OpenSQLManager.Common.html +++ b/docs/packages/OpenSQLManager.Common.html @@ -22,6 +22,7 @@
                                      • Packages
                                      •  Default
                                      •  OpenSQLManager
                                        • +
                                      •  Query
                                      •  Errors  0
                                      •  Markers  -
                                          • +
                                        •  Deprecated elements  0
                                          • @@ -96,7 +99,7 @@
                                          + generated on 2012-06-06T16:47:37-04:00.
                                          diff --git a/docs/packages/OpenSQLManager.Widgets.html b/docs/packages/OpenSQLManager.Widgets.html index 2a288c7..4ed6ef3 100644 --- a/docs/packages/OpenSQLManager.Widgets.html +++ b/docs/packages/OpenSQLManager.Widgets.html @@ -22,6 +22,7 @@
                                        • Packages
                                        •  Default
                                        •  OpenSQLManager
                                          • +
                                        •  Query
                                        •  Errors  0
                                        •  Markers  -
                                            • +
                                          •  Deprecated elements  0
                                            • @@ -112,7 +115,7 @@
                                            + generated on 2012-06-06T16:47:37-04:00.
                                            diff --git a/docs/packages/OpenSQLManager.Windows.html b/docs/packages/OpenSQLManager.Windows.html index a064cd1..7e2fafe 100644 --- a/docs/packages/OpenSQLManager.Windows.html +++ b/docs/packages/OpenSQLManager.Windows.html @@ -22,6 +22,7 @@
                                          • Packages
                                          •  Default
                                          •  OpenSQLManager
                                            • +
                                          •  Query
                                          •  Errors  0
                                          •  Markers  -
                                              • +
                                            •  Deprecated elements  0
                                              • @@ -88,7 +91,7 @@
                                              + generated on 2012-06-06T16:47:37-04:00.
                                              diff --git a/docs/packages/OpenSQLManager.html b/docs/packages/OpenSQLManager.html index c7f4026..b7daec4 100644 --- a/docs/packages/OpenSQLManager.html +++ b/docs/packages/OpenSQLManager.html @@ -22,6 +22,7 @@
                                            • Packages
                                            •  Default
                                            •  OpenSQLManager
                                              • +
                                            •  Query
                                            •  Errors  0
                                            •  Markers  -
                                                • +
                                              •  Deprecated elements  0
                                                • @@ -312,7 +315,7 @@ with array_map and glob
                                                + generated on 2012-06-06T16:47:37-04:00.
                                                diff --git a/docs/packages/Query.Drivers.html b/docs/packages/Query.Drivers.html new file mode 100644 index 0000000..b8a7fbb --- /dev/null +++ b/docs/packages/Query.Drivers.html @@ -0,0 +1,219 @@ + + + + + +OpenSQLManager » Query\Drivers + + + + + + + + + +
                                                +
                                                +OpenSQLManager
                                                +
                                                +
                                                Back to top  
                                                +
                                                +
                                                + +
                                                +
                                                +
                                                + +
                                                + +
                                                +
                                                + +
                                                +

                                                + Classes and interfaces

                                                +
                                                +

                                                Firebird +

                                                +

                                                Firebird Database class

                                                +
                                                +« More » +
                                                +
                                                +

                                                Firebird_Result +

                                                +

                                                Firebird result class to emulate PDOStatement Class - only implements +data-fetching methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                Firebird_SQL +

                                                +

                                                Firebird Specific SQL

                                                +
                                                +« More » +
                                                +
                                                +

                                                Firebird_Util +

                                                +

                                                Firebird-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                MySQL +

                                                +

                                                MySQL specific class

                                                +
                                                +« More » +
                                                +
                                                +

                                                MySQL_SQL +

                                                +

                                                MySQL specifc SQL

                                                +
                                                +« More » +
                                                +
                                                +

                                                MySQL_Util +

                                                +

                                                MySQL-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                ODBC +

                                                +

                                                ODBC Database Driver

                                                +
                                                +« More » +
                                                +
                                                +

                                                ODBC_SQL +

                                                +

                                                ODBC SQL Class

                                                +
                                                +« More » +
                                                +
                                                +

                                                ODBC_Util +

                                                +

                                                ODBC-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                PgSQL +

                                                +

                                                PostgreSQL specifc class

                                                +
                                                +« More » +
                                                +
                                                +

                                                PgSQL_SQL +

                                                +

                                                PostgreSQL specifc SQL

                                                +
                                                +« More » +
                                                +
                                                +

                                                PgSQL_Util +

                                                +

                                                Posgres-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                SQLite +

                                                +

                                                SQLite specific class

                                                +
                                                +« More » +
                                                +
                                                +

                                                SQLite_SQL +

                                                +

                                                SQLite Specific SQL

                                                +
                                                +« More » +
                                                +
                                                +

                                                SQLite_Util +

                                                +

                                                SQLite-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + diff --git a/docs/packages/Query.Query.html b/docs/packages/Query.Query.html new file mode 100644 index 0000000..15635f6 --- /dev/null +++ b/docs/packages/Query.Query.html @@ -0,0 +1,123 @@ + + + + + +OpenSQLManager » Query\Query + + + + + + + + + +
                                                +
                                                +OpenSQLManager
                                                +
                                                +
                                                Back to top  
                                                +
                                                +
                                                + +
                                                +
                                                +
                                                + +
                                                + +
                                                +
                                                + +
                                                +

                                                + Classes and interfaces

                                                +
                                                +

                                                DB_PDO +

                                                +

                                                Base Database class

                                                +
                                                +« More » +
                                                +
                                                +

                                                DB_SQL +

                                                +

                                                Abstract parent for database manipulation subclasses

                                                +
                                                +« More » +
                                                +
                                                +

                                                DB_Util +

                                                +

                                                Abstract class defining database / table creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                Query_Builder +

                                                +

                                                Convienience class for creating sql queries - also the class that +instantiates the specific db driver

                                                +
                                                +« More » +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + diff --git a/docs/packages/Query.html b/docs/packages/Query.html new file mode 100644 index 0000000..bb6c70f --- /dev/null +++ b/docs/packages/Query.html @@ -0,0 +1,310 @@ + + + + + +OpenSQLManager » Query + + + + + + + + + +
                                                +
                                                +OpenSQLManager
                                                +
                                                +
                                                Back to top  
                                                +
                                                +
                                                + +
                                                +
                                                +
                                                + +
                                                + +
                                                +
                                                + +
                                                +

                                                + Functions

                                                +
                                                +

                                                Filter out db rows into one array

                                                +
                                                db_filter(array $array, mixed $index) : array
                                                +
                                                +
                                                +

                                                +

                                                Parameters

                                                +
                                                +

                                                $array

                                                +array +
                                                +
                                                +

                                                $index

                                                +mixed +
                                                +

                                                Returns

                                                +
                                                array
                                                +
                                                +
                                                +
                                                +

                                                Bulk directory loading workaround for use +with array_map and glob

                                                +
                                                do_include(string $path) : void
                                                +
                                                +
                                                +

                                                +

                                                Parameters

                                                +
                                                +

                                                $path

                                                +string +
                                                +
                                                +
                                                +
                                                +

                                                Load a Query class

                                                +
                                                query_autoload(string $class) 
                                                +
                                                +
                                                +

                                                +

                                                Parameters

                                                +
                                                +

                                                $class

                                                +string +
                                                +
                                                +
                                                + +
                                                +

                                                + Classes and interfaces

                                                +
                                                +

                                                Firebird +

                                                +

                                                Firebird Database class

                                                +
                                                +« More » +
                                                +
                                                +

                                                Firebird_Result +

                                                +

                                                Firebird result class to emulate PDOStatement Class - only implements +data-fetching methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                Firebird_SQL +

                                                +

                                                Firebird Specific SQL

                                                +
                                                +« More » +
                                                +
                                                +

                                                Firebird_Util +

                                                +

                                                Firebird-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                MySQL +

                                                +

                                                MySQL specific class

                                                +
                                                +« More » +
                                                +
                                                +

                                                MySQL_SQL +

                                                +

                                                MySQL specifc SQL

                                                +
                                                +« More » +
                                                +
                                                +

                                                MySQL_Util +

                                                +

                                                MySQL-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                ODBC +

                                                +

                                                ODBC Database Driver

                                                +
                                                +« More » +
                                                +
                                                +

                                                ODBC_SQL +

                                                +

                                                ODBC SQL Class

                                                +
                                                +« More » +
                                                +
                                                +

                                                ODBC_Util +

                                                +

                                                ODBC-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                PgSQL +

                                                +

                                                PostgreSQL specifc class

                                                +
                                                +« More » +
                                                +
                                                +

                                                PgSQL_SQL +

                                                +

                                                PostgreSQL specifc SQL

                                                +
                                                +« More » +
                                                +
                                                +

                                                PgSQL_Util +

                                                +

                                                Posgres-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                SQLite +

                                                +

                                                SQLite specific class

                                                +
                                                +« More » +
                                                +
                                                +

                                                SQLite_SQL +

                                                +

                                                SQLite Specific SQL

                                                +
                                                +« More » +
                                                +
                                                +

                                                SQLite_Util +

                                                +

                                                SQLite-specific backup, import and creation methods

                                                +
                                                +« More » +
                                                +
                                                + +
                                                +

                                                + Classes and interfaces

                                                +
                                                +

                                                DB_PDO +

                                                +

                                                Base Database class

                                                +
                                                +« More » +
                                                +
                                                +

                                                DB_SQL +

                                                +

                                                Abstract parent for database manipulation subclasses

                                                +
                                                +« More » +
                                                +
                                                +

                                                DB_Util +

                                                +

                                                Abstract class defining database / table creation methods

                                                +
                                                +« More » +
                                                +
                                                +

                                                Query_Builder +

                                                +

                                                Convienience class for creating sql queries - also the class that +instantiates the specific db driver

                                                +
                                                +« More » +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + diff --git a/docs/structure.xml b/docs/structure.xml index e878608..76e7888 100644 --- a/docs/structure.xml +++ b/docs/structure.xml @@ -1,22 +1,26 @@ - - + + Free Database manager for Open Source Databases

                                                ]]>                                                 - - - - - + + + + +                                                 /db/autoload.php - + BASE_DIR + + RESOURCE_DIR + + SETTINGS_DIR @@ -29,6 +33,10 @@ VERSION + + PLATFORM + GetOperatingSystemId()]]> + log_fatal function @@ -149,6 +157,5138 @@ with array_map and glob]]>                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + DB_SQL + \DB_SQL + + + + + + + + + max + function + + + + + string + + + + + min + function + + + + + string + + + + + distinct + function + + + + + string + + + + + avg + function + + + + + string + + + + + sum + function + + + + + string + + + + + limit + function + + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + + string + + + + + db_list + function + + + + + string + + + + + table_list + function + + + + + string + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + string + + + + + function_list + function + + + + + FALSE + + + + + procedure_list + function + + + + + string + + + + + sequence_list + function + + + + + string + + + + + type_list + function + + + + + mixed + + + + + column_list + function + + + + + + string + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + DB_PDO + \DB_PDO + \PDO + + + Extends PDO to simplify cross-database issues

                                                ]]>                                                 + + +                                                 + + $statement + + + + + + mixed + + + + + $escape_char + + + + + + string + + + + + $sql + + + + + + Object + + + + + $util + + + + + + Object + + + + + __construct + function + + + + + string + + + string + + + string + + + array + + + + $dsn + + + + + $username + + + + + $password + + + + + $driver_options + + + + + + prepare_query + function + + + + + string + + + array + + + mixed + + + + $sql + + + + + $data + + + + + + prepare_execute + function + + + + + string + + + array + + + \PDOStatement + + + + $sql + + + + + $params + + + + + + get_query_data + function + + + + + \PDOStatement + + + array + + + + $statement + + + + + + affected_rows + function + + + + + \PDOStatement + + + int + + + + $statement + + + + + + get_last_error + function + + + + + string + + + + + quote_ident + function + + + + + mixed + + + string + + + + $ident + + + + + + _quote + function + + + + + mixed + + + mixed + + + + $str + + + + + + empty_table + function + + + + + string + + + mixed + + + + $table + + + + + + get_schemas + function + + + + + array + + + + + get_tables + function + + + + + array + + + + + get_dbs + function + + + + + array + + + + + get_views + function + + + + + array + + + + + get_sequences + function + + + + + array + + + + + get_functions + function + + + + + array + + + + + get_procedures + function + + + + + array + + + + + get_triggers + function + + + + + array + + + + + get_system_tables + function + + + + + array + + + + + get_columns + function + + + + + string + + + array + + + + $table + + + + + + get_types + function + + + + + array + + + + + driver_query + function + + + + + string + + + bool + + + mixed + + + + $sql + + + + + $filtered_index + + + + + + num_rows + function + + + + + int + + + + + truncate + function + + + + + string + + + void + + + + $table + + + + + + switch_db + function + + + + + string + + + void + + + + $name + + + + +                                                 +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + make able to handle operators without spaces + + + Query_Builder + \Query_Builder + + + + + + + + + $select_string + + + + + + string + + + + + $from_string + + + + + + string + + + + + $set_string + + + + + + string + + + + + $order_string + + + + + + string + + + + + $group_string + + + + + + string + + + + + $set_array_keys + + + + + + array + + + + + $order_array + + + + + + array + + + + + $group_array + + + + + + array + + + + + $values + + + + + + array + + + + + $limit + + + + + + int + + + + + $offset + + + + + + int + + + + + $sql + + + db->sql]]> + + + \DB_PDO + + + + + $query_map + + + + Format:

                                                + +

                                                array( + 'type' => 'where', + 'conjunction' => ' AND ', + 'string' => 'k=?' +)

                                                ]]>                                                 + + array + +                                                 +                                                 + + $having_map + + + + + + array + + + + + $conn_name + + + + + + string + + + + + __construct + function + + + + + object + + + + $params + + + + + + select + function + + + + + string + + + \$this + + + + $fields + + + + + + _select + function + + + + + string + + + string + + + string + + + + $field + + + + + $as + + + + + + select_max + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $as + + + + + + select_min + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $as + + + + + + select_avg + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $as + + + + + + select_sum + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $as + + + + + + distinct + function + + + + + \$this + + + + + from + function + + + + + string + + + \$this + + + + $dbname + + + + + + _like + function + + + + + string + + + mixed + + + string + + + string + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + $like + + + + + $conj + + + + + + like + function + + + + + string + + + mixed + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + + or_like + function + + + + + string + + + mixed + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + + not_like + function + + + + + string + + + mixed + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + + or_not_like + function + + + + + string + + + mixed + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + + _having + function + + + + + mixed + + + mixed + + + string + + + \$this + + + + $key + + + + + $val + + + + + $conj + + + + + + having + function + + + + + mixed + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + or_having + function + + + + + mixed + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + _where + function + + + + + mixed + + + mixed + + + array + + + + $key + + + + + $val + + + + + + _where_string + function + + + + + mixed + + + mixed + + + string + + + \$this + + + + $key + + + + + $val + + + + + $conj + + + + + + _where_in + function + + + + + mixed + + + mixed + + + + + \$this + + + + $key + + + + + $val + + + + + $in + + + + + $conj + + + + + + where + function + + + + + mixed + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + or_where + function + + + + + string + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + where_in + function + + + + + mixed + + + mixed + + + \$this + + + + $field + + + + + $val + + + + + + or_where_in + function + + + + + string + + + mixed + + + \$this + + + + $field + + + + + $val + + + + + + where_not_in + function + + + + + string + + + mixed + + + \$this + + + + $field + + + + + $val + + + + + + or_where_not_in + function + + + + + string + + + mixed + + + \$this + + + + $field + + + + + $val + + + + + + set + function + + + + + mixed + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + join + function + + + + + string + + + string + + + string + + + \$this + + + + $table + + + + + $condition + + + + + $type + + + + + + group_by + function + + + + + mixed + + + \$this + + + + $field + + + + + + order_by + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $type + + + + + + limit + function + + + + + int + + + int + + + string + + + + $limit + + + + + $offset + + + + + + group_start + function + + + + + \$this + + + + + or_group_start + function + + + + + \$this + + + + + or_not_group_start + function + + + + + \$this + + + + + group_end + function + + + + + \$this + + + + + get + function + + + + + + int + + + int + + + object + + + + $table + + + + + $limit + + + + + $offset + + + + + + get_where + function + + + + + string + + + array + + + int + + + int + + + object + + + + $table + + + + + $where + + + + + $limit + + + + + $offset + + + + + + count_all + function + + + + + string + + + int + + + + $table + + + + + + count_all_results + function + + + + + string + + + int + + + + $table + + + + + + insert + function + + + + + string + + + mixed + + + mixed + + + + $table + + + + + $data + + + + + + update + function + + + + + string + + + mixed + + + mixed + + + + $table + + + + + $data + + + + + + delete + function + + + + + string + + + mixed + + + mixed + + + + $table + + + + + $where + + + + + + __call + function + + + + + string + + + array + + + mixed + + + + $name + + + + + $params + + + + + + _reset + function + + + + + void + + + + + _compile + function + + + + + string + + + string + + + \$string + + + + $type + + + + + $table + + + + +                                                 +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + DB_Util + \DB_Util + + + + + + + + + $conn + + + + + + + + __construct + function + + + + + object + + + + $conn + + + + + + __call + function + + + + + string + + + array + + + + $method + + + + + $args + + + + + + create_table + function + + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + + string + + + + + backup_data + function + + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + QBASE_PATH + + + + + + + + QDRIVER_PATH + + + + + + + + do_include + function + + + + + string + + + void + + + + $path + + + + + + query_autoload + function + + + + + string + + + + $class + + + + + + db_filter + function + + + + + array + + + mixed + + + array + + + + $array + + + + + $index + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + +                                                 + + PgSQL_SQL + \PgSQL_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + string + + + + + table_list + function + + + + + string + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + string + + + + + function_list + function + + + + + FALSE + + + + + procedure_list + function + + + + + string + + + + + sequence_list + function + + + + + string + + + + + column_list + function + + + + + string + + + string + + + + $table + + + + + + type_list + function + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Implement Backup function + + + PgSQL_Util + \PgSQL_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + string + + + + + backup_data + function + + + + + array + + + string + + + + $exclude + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Implement + + + PgSQL + \PgSQL + \DB_PDO + + + + + + + + __construct + function + + + + + string + + + string + + + string + + + array + + + + $dsn + + + + + $username + + + + + $password + + + + + $options + + + + + + switch_db + function + + + + + string + + + + $name + + + + + + truncate + function + + + + + string + + + + $table + + + + + + get_schemas + function + + + + + array + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + ODBC_Util + \ODBC_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + string + + + + + backup_data + function + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + ODBC_SQL + \ODBC_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + FALSE + + + + + table_list + function + + + + + FALSE + + + + + system_table_list + function + + + + + FALSE + + + + + view_list + function + + + + + FALSE + + + + + trigger_list + function + + + + + FALSE + + + + + function_list + function + + + + + FALSE + + + + + procedure_list + function + + + + + FALSE + + + + + sequence_list + function + + + + + FALSE + + + + + type_list + function + + + + + FALSE + + + + + column_list + function + + + + + string + + + FALSE + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + ODBC + \ODBC + \DB_PDO + + + For general database access for databases not specified by the main drivers

                                                ]]>                                                 + + +                                                 + + $escape_char + + + + + + + + __construct + function + + + + + string + + + string + + + string + + + array + + + + $dsn + + + + + $username + + + + + $password + + + + + $options + + + + + + switch_db + function + + + + + string + + + bool + + + + $name + + + + + + truncate + function + + + + + string + + + void + + + + $table + + + + +                                                 +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + MySQL_Util + \MySQL_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + string + + + + + backup_data + function + + + + + array + + + string + + + + $exclude + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Implement + + + MySQL + \MySQL + \DB_PDO + + + + + + + + $escape_char + + + + + + string + + + + + __construct + function + + + + + string + + + string + + + string + + + array + + + + $dsn + + + + + $username + + + + + $password + + + + + $options + + + + + + switch_db + function + + + + + string + + + + $name + + + + + + truncate + function + + + + + string + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + MySQL_SQL + \MySQL_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + string + + + + + table_list + function + + + + + string + + + string + + + + $database + + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + string + + + + + function_list + function + + + + + string + + + + + procedure_list + function + + + + + string + + + + + sequence_list + function + + + + + FALSE + + + + + type_list + function + + + + + string + + + + + column_list + function + + + + + string + + + string + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + SQLite_Util + \SQLite_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_data + function + + + + + array + + + string + + + + $excluded + + + + + + backup_structure + function + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + SQLite + \SQLite + \DB_PDO + + + + + + + + $statement + + + + + + \PDOStatement + + + + + __construct + function + + + + + string + + + string + + + string + + + + $dsn + + + + + $user + + + + + $pass + + + + + + switch_db + function + + + + + string + + + + $name + + + + + + truncate + function + + + + + string + + + + $table + + + + + + get_tables + function + + + + + mixed + + + + + get_system_tables + function + + + + + array + + + + + load_database + function + + + + + string + + + string + + + + $db + + + + + $name + + + + + + unload_database + function + + + + + string + + + + $name + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + SQLite_SQL + \SQLite_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + FALSE + + + + + table_list + function + + + + + string + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + FALSE + + + + + function_list + function + + + + + FALSE + + + + + procedure_list + function + + + + + FALSE + + + + + sequence_list + function + + + + + FALSE + + + + + type_list + function + + + + + array + + + + + column_list + function + + + + + string + + + string + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Firebird_SQL + \Firebird_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + FALSE + + + + + table_list + function + + + + + string + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + string + + + + + function_list + function + + + + + string + + + + + procedure_list + function + + + + + string + + + + + sequence_list + function + + + + + string + + + + + column_list + function + + + + + string + + + string + + + + $table + + + + + + type_list + function + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Firebird_Result + \Firebird_Result + \PDOStatement + + + + + + + + $statement + + + + + + resource + + + + + $row + + + + + + int + + + + + $result + + + + + + + + + __construct + function + + + + + resource + + + + $link + + + + + + bindColumn + function + + + + + mixed + + + mixed + + + int + + + mixed + + + array + + + FALSE + + + + $column + + + + + $param + + + + + $type + + + + + $maxlen + + + + + $driverdata + + + + + + bindParam + function + + + + + mixed + + + mixed + + + int + + + mixed + + + array + + + FALSE + + + + $parameter + + + + + $variable + + + + + $data_type + + + + + $maxlen + + + + + $driverdata + + + + + + bindValue + function + + + + + mixed + + + mixed + + + int + + + FALSE + + + + $parameter + + + + + $variable + + + + + $data_type + + + + + + execute + function + + + + + array + + + bool + + + + $args + + + + + + fetch + function + + + + + int + + + mixed + + + mixed + + + mixed + + + + $fetch_style + + + + + $statement + + + + + $offset + + + + + + fetchAll + function + + + + + int + + + mixed + + + mixed + + + mixed + + + + $fetch_style + + + + + $statement + + + + + $ctor_args + + + + + + fetchColumn + function + + + + + int + + + mixed + + + + $column_num + + + + + + fetchObject + function + + + + + string + + + array + + + \stdClass + + + + $class_name + + + + + $ctor_args + + + + + + rowCount + function + + + + + int + + + + + errorCode + function + + errorCode]]> + + + string + + + + + errorInfo + function + + errorInfo / PDOStatement->errorInfo]]> + + + array + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Firebird + \Firebird + \DB_PDO + + + PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.

                                                ]]>                                                 + + +                                                 + + $statement + + + + + + object + + + + + $statement_link + + + + + + resource + + + + + $trans + + + + + + resource + + + + + $conn + + + + + + resource + + + + + __construct + function + + + + + string + + + string + + + string + + + + $dbpath + + + + + $user + + + + + $pass + + + + + + switch_db + function + + + + + string + + + FALSE + + + + $name + + + + + + truncate + function + + + + + string + + + + $table + + + + + + query + function + + + + + string + + + \$this + + + + $sql + + + + + + prepare + function + + + + + string + + + array + + + \$this + + + + $query + + + + + $options + + + + + + beginTransaction + function + + + + + bool + + + + + commit + function + + + + + bool + + + + + rollBack + function + + + + + bool + + + + + prepare_execute + function + + + + + string + + + array + + + resource + + + + $sql + + + + + $args + + + + + + quote + function + + quote]]> + + + string + + + int + + + string + + + + $str + + + + + $param_type + + + + + + errorInfo + function + + errorInfo / PDOStatement->errorInfo]]> + + + array + + + + + errorCode + function + + errorCode]]> + + + array + + + + + prepare_query + function + + + + + string + + + array + + + FALSE + + + + $sql + + + + + $params + + + + +                                                 +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Implement Backup structure function + + + Firebird_Util + \Firebird_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $fields + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + string + + + + + backup_data + function + + + + + array + + + bool + + + string + + + + $exclude + + + + + $system_tables + + + + + +                                                 @@ -534,7 +5674,7 @@ directly - the settings should be safe!]]> - + Free Database manager for Open Source Databases

                                                ]]>                                                 @@ -850,7 +5990,7 @@ directly - the settings should be safe!]]>                                                 - + Free Database manager for Open Source Databases

                                                ]]>                                                 @@ -1008,51 +6148,51 @@ directly - the settings should be safe!]]> - + test_conn function - + - + void - + _get_vals function - + - + object - + _hide function - + - + - + $ctrls - + _show function - + - + - + $ctrls @@ -1060,7 +6200,7 @@ directly - the settings should be safe!]]>                                                 - + Free Database manager for Open Source Databases

                                                ]]>                                                 @@ -1186,8 +6326,13 @@ Create menus, hboxes, vboxs and other widgets]]> + + + + - todo + + todo fixme                                                 diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml index e36b0e3..73a484f 100644 --- a/phpdoc.dist.xml +++ b/phpdoc.dist.xml @@ -13,8 +13,8 @@ . tests - sys/db + sys/db/tests tests/* - sys/db/* + sys/db/tests/* \ No newline at end of file