From 827dcd69daedca5c62c8f556028d747fa14879be Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Tue, 15 May 2012 12:47:24 -0400 Subject: [PATCH] Remove Query from generated docs --- docs/classes.svg | 432 +- docs/classes/Add_DB.html | 7 +- docs/classes/Connection_Sidebar.html | 9 +- docs/classes/DB_Info_Widget.html | 317 -- docs/classes/DB_PDO.html | 714 --- docs/classes/DB_Reg.html | 160 - docs/classes/DB_SQL.html | 306 -- docs/classes/DB_Structure_Widget.html | 98 - docs/classes/DB_Table_Data.html | 117 - docs/classes/DB_Util.html | 217 - docs/classes/DB_tabs.html | 295 -- docs/classes/Data_Grid.html | 7 +- docs/classes/Edit_DB.html | 7 +- docs/classes/Edit_Table.html | 7 +- 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/Main.html | 9 +- 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 - 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/classes/Settings.html | 252 - docs/deprecated.html | 7 +- docs/errors.html | 30 +- docs/graph_class.html | 7 +- docs/index.html | 12 +- docs/markers.html | 127 +- docs/namespaces/default.html | 208 +- docs/packages/.html | 7 +- docs/packages/Default.html | 21 +- 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.Helper Classes.html | 105 - docs/packages/Query.Query.html | 123 - docs/packages/Query.html | 324 -- docs/structure.xml | 5423 +-------------------- phpdoc.dist.xml | 4 +- 50 files changed, 134 insertions(+), 18409 deletions(-) delete mode 100644 docs/classes/DB_Info_Widget.html delete mode 100644 docs/classes/DB_PDO.html delete mode 100644 docs/classes/DB_Reg.html delete mode 100644 docs/classes/DB_SQL.html delete mode 100644 docs/classes/DB_Structure_Widget.html delete mode 100644 docs/classes/DB_Table_Data.html delete mode 100644 docs/classes/DB_Util.html delete mode 100644 docs/classes/DB_tabs.html delete mode 100644 docs/classes/Firebird.html delete mode 100644 docs/classes/Firebird_Result.html delete mode 100644 docs/classes/Firebird_SQL.html delete mode 100644 docs/classes/Firebird_Util.html delete mode 100644 docs/classes/MySQL.html delete mode 100644 docs/classes/MySQL_SQL.html delete mode 100644 docs/classes/MySQL_Util.html delete mode 100644 docs/classes/ODBC.html delete mode 100644 docs/classes/ODBC_SQL.html delete mode 100644 docs/classes/ODBC_Util.html delete mode 100644 docs/classes/PgSQL.html delete mode 100644 docs/classes/PgSQL_SQL.html delete mode 100644 docs/classes/PgSQL_Util.html delete mode 100644 docs/classes/Query_Builder.html delete mode 100644 docs/classes/SQLite.html delete mode 100644 docs/classes/SQLite_SQL.html delete mode 100644 docs/classes/SQLite_Util.html delete mode 100644 docs/classes/Settings.html delete mode 100644 docs/packages/Query.Drivers.html delete mode 100644 docs/packages/Query.Helper Classes.html delete mode 100644 docs/packages/Query.Query.html delete mode 100644 docs/packages/Query.html diff --git a/docs/classes.svg b/docs/classes.svg index 690fb5b..405e7f6 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -4,422 +4,170 @@ - - + + G - + cluster_default - - - - - - - - - - -\\DB_Reg - - -DB_Reg - - - -\\Settings - - -Settings - - - -\\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 - - + + + + + + + + -\\Connection_Sidebar +\\Connection_Sidebar - -Connection_Sidebar + +Connection_Sidebar -\\GtkVBox - -\GtkVBox +\\GtkVBox + +\GtkVBox -\\Connection_Sidebar->\\GtkVBox - - +\\Connection_Sidebar->\\GtkVBox + + -\\Data_Grid +\\Data_Grid - -Data_Grid + +Data_Grid -\\GtkTreeView - -\GtkTreeView +\\GtkTreeView + +\GtkTreeView -\\Data_Grid->\\GtkTreeView - - +\\Data_Grid->\\GtkTreeView + + -\\DB_Structure_Widget +\\DB_Structure_Widget - -DB_Structure_Widget + +DB_Structure_Widget -\\GTKTable - -\GTKTable +\\GTKTable + +\GTKTable -\\DB_Structure_Widget->\\GTKTable - - +\\DB_Structure_Widget->\\GTKTable + + -\\DB_tabs +\\DB_tabs - -DB_tabs + +DB_tabs -\\GtkNotebook - -\GtkNotebook +\\GtkNotebook + +\GtkNotebook -\\DB_tabs->\\GtkNotebook - - +\\DB_tabs->\\GtkNotebook + + -\\DB_Info_Widget +\\DB_Info_Widget - -DB_Info_Widget + +DB_Info_Widget -\\GtkTable - -\GtkTable +\\GtkTable + +\GtkTable -\\DB_Info_Widget->\\GtkTable - - +\\DB_Info_Widget->\\GtkTable + + -\\Add_DB +\\Add_DB - -Add_DB + +Add_DB -\\GtkWindow - -\GtkWindow +\\GtkWindow + +\GtkWindow -\\Add_DB->\\GtkWindow - - +\\Add_DB->\\GtkWindow + + -\\Edit_DB +\\Edit_DB - -Edit_DB + +Edit_DB -\\Edit_DB->\\GtkWindow - - +\\Edit_DB->\\GtkWindow + + -\\Edit_Table +\\Edit_Table - -Edit_Table + +Edit_Table -\\Edit_Table->\\GtkWindow - - +\\Edit_Table->\\GtkWindow + + -\\DB_Table_Data +\\DB_Table_Data - -DB_Table_Data + +DB_Table_Data -\\DB_Table_Data->\\GtkWindow - - +\\DB_Table_Data->\\GtkWindow + + -\\Main +\\Main - -Main + +Main -\\Main->\\GtkWindow - - +\\Main->\\GtkWindow + + diff --git a/docs/classes/Add_DB.html b/docs/classes/Add_DB.html index 20865c4..23b6bbc 100644 --- a/docs/classes/Add_DB.html +++ b/docs/classes/Add_DB.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -92,7 +89,7 @@
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/classes/Connection_Sidebar.html b/docs/classes/Connection_Sidebar.html index e89621f..ca3a242 100644 --- a/docs/classes/Connection_Sidebar.html +++ b/docs/classes/Connection_Sidebar.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -294,7 +291,7 @@  

    Reference to Settings instance

    -
    $settings : \Settings
    +
    $settings : \Settings

    @@ -323,7 +320,7 @@
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/classes/DB_Info_Widget.html b/docs/classes/DB_Info_Widget.html deleted file mode 100644 index 8c3bc00..0000000 --- a/docs/classes/DB_Info_Widget.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - -OpenSQLManager » \DB_Info_Widget - - - - - - - - - -
    -
    -OpenSQLManager
    -
    -
    Back to top  
    -
    -
    - -
    -
    -
    - -
    - -
    -
    -
    -

    Widget for adding / editing database connections

    -
    -

    - - - - - - - - - -
    packageOpenSQLManager
    subpackageWidgets
    -

    - Methods

    -
    -

    No params = add, params = edit

    -
    __construct(object $db) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $db

    -object -
    -
    -
    -
    -

    Set defaults for new database type

    -
    change_db() : void
    -
    -

    -
    -
    -

    Adds the database to the settings file

    -
    db_add() : void
    -
    -

    -
    -
    -

    Edit an existing database connection

    -
    db_edit() : void
    -
    -

    -
    -
    -

    Checks what database drivers are available

    -
    get_available_dbs() : array
    -
    -
    -

    -

    Returns

    -
    array
    -
    -
    -
    -

    Like change_db function, but save current values

    -
    set_db() : void
    -
    -

    -
    -
    -

    Test a db connection, and display a popup with the result of the test

    -
    test_conn() : void
    -
    -

    -
    -
    -

    Simple helper function for adding a row to the GtkTable

    -
    _add_row(string $label, string $vname, int $y1, int $y2) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $label

    -string -
    -
    -

    $vname

    -string -
    -
    -

    $y1

    -int

    &$y1

    -
    -
    -

    $y2

    -int

    &$y2

    -
    -
    -
    -
    -

    Table layout

    -
    _layout() : void
    -
    -

    -
    -

    - Properties

    - 
    -

    Connection name

    -
    $conn : \GtkEntry
    -
    -

    -
    - 
    -

    Connection database name

    -
    $conn_db : \GtkEntry
    -
    -

    -
    - 
    -

    Connection database file

    -
    $db_file : \GtkFileChooserButton
    -
    -

    -
    - 
    -

    Connection database type

    -
    $dbtype : \GtkComboBox
    -
    -

    -
    - 
    -

    Connection database host

    -
    $host : \GtkEntry
    -
    -

    -
    - 
    -

    Label for connection name

    -
    $lblconn : \GtkLabel
    -
    -

    -
    - 
    -

    Label for connection database name

    -
    $lblconn_db : \Gtklabel
    -
    -

    -
    - 
    -

    Label for database file

    -
    $lbldb_file : \GtkLabel
    -
    -

    -
    - 
    -

    Label for database type

    -
    $lbldbtype : \Gtklabel
    -
    -

    -
    - 
    -

    Label for database host

    -
    $lblhost : \Gtklabel
    -
    -

    -
    - 
    -

    Label for database connection password

    -
    $lblpass : \GtkLabel
    -
    -

    -
    - 
    -

    Label for database connection port

    -
    $lblport : \GtkLabel
    -
    -

    -
    - 
    -

    Label for database connection user

    -
    $lbluser : \GtkLabel
    -
    -

    -
    - 
    -

    Reference to last connection name

    -
    $old_conn : string
    -
    -

    -
    - 
    -

    Connection password

    -
    $pass : \GtkEntry
    -
    -

    -
    - 
    -

    Connection port

    -
    $port : \GtkEntry
    -
    -

    -
    - 
    -

    Connection user name

    -
    $user : \GtkEntry
    -
    -

    -
    - 
    -

    Alias to Settings::get_instance

    -
    $settings : \Settings
    -
    -

    -
    -
    -
    -
    -
    -
    -
    - - diff --git a/docs/classes/DB_PDO.html b/docs/classes/DB_PDO.html deleted file mode 100644 index b32fefe..0000000 --- a/docs/classes/DB_PDO.html +++ /dev/null @@ -1,714 +0,0 @@ - - - - - -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()
    -
    -
    -
    -

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

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

    - 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_Reg.html b/docs/classes/DB_Reg.html deleted file mode 100644 index 68fdc9a..0000000 --- a/docs/classes/DB_Reg.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - -OpenSQLManager » \DB_Reg - - - - - - - - - -
    -
    -OpenSQLManager
    -
    -
    Back to top  
    -
    -
    - -
    -
    -
    - -
    - -
    -
    -
    -

    Connection registry

    -
    -

    Decouples the Settings class from the query builder -and organizes database connections

    - - - - - - - - - -
    packageQuery
    subpackageHelper Classes
    -

    - Methods

    -
    -

    Return exiting connections

    -
    get_connections() : array
    -
    -
    -

    -

    Returns

    -
    array
    -
    -
    -
    -

    Registry access method

    -
    get_db(string $key) : object
    -
    -
    -

    -

    Parameters

    -
    -

    $key

    -string -
    -

    Returns

    -
    object
    -
    -
    -
    -

    Remove a database connection

    -
    remove_db(string $key) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $key

    -string -
    -
    -
    -
    -

    Private constructor

    -
    __construct(string $key) 
    -
    -
    -

    -

    Parameters

    -
    -

    $key

    -string -
    -
    -
    -

    - Properties

    - 
    -

    Static array of connections

    -
    $instance 
    -
    -

    -
    -
    -
    -
    -
    -
    -
    - - diff --git a/docs/classes/DB_SQL.html b/docs/classes/DB_SQL.html deleted file mode 100644 index c786367..0000000 --- a/docs/classes/DB_SQL.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - -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_Structure_Widget.html b/docs/classes/DB_Structure_Widget.html deleted file mode 100644 index 6b71375..0000000 --- a/docs/classes/DB_Structure_Widget.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - -OpenSQLManager » \DB_Structure_Widget - - - - - - - - - -
    -
    -OpenSQLManager
    -
    -
    Back to top  
    -
    -
    - -
    -
    -
    - -
    - -
    -
    -
    -

    Class for generating db-structure editing views

    -
    -

    - - - - - - - - - -
    packageOpenSQLManager
    subpackageWidgets
    -

    - Methods

    -
    -

    Initialize the class

    -
    __construct() 
    -
    -

    -
    -
    -
    -
    -
    -
    -
    - - diff --git a/docs/classes/DB_Table_Data.html b/docs/classes/DB_Table_Data.html deleted file mode 100644 index 629dad9..0000000 --- a/docs/classes/DB_Table_Data.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - -OpenSQLManager » \DB_Table_Data - - - - - - - - - -
    -
    -OpenSQLManager
    -
    -
    Back to top  
    -
    -
    - -
    -
    -
    - -
    - -
    -
    -
    -

    Popup window to display database table data

    -
    -

    - - - - - - - - - -
    packageOpenSQLManager
    subpackageWindows
    -

    - Methods

    -
    -

    Create and populate the window

    -
    __construct(array $data) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $data

    -array -
    -
    -
    -

    - Properties

    - 
    -

    Reference to the scrolled window

    -
    $win : \GtkScrolledWindow
    -
    -

    -
    -
    -
    -
    -
    -
    -
    - - diff --git a/docs/classes/DB_Util.html b/docs/classes/DB_Util.html deleted file mode 100644 index 89b80a6..0000000 --- a/docs/classes/DB_Util.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - -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/DB_tabs.html b/docs/classes/DB_tabs.html deleted file mode 100644 index 87eed7f..0000000 --- a/docs/classes/DB_tabs.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - -OpenSQLManager » \DB_tabs - - - - - - - - - -
    -
    -OpenSQLManager
    -
    -
    Back to top  
    -
    -
    - -
    -
    -
    - -
    - -
    -
    -
    -

    Tabbed Container for database properties

    -
    -

    - - - - - - - - - -
    packageOpenSQLManager
    subpackageWidgets
    -

    - Methods

    -
    -

    Create the object

    -
    __construct() 
    -
    -

    -
    -
    -

    Add a new tab with the provided label

    -
    add_tab(string $label, \GObject $widget) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $label

    -string -
    -
    -

    $widget

    -\GObject -
    -
    -
    -
    -

    Create tabs for database aspects

    -
    get_db_tabs(\Query_Builder $conn) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $conn

    -\Query_Builder -
    -
    -
    -
    -

    Return the db tabs object if it exists, or create and return

    -
    get_instance() : \DB_tabs
    -
    -
    -

    -

    Returns

    -
    \DB_tabs
    -
    -
    -
    -

    Remove current tabs

    -
    reset(string $conn_name) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $conn_name

    -string -
    -
    -
    -
    -

    Create popup window with table data

    -
    show_table_data(\GTKTreeView $view, array $path, \GtkTreeviewColumn $col, \Query_Builder $conn) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $view

    -\GTKTreeView -
    -
    -

    $path

    -array -
    -
    -

    $col

    -\GtkTreeviewColumn -
    -
    -

    $conn

    -\Query_Builder -
    -
    -
    -
    -

    Add a multidimensional array to a tab

    -
    _add_row_tab(object $conn, string $tab_name, string $method) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $conn

    -object -
    -
    -

    $tab_name

    -string -
    -
    -

    $method

    -string -
    -
    -
    -
    -

    Simplify adding tabs to the Notebook object

    -
    _add_tab(object $conn, string $tab_name, string $col_name, string $method, array $events) : void
    -
    -
    -

    -

    Parameters

    -
    -

    $conn

    -object -
    -
    -

    $tab_name

    -string -
    -
    -

    $col_name

    -string -
    -
    -

    $method

    -string -
    -
    -

    $events

    -array -
    -
    -
    -
    -

    Returns cached database data for the tab and connection specified

    -
    _get_db_info(string $conn_name, string $tab_name) : mixed
    -
    -
    -

    -

    Parameters

    -
    -

    $conn_name

    -string -
    -
    -

    $tab_name

    -string -
    -

    Returns

    -
    mixed
    -
    -
    -
    -

    Sets cached database data for the tab and connection specified

    -
    _set_db_info(string $conn_name, string $tab_name, mixed $data) 
    -
    -
    -

    -

    Parameters

    -
    -

    $conn_name

    -string -
    -
    -

    $tab_name

    -string -
    -
    -

    $data

    -mixed -
    -
    -
    -

    - Properties

    - 
    -

    Db Data cache

    -
    $data : array
    -
    -

    -
    - 
    -

    Current Tab Widget object

    -
    $instance : \DB_Tabs
    -
    -

    -
    -
    -
    -
    -
    -
    -
    - - diff --git a/docs/classes/Data_Grid.html b/docs/classes/Data_Grid.html index 08b9686..70483a0 100644 --- a/docs/classes/Data_Grid.html +++ b/docs/classes/Data_Grid.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -181,7 +178,7 @@
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/classes/Edit_DB.html b/docs/classes/Edit_DB.html index 59c0138..a708f02 100644 --- a/docs/classes/Edit_DB.html +++ b/docs/classes/Edit_DB.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -99,7 +96,7 @@
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/classes/Edit_Table.html b/docs/classes/Edit_Table.html index ca3ee4a..24063e9 100644 --- a/docs/classes/Edit_Table.html +++ b/docs/classes/Edit_Table.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -115,7 +112,7 @@
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/classes/Firebird.html b/docs/classes/Firebird.html deleted file mode 100644 index d0740bc..0000000 --- a/docs/classes/Firebird.html +++ /dev/null @@ -1,876 +0,0 @@ - - - - - -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
    -
    -
    -
    -

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

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

    - 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 deleted file mode 100644 index 77eda46..0000000 --- a/docs/classes/Firebird_Result.html +++ /dev/null @@ -1,512 +0,0 @@ - - - - - -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 deleted file mode 100644 index 06720d9..0000000 --- a/docs/classes/Firebird_SQL.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -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 deleted file mode 100644 index 091c30f..0000000 --- a/docs/classes/Firebird_Util.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - -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/Main.html b/docs/classes/Main.html index c2cf454..6ff62dd 100644 --- a/docs/classes/Main.html +++ b/docs/classes/Main.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -136,7 +133,7 @@ Create menus, hboxes, vboxs and other widgets  

    Reference to settings instance

    -
    $settings : \Settings
    +
    $settings : \Settings

    @@ -147,7 +144,7 @@ Create menus, hboxes, vboxs and other widgets
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/classes/MySQL.html b/docs/classes/MySQL.html deleted file mode 100644 index 92e0d96..0000000 --- a/docs/classes/MySQL.html +++ /dev/null @@ -1,912 +0,0 @@ - - - - - -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()
    -
    -
    -
    -

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

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

    - 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 deleted file mode 100644 index 13b8695..0000000 --- a/docs/classes/MySQL_SQL.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - -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 deleted file mode 100644 index 24e8a56..0000000 --- a/docs/classes/MySQL_Util.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - -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 deleted file mode 100644 index 16c8cc4..0000000 --- a/docs/classes/ODBC.html +++ /dev/null @@ -1,914 +0,0 @@ - - - - - -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()
    -
    -
    -
    -

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

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

    - 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 deleted file mode 100644 index 61280fa..0000000 --- a/docs/classes/ODBC_SQL.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -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 deleted file mode 100644 index ac33dd6..0000000 --- a/docs/classes/ODBC_Util.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - -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/PgSQL.html b/docs/classes/PgSQL.html deleted file mode 100644 index f12db00..0000000 --- a/docs/classes/PgSQL.html +++ /dev/null @@ -1,914 +0,0 @@ - - - - - -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()
    -
    -
    -
    -

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

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

    - 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 deleted file mode 100644 index 49e5a03..0000000 --- a/docs/classes/PgSQL_SQL.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -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 deleted file mode 100644 index 1b05f41..0000000 --- a/docs/classes/PgSQL_Util.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - -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 deleted file mode 100644 index 06036ee..0000000 --- a/docs/classes/Query_Builder.html +++ /dev/null @@ -1,1230 +0,0 @@ - - - - - -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 deleted file mode 100644 index 8120e78..0000000 --- a/docs/classes/SQLite.html +++ /dev/null @@ -1,929 +0,0 @@ - - - - - -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()
    -
    -
    -
    -

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

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

    - 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 deleted file mode 100644 index 2e45858..0000000 --- a/docs/classes/SQLite_SQL.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -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 deleted file mode 100644 index b6e316a..0000000 --- a/docs/classes/SQLite_Util.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - -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/classes/Settings.html b/docs/classes/Settings.html deleted file mode 100644 index b43b817..0000000 --- a/docs/classes/Settings.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - -OpenSQLManager » \Settings - - - - - - - - - -
    -
    -OpenSQLManager
    -
    -
    Back to top  
    -
    -
    - -
    -
    -
    - -
    - -
    -
    -
    -

    Class for manipulating datbase connections, and miscellaneous settings

    -
    -

    - - - - - - - - - -
    packageQuery
    subpackageHelper Classes
    -

    - Methods

    -
    -

    Output the settings on destruct

    -
    __destruct() 
    -
    -

    -
    -
    -

    Magic method to simplify isset checking for config options

    -
    __get(string $key) : mixed
    -
    -
    -

    -

    Parameters

    -
    -

    $key

    -string -
    -

    Returns

    -
    mixed
    -
    -
    -
    -

    Magic method to simplify setting config options

    -
    __set(string $key, $val) 
    -
    -
    -

    -

    Parameters

    -
    -

    $key

    -string -
    -
    -

    $val

    -

    mixed

    -
    -
    -
    -

    Add a database connection

    -
    add_db(string $name, array $params) 
    -
    -
    -

    -

    Parameters

    -
    -

    $name

    -string -
    -
    -

    $params

    -array -
    -
    -
    -
    -

    Edit a database connection

    -
    edit_db(string $name, array $params) 
    -
    -
    -

    -

    Parameters

    -
    -

    $name

    -string -
    -
    -

    $params

    -array -
    -
    -
    -
    -

    Retreive a specific database connection

    -
    get_db(string $name) : object
    -
    -
    -

    -

    Parameters

    -
    -

    $name

    -string -
    -

    Returns

    -
    object
    -
    -
    -
    -

    Retreive all db connections

    -
    get_dbs() : array
    -
    -
    -

    -

    Returns

    -
    array
    -
    -
    -
    -

    Static method to retreive current instance -of the singleton

    -
    get_instance() : \Settings
    -
    -
    -

    -

    Returns

    -
    \Settings
    -
    -
    -
    -

    Remove a database connection

    -
    remove_db(string $name) 
    -
    -
    -

    -

    Parameters

    -
    -

    $name

    -string -
    -
    -
    -
    -

    Load the settings file - private so it can't be loaded -directly - the settings should be safe!

    -
    __construct() 
    -
    -

    -
    -

    - Properties

    - 
    -

    Settings object represented by the currently loaded JSON file

    -
    $current 
    -
    -

    -
    - 
    -

    Singleton instance

    -
    $instance 
    -
    -

    -
    -
    -
    -
    -
    -
    -
    - - diff --git a/docs/deprecated.html b/docs/deprecated.html index 22b8f6b..484eadb 100644 --- a/docs/deprecated.html +++ b/docs/deprecated.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -69,7 +66,7 @@
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/errors.html b/docs/errors.html index 516261b..fab720a 100644 --- a/docs/errors.html +++ b/docs/errors.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -79,35 +76,12 @@
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/graph_class.html b/docs/graph_class.html index e02babc..c77d03c 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -66,7 +63,7 @@
    + generated on 2012-05-15T12:45:09-04:00.
    diff --git a/docs/index.html b/docs/index.html index f79e972..f6e2ca2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -60,7 +57,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
    • @@ -84,7 +78,7 @@
    + generated on 2012-05-15T12:45:08-04:00.
    diff --git a/docs/markers.html b/docs/markers.html index b8c22b4..f5ab8bc 100644 --- a/docs/markers.html +++ b/docs/markers.html @@ -22,7 +22,6 @@
  • Packages
  •  Default
  •  OpenSQLManager
    • -
  •  Query
  •  Errors  0
  •  Markers  -
    • todo  - 6 -
    • +
  •  Deprecated elements  0
    • @@ -52,15 +49,7 @@ if Javascript is enabled.
    -
    +
    • Navigation
    • @@ -68,122 +57,18 @@
    • Markers
    +
    No markers have been found in this project.
    The following markers were found: -
    • todo  - 6 -
    -
    -
    -
    -

    -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_util.php1 -

    -
    - - - - - - - - - - -
    TypeLineDescription
    todo141Implement Backup function
    -
    -
    -

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

    -
    - - - - - - - - - - -
    TypeLineDescription
    todo57Implement
    -
    -
    -

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

    -
    - - - - - - - - - - -
    TypeLineDescription
    todo117Implement Backup structure function
    -
    +
      +
      + generated on 2012-05-15T12:45:09-04:00.
      diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html index 25b8b22..bcba857 100644 --- a/docs/namespaces/default.html +++ b/docs/namespaces/default.html @@ -22,7 +22,6 @@
    • Packages
    •  Default
    •  OpenSQLManager
      • -
    •  Query
    •  Errors  0
    •  Markers  -
      • todo  - 6 -
      • +
    •  Deprecated elements  0
      • @@ -123,39 +120,6 @@
      bool
      -
      -

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

      Bulk directory loading workaround for use with array_map and glob

      @@ -242,27 +206,6 @@ with array_map and glob
      « More »
      -
      -

      DB_PDO -

      -

      Base Database class

      -
      -« More » -
      -
      -

      DB_Reg -

      -

      Connection registry

      -
      -« More » -
      -
      -

      DB_SQL -

      -

      Abstract parent for database manipulation subclasses

      -
      -« More » -

      DB_Structure_Widget

      @@ -277,13 +220,6 @@ with array_map and glob
      « More »
      -
      -

      DB_Util -

      -

      Abstract class defining database / table creation methods

      -
      -« More » -

      DB_tabs

      @@ -312,35 +248,6 @@ with array_map and glob
      « 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 » -

      Main

      @@ -348,105 +255,6 @@ data-fetching 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 » -
      -
      -

      Settings -

      -

      Class for manipulating datbase connections, and miscellaneous settings

      -
      -« More » -

      Constants

       
      @@ -461,18 +269,6 @@ instantiates the specific db driver

      - 
      -

      Reference to root path

      -
      QBASE_PATH 
      -
      -

      -
      - 
      -

      Path to driver classes

      -
      QDRIVER_PATH 
      -
      -

      -
       

      SETTINGS_DIR

      SETTINGS_DIR 
      @@ -491,7 +287,7 @@ instantiates the specific db driver

      + generated on 2012-05-15T12:45:08-04:00.
      diff --git a/docs/packages/.html b/docs/packages/.html index 5b92a9b..040b473 100644 --- a/docs/packages/.html +++ b/docs/packages/.html @@ -22,7 +22,6 @@
    • Packages
    •  Default
    •  OpenSQLManager
      • -
    •  Query
    •  Errors  0
    •  Markers  -
      • todo  - 6 -
      • +
    •  Deprecated elements  0
      • @@ -69,7 +66,7 @@
      + generated on 2012-05-15T12:45:08-04:00.
      diff --git a/docs/packages/Default.html b/docs/packages/Default.html index 22035d8..80f848d 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -22,7 +22,6 @@
    • Packages
    •  Default
    •  OpenSQLManager
      • -
    •  Query
    •  Errors  0
    •  Markers  -
      • todo  - 6 -
      • +
    •  Deprecated elements  0
      • @@ -66,8 +63,6 @@ Constants
    • BASE_DIR
      BASE_DIR
    • PROGRAM_NAME
      PROGRAM_NAME
      • -
    • Reference to root path
      QBASE_PATH
      • -
    • Path to driver classes
      QDRIVER_PATH
    • SETTINGS_DIR
      SETTINGS_DIR
    • VERSION
      VERSION
      • @@ -94,18 +89,6 @@

      - 
      -

      Reference to root path

      -
      QBASE_PATH 
      -
      -

      -
      - 
      -

      Path to driver classes

      -
      QDRIVER_PATH 
      -
      -

      -
       

      SETTINGS_DIR

      SETTINGS_DIR 
      @@ -124,7 +107,7 @@
      + generated on 2012-05-15T12:45:08-04:00.
      diff --git a/docs/packages/OpenSQLManager.Widgets.html b/docs/packages/OpenSQLManager.Widgets.html index cbcbed0..597a18f 100644 --- a/docs/packages/OpenSQLManager.Widgets.html +++ b/docs/packages/OpenSQLManager.Widgets.html @@ -22,7 +22,6 @@
    • Packages
    •  Default
    •  OpenSQLManager
      • -
    •  Query
    •  Errors  0
    •  Markers  -
      • todo  - 6 -
      • +
    •  Deprecated elements  0
      • @@ -123,7 +120,7 @@
      + generated on 2012-05-15T12:45:08-04:00.
      diff --git a/docs/packages/OpenSQLManager.Windows.html b/docs/packages/OpenSQLManager.Windows.html index b163ade..ca56f9d 100644 --- a/docs/packages/OpenSQLManager.Windows.html +++ b/docs/packages/OpenSQLManager.Windows.html @@ -22,7 +22,6 @@
    • Packages
    •  Default
    •  OpenSQLManager
      • -
    •  Query
    •  Errors  0
    •  Markers  -
      • todo  - 6 -
      • +
    •  Deprecated elements  0
      • @@ -123,7 +120,7 @@
      + generated on 2012-05-15T12:45:08-04:00.
      diff --git a/docs/packages/OpenSQLManager.html b/docs/packages/OpenSQLManager.html index f017cd7..502a4d9 100644 --- a/docs/packages/OpenSQLManager.html +++ b/docs/packages/OpenSQLManager.html @@ -22,7 +22,6 @@
    • Packages
    •  Default
    •  OpenSQLManager
      • -
    •  Query
    •  Errors  0
    •  Markers  -
      • todo  - 6 -
      • +
    •  Deprecated elements  0
      • @@ -303,7 +300,7 @@ with array_map and glob
      + generated on 2012-05-15T12:45:08-04:00.
      diff --git a/docs/packages/Query.Drivers.html b/docs/packages/Query.Drivers.html deleted file mode 100644 index cc30c7d..0000000 --- a/docs/packages/Query.Drivers.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - -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.Helper Classes.html b/docs/packages/Query.Helper Classes.html deleted file mode 100644 index e4d8a3d..0000000 --- a/docs/packages/Query.Helper Classes.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - -OpenSQLManager » Query\Helper Classes - - - - - - - - - -
      -
      -OpenSQLManager
      -
      -
      Back to top  
      -
      -
      - -
      -
      -
      - -
      - -
      -
      - -
      -

      - Classes and interfaces

      -
      -

      DB_Reg -

      -

      Connection registry

      -
      -« More » -
      -
      -

      Settings -

      -

      Class for manipulating datbase connections, and miscellaneous settings

      -
      -« More » -
      -
      -
      -
      -
      -
      - - diff --git a/docs/packages/Query.Query.html b/docs/packages/Query.Query.html deleted file mode 100644 index be7848d..0000000 --- a/docs/packages/Query.Query.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - -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 deleted file mode 100644 index fd94cd0..0000000 --- a/docs/packages/Query.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - -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 -
      -
      -
      - -
      -

      - 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_Reg -

      -

      Connection registry

      -
      -« More » -
      -
      -

      Settings -

      -

      Class for manipulating datbase connections, and miscellaneous settings

      -
      -« 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 e2a3a53..9cb0d2b 100644 --- a/docs/structure.xml +++ b/docs/structure.xml @@ -101,5422 +101,6 @@ with array_map and glob]]> - - - - Free Query Builder / Database Abstraction Layer

      ]]>       - - - - -       - - DB_Reg - \DB_Reg - - - - Decouples the Settings class from the query builder -and organizes database connections

      ]]>       - - -       - - $instance - - - - - - - - get_db - function - - - - - string - - - object - - - - $key - - - - - - __construct - function - - - - - string - - - - $key - - - - - - get_connections - function - - - - - array - - - - - remove_db - function - - - - - string - - - void - - - - $key - - - - -       -       - - - - Free Query Builder / Database Abstraction Layer

      ]]>       - - - - - -       - - Settings - \Settings - - - - - - - - - $current - - - - - - - - $instance - - - - - - - - get_instance - function - - - - - \Settings - - - - - __construct - function - - - - - - - __destruct - function - - - - - - - __get - function - - - - - string - - - mixed - - - - $key - - - - - - __set - function - - - - - string - - - - - $key - - - - - $val - - - - - - add_db - function - - - - - string - - - array - - - - $name - - - - - $params - - - - - - edit_db - function - - - - - string - - - array - - - - $name - - - - - $params - - - - - - remove_db - function - - - - - string - - - - $name - - - - - - get_dbs - function - - - - - array - - - - - get_db - function - - - - - string - - - object - - - - $name - - - - - -       - - - - 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 - - - - - - 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

      ]]>       - - - - - -       - - Implement Backup function - - - 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 - - - - - -       @@ -7122,13 +1706,8 @@ Create menus, hboxes, vboxs and other widgets]]> - - - - - - todo + todo fixme diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml index 73a484f..e36b0e3 100644 --- a/phpdoc.dist.xml +++ b/phpdoc.dist.xml @@ -13,8 +13,8 @@ . tests - sys/db/tests + sys/db tests/* - sys/db/tests/* + sys/db/* \ No newline at end of file