diff --git a/docs/classes.svg b/docs/classes.svg index a63e19d..b75ecf8 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -4,281 +4,318 @@ - - + + G - + cluster_Global - - - - - + + + + + -\ +\ cluster_\Query - - - - - + + + + + -Query +Query cluster_\Query\Driver - - - - - - - - -Driver + + + + + + + + +Driver + +cluster_\Query\Table + + + + + + + + +Table + + +\\Query\\Driver\\SQLite + +SQLite + + +\\Query\\Driver\\Abstract_Driver + +«abstract» +Abstract_Driver + + +\\Query\\Driver\\SQLite->\\Query\\Driver\\Abstract_Driver + + + + +\\Query\\Driver\\SQLite_SQL + +SQLite_SQL -\\Query\\Driver\\Abstract_SQL - -«abstract» -Abstract_SQL +\\Query\\Driver\\Abstract_SQL + +«abstract» +Abstract_SQL - -\\Query\\Driver\\SQL_Interface - -SQL_Interface + +\\Query\\Driver\\SQLite_SQL->\\Query\\Driver\\Abstract_SQL + + - -\\Query\\Driver\\Abstract_SQL->\\Query\\Driver\\SQL_Interface - - + +\\Query\\Driver\\SQLite_Util + +SQLite_Util + + +\\Query\\Driver\\Abstract_Util + +«abstract» +Abstract_Util + + +\\Query\\Driver\\SQLite_Util->\\Query\\Driver\\Abstract_Util + + + + +\\Query\\Driver\\Firebird_SQL + +Firebird_SQL + + +\\Query\\Driver\\Firebird_SQL->\\Query\\Driver\\Abstract_SQL + + + + +\\Query\\Driver\\Firebird_Util + +Firebird_Util + + +\\Query\\Driver\\Firebird_Util->\\Query\\Driver\\Abstract_Util + + + + +\\Query\\Driver\\Firebird + +Firebird + + +\\Query\\Driver\\Firebird->\\Query\\Driver\\Abstract_Driver + + -\\Query\\Driver\\Firebird_Result - -Firebird_Result +\\Query\\Driver\\Firebird_Result + +Firebird_Result -\\PDOStatement +\\PDOStatement \PDOStatement -\\Query\\Driver\\Firebird_Result->\\PDOStatement - - +\\Query\\Driver\\Firebird_Result->\\PDOStatement + + - -\\Query\\Driver\\Firebird_Util - -Firebird_Util + +\\Query\\Driver\\PgSQL + +PgSQL - -\\Query\\Driver\\Abstract_Util - -«abstract» -Abstract_Util + +\\Query\\Driver\\PgSQL->\\Query\\Driver\\Abstract_Driver + + - -\\Query\\Driver\\Firebird_Util->\\Query\\Driver\\Abstract_Util - - + +\\Query\\Driver\\PgSQL_Util + +PgSQL_Util - -\\Query\\Driver\\Firebird - -Firebird + +\\Query\\Driver\\PgSQL_Util->\\Query\\Driver\\Abstract_Util + + - -\\Query\\Driver\\Abstract_Driver - -«abstract» -Abstract_Driver + +\\Query\\Driver\\PgSQL_SQL + +PgSQL_SQL - -\\Query\\Driver\\Firebird->\\Query\\Driver\\Abstract_Driver - - + +\\Query\\Driver\\PgSQL_SQL->\\Query\\Driver\\Abstract_SQL + + + + +\\Query\\Driver\\MySQL_SQL + +MySQL_SQL + + +\\Query\\Driver\\MySQL_SQL->\\Query\\Driver\\Abstract_SQL + + -\\Query\\Driver\\MySQL_Util - -MySQL_Util +\\Query\\Driver\\MySQL_Util + +MySQL_Util -\\Query\\Driver\\MySQL_Util->\\Query\\Driver\\Abstract_Util - - +\\Query\\Driver\\MySQL_Util->\\Query\\Driver\\Abstract_Util + + + + +\\Query\\Driver\\MySQL + +MySQL + + +\\Query\\Driver\\MySQL->\\Query\\Driver\\Abstract_Driver + + + + +\\Query\\Driver\\SQL_Interface + +SQL_Interface + + +\\Query\\Driver\\Abstract_SQL->\\Query\\Driver\\SQL_Interface + + -\\Query\\Driver\\Driver_Interface - -Driver_Interface +\\Query\\Driver\\Driver_Interface + +Driver_Interface -\\Query\\Driver\\Abstract_Driver->\\Query\\Driver\\Driver_Interface - - +\\Query\\Driver\\Abstract_Driver->\\Query\\Driver\\Driver_Interface + + -\\PDO +\\PDO \PDO -\\Query\\Driver\\Abstract_Driver->\\PDO - - +\\Query\\Driver\\Abstract_Driver->\\PDO + + - -\\Query\\Driver\\SQLite_Util - -SQLite_Util + +\\Query\\Table\\Abstract_Table + +«abstract» +Abstract_Table - -\\Query\\Driver\\SQLite_Util->\\Query\\Driver\\Abstract_Util - - + +\\Query\\Table\\Table_Index + +Table_Index - -\\Query\\Driver\\PgSQL_Util - -PgSQL_Util + +\\Query\\Table\\Table_Index->\\Query\\Table\\Abstract_Table + + - -\\Query\\Driver\\PgSQL_Util->\\Query\\Driver\\Abstract_Util - - + +\\Query\\Table\\Table_Foreign_Key + +Table_Foreign_Key - -\\Query\\Driver\\PgSQL_SQL - -PgSQL_SQL + +\\Query\\Table\\Table_Foreign_Key->\\Query\\Table\\Abstract_Table + + - -\\Query\\Driver\\PgSQL_SQL->\\Query\\Driver\\Abstract_SQL - - + +\\Query\\Table\\Table_Column + +Table_Column - -\\Query\\Driver\\MySQL_SQL - -MySQL_SQL + +\\Query\\Table\\Table_Column->\\Query\\Table\\Abstract_Table + + - -\\Query\\Driver\\MySQL_SQL->\\Query\\Driver\\Abstract_SQL - - - - -\\Query\\Driver\\Firebird_SQL - -Firebird_SQL - - -\\Query\\Driver\\Firebird_SQL->\\Query\\Driver\\Abstract_SQL - - - - -\\Query\\Driver\\SQLite - -SQLite - - -\\Query\\Driver\\SQLite->\\Query\\Driver\\Abstract_Driver - - - - -\\Query\\Driver\\SQLite_SQL - -SQLite_SQL - - -\\Query\\Driver\\SQLite_SQL->\\Query\\Driver\\Abstract_SQL - - - - -\\Query\\Driver\\PgSQL - -PgSQL - - -\\Query\\Driver\\PgSQL->\\Query\\Driver\\Abstract_Driver - - - - -\\Query\\Driver\\MySQL - -MySQL - - -\\Query\\Driver\\MySQL->\\Query\\Driver\\Abstract_Driver - - - - -\\Query\\Table_Builder + +\\Query\\Table\\Table_Builder Table_Builder - -\\Query\\Table_Builder_Interface - -Table_Builder_Interface - - -\\Query\\Table_Builder->\\Query\\Table_Builder_Interface - - - -\\Query\\Query_Parser +\\Query\\Query_Parser Query_Parser - -\\Query\\Query_Builder - -Query_Builder - - -\\Query\\Query_Builder_Interface - -Query_Builder_Interface - - -\\Query\\Query_Builder->\\Query\\Query_Builder_Interface - - - -\\Query\\BadDBDriverException - -BadDBDriverException +\\Query\\BadDBDriverException + +BadDBDriverException -\\InvalidArgumentException +\\InvalidArgumentException \InvalidArgumentException -\\Query\\BadDBDriverException->\\InvalidArgumentException - - +\\Query\\BadDBDriverException->\\InvalidArgumentException + + -\\Query\\Connection_Manager - -Connection_Manager +\\Query\\Connection_Manager + +Connection_Manager + + +\\Query\\Query_Builder + +Query_Builder + + +\\Query\\Query_Builder_Interface + +Query_Builder_Interface + + +\\Query\\Query_Builder->\\Query\\Query_Builder_Interface + + diff --git a/docs/classes/Query.BadDBDriverException.html b/docs/classes/Query.BadDBDriverException.html index 3de3332..1cdff8f 100644 --- a/docs/classes/Query.BadDBDriverException.html +++ b/docs/classes/Query.BadDBDriverException.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -94,7 +94,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Connection_Manager.html b/docs/classes/Query.Connection_Manager.html index 32967c2..61a4332 100644 --- a/docs/classes/Query.Connection_Manager.html +++ b/docs/classes/Query.Connection_Manager.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -279,7 +279,7 @@ Query method

    Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.Abstract_Driver.html b/docs/classes/Query.Driver.Abstract_Driver.html index 571be96..5aba655 100644 --- a/docs/classes/Query.Driver.Abstract_Driver.html +++ b/docs/classes/Query.Driver.Abstract_Driver.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -70,7 +70,9 @@
  • Method to simplify retreiving db results for meta-data queries
    driver_query()
  • Retrieve column information for the current database table
    get_columns()
  • Return list of dbs for the current connection, if possible
    get_dbs()
    • +
  • Retrieve foreign keys for the table
    get_fks()
  • Return list of function for the current database
    get_functions()
    • +
  • Retrieve indexes for the table
    get_indexes()
  • Return list of stored procedures for the current database
    get_procedures()
  • Return schemas for databases that list them
    get_schemas()
  • Return list of sequences for the current database, if they exist
    get_sequences()
    • @@ -83,6 +85,7 @@ the connection/database
    get_system_tables()
  • Return list of views for the current database
    get_views()
  • Create sql for batch insert
    insert_batch()
  • Return the number of rows returned for a SELECT query
    num_rows()
    • +
  • Prefixes a table if it is not already prefixed
    prefix_table()
  • Create and execute a prepared statement with the provided parameters
    prepare_execute()
  • Simplifies prepared statements for database queries
    prepare_query()
  • Surrounds the string with the databases identifier escape characters
    quote_ident()
    • @@ -98,6 +101,7 @@ the connection/database
    get_system_tables()
    @@ -233,6 +237,21 @@ the connection/database
    get_system_tables()
    array
    +
    +

    Retrieve foreign keys for the table

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

    Parameters

    +
    +

    $table

    +string +
    +

    Returns

    +
    array
    +
    +

    Return list of function for the current database

    get_functions() : array
    @@ -243,6 +262,21 @@ the connection/database
    get_system_tables()
    array
    +
    +

    Retrieve indexes for the table

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

    Parameters

    +
    +

    $table

    +string +
    +

    Returns

    +
    array
    +
    +

    Return list of stored procedures for the current database

    get_procedures() : array
    @@ -357,9 +391,24 @@ the connection/database
    int
    +
    +

    Prefixes a table if it is not already prefixed

    +
    prefix_table(string $table) : string
    +
    +
    +
    +

    Parameters

    +
    +

    $table

    +string +
    +

    Returns

    +
    string
    +
    +

    Create and execute a prepared statement with the provided parameters

    -
    prepare_execute(string $sql, array $params) : \Query\Driver\PDOStatement
    +
    prepare_execute(string $sql, array $params) : \PDOStatement
    @@ -373,12 +422,12 @@ the connection/database array

    Returns

    -
    \Query\Driver\PDOStatement
    +
    \PDOStatement

    Simplifies prepared statements for database queries

    -
    prepare_query(string $sql, array $data) : \Query\Driver\PDOStatement
    +
    prepare_query(string $sql, array $data) : \PDOStatement
    @@ -393,12 +442,12 @@ the connection/database

    Exceptions

    - +
    \Query\Driver\InvalidArgumentException\InvalidArgumentException

    Returns

    -\Query\Driver\PDOStatementPDOStatement / FALSE
    +\PDOStatement| FALSE
    @@ -481,6 +530,16 @@ the connection/database
    + 
    +

    Reference to table_builder class

    +
    $table : \Query\Table\Table_Builder
    +
    +

    Default

    +
    +
    +
    +
    +
     

    Prefix to apply to table names

    $table_prefix : string
    @@ -529,7 +588,7 @@ the connection/database Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.Abstract_SQL.html b/docs/classes/Query.Driver.Abstract_SQL.html index 0ddaa88..ac4e217 100644 --- a/docs/classes/Query.Driver.Abstract_SQL.html +++ b/docs/classes/Query.Driver.Abstract_SQL.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -125,7 +125,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.Abstract_Util.html b/docs/classes/Query.Driver.Abstract_Util.html index ad43809..6ce2535 100644 --- a/docs/classes/Query.Driver.Abstract_Util.html +++ b/docs/classes/Query.Driver.Abstract_Util.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -70,6 +70,10 @@
  • Return an SQL file with the database table structure
    backup_structure()
  • Convienience public function to generate sql for creating a db table
    create_table()
  • Drop the selected table
    delete_table()
    • +
  • quote_ident() + 
    quote_ident()
    • +
  • quote_table() + 
    quote_table()
  • @@ -172,7 +176,7 @@

    Convienience public function to generate sql for creating a db table

    -
    create_table(string $name, array $fields, array $constraints = array(), array $indexes = array()) : string
    +
    create_table(string $name, array $fields, array $constraints = array()) : string
    @@ -189,10 +193,6 @@

    $constraints

    array
    -
    -

    $indexes

    -array -

    Returns

    string
    @@ -212,6 +212,48 @@
    string
    +
    +

    quote_ident() +

    +
    quote_ident() : 
    +
    +
    +
    + + + + + + + + + +
    magic
    method
    +

    Returns

    +
    +
    +
    +
    +

    quote_table() +

    +
    quote_table() : 
    +
    +
    +
    + + + + + + + + + +
    magic
    method
    +

    Returns

    +
    +
    +

     Properties

     
    @@ -232,7 +274,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.Driver_Interface.html b/docs/classes/Query.Driver.Driver_Interface.html index be76435..a6bbd89 100644 --- a/docs/classes/Query.Driver.Driver_Interface.html +++ b/docs/classes/Query.Driver.Driver_Interface.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -238,7 +238,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.Firebird.html b/docs/classes/Query.Driver.Firebird.html index 985186e..e3e49c1 100644 --- a/docs/classes/Query.Driver.Firebird.html +++ b/docs/classes/Query.Driver.Firebird.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -65,12 +65,14 @@  Methods @@ -86,6 +86,7 @@ the query
    __construct()
  • » Private
    • @@ -66,7 +66,11 @@
  • Return sql to list columns of the specified table
    column_list()
  • Returns sql to list other databases
    db_list()
  • Get the query plan for the sql query
    explain()
    • +
  • Get the list of foreign keys for the current +table
    fk_list()
  • Return sql to list functions
    function_list()
    • +
  • Get the list of indexes for the current table
    index_list()
  • Limit clause
    limit()
  • Return sql to list stored procedures
    procedure_list()
  • Random ordering keyword
    random()
    • @@ -148,6 +152,23 @@
    string
    +
    +

    Get the list of foreign keys for the current +table

    +
    fk_list($table) : string
    +
    +
    +
    + + + +
    parmastring $table
    +

    Parameters

    +

    $table

    +

    Returns

    +
    string
    +
    +

    Return sql to list functions

    function_list() : string
    @@ -158,6 +179,21 @@
    string
    +
    +

    Get the list of indexes for the current table

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

    Parameters

    +
    +

    $table

    +string +
    +

    Returns

    +
    array
    +
    +

    Limit clause

    limit(string $sql, int $limit, int $offset = FALSE) : string
    @@ -269,7 +305,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.Firebird_Util.html b/docs/classes/Query.Driver.Firebird_Util.html index a7cb72c..5ce811d 100644 --- a/docs/classes/Query.Driver.Firebird_Util.html +++ b/docs/classes/Query.Driver.Firebird_Util.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -65,6 +65,10 @@ @@ -164,7 +164,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.MySQL_SQL.html b/docs/classes/Query.Driver.MySQL_SQL.html index 338bde4..a2e819e 100644 --- a/docs/classes/Query.Driver.MySQL_SQL.html +++ b/docs/classes/Query.Driver.MySQL_SQL.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -66,7 +66,11 @@
  • SQL to show infromation about columns in a table
    column_list()
  • Returns sql to list other databases
    db_list()
  • Get the query plan for the sql query
    explain()
    • +
  • Get the list of foreign keys for the current +table
    fk_list()
  • Return sql to list functions
    function_list()
    • +
  • Get the list of indexes for the current table
    index_list()
  • Limit clause
    limit()
  • Return sql to list stored procedures
    procedure_list()
  • Random ordering keyword
    random()
    • @@ -148,6 +152,23 @@
    string
    +
    +

    Get the list of foreign keys for the current +table

    +
    fk_list($table) : string
    +
    +
    +
    + + + +
    parmastring $table
    +

    Parameters

    +

    $table

    +

    Returns

    +
    string
    +
    +

    Return sql to list functions

    function_list() : string
    @@ -158,6 +179,21 @@
    string
    +
    +

    Get the list of indexes for the current table

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

    Parameters

    +
    +

    $table

    +string +
    +

    Returns

    +
    array
    +
    +

    Limit clause

    limit(string $sql, int $limit, int $offset = FALSE) : string
    @@ -274,7 +310,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.MySQL_Util.html b/docs/classes/Query.Driver.MySQL_Util.html index 0ff07b1..5635c3d 100644 --- a/docs/classes/Query.Driver.MySQL_Util.html +++ b/docs/classes/Query.Driver.MySQL_Util.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -65,8 +65,6 @@ @@ -154,7 +154,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.PgSQL_SQL.html b/docs/classes/Query.Driver.PgSQL_SQL.html index 48d6f86..df2c9fe 100644 --- a/docs/classes/Query.Driver.PgSQL_SQL.html +++ b/docs/classes/Query.Driver.PgSQL_SQL.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -66,7 +66,11 @@
  • Return sql to list columns of the specified table
    column_list()
  • Returns sql to list other databases
    db_list()
  • Get the query plan for the sql query
    explain()
    • +
  • Get the list of foreign keys for the current +table
    fk_list()
  • Return sql to list functions
    function_list()
    • +
  • Get the list of indexes for the current table
    index_list()
  • Return sql to list stored procedures
    procedure_list()
  • Random ordering keyword
    random()
  • Return sql to list sequences
    sequence_list()
    • @@ -147,6 +151,23 @@
    string
    +
    +

    Get the list of foreign keys for the current +table

    +
    fk_list($table) : string
    +
    +
    +
    + + + +
    parmastring $table
    +

    Parameters

    +

    $table

    +

    Returns

    +
    string
    +
    +

    Return sql to list functions

    function_list() : NULL
    @@ -157,6 +178,21 @@
    NULL
    +
    +

    Get the list of indexes for the current table

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

    Parameters

    +
    +

    $table

    +string +
    +

    Returns

    +
    array
    +
    +

    Return sql to list stored procedures

    procedure_list() : string
    @@ -245,7 +281,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.PgSQL_Util.html b/docs/classes/Query.Driver.PgSQL_Util.html index 9fbdaf8..57e6349 100644 --- a/docs/classes/Query.Driver.PgSQL_Util.html +++ b/docs/classes/Query.Driver.PgSQL_Util.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -176,7 +176,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.SQL_Interface.html b/docs/classes/Query.Driver.SQL_Interface.html index d80f259..127b2f8 100644 --- a/docs/classes/Query.Driver.SQL_Interface.html +++ b/docs/classes/Query.Driver.SQL_Interface.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -68,7 +68,11 @@ specified table">Get information about the columns in specified table
    column_list()
  • Returns sql to list other databases
    db_list()
  • Modify the query to get the query plan
    explain()
    • +
  • Get the list of foreign keys for the current +table
    fk_list()
  • Return sql to list functions
    function_list()
    • +
  • Get the list of indexes for the current table
    index_list()
  • Get database specific sql for limit clause
    limit()
  • Return sql to list stored procedures
    procedure_list()
  • Get the sql for random ordering
    random()
    • @@ -151,6 +155,23 @@ specified table
    string
    +
    +

    Get the list of foreign keys for the current +table

    +
    fk_list($table) : array
    +
    +
    +
    + + + +
    parmastring $table
    +

    Parameters

    +

    $table

    +

    Returns

    +
    array
    +
    +

    Return sql to list functions

    function_list() : NULL
    @@ -161,6 +182,21 @@ specified table
    NULL
    +
    +

    Get the list of indexes for the current table

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

    Parameters

    +
    +

    $table

    +string +
    +

    Returns

    +
    array
    +
    +

    Get database specific sql for limit clause

    limit(string $sql, int $limit, int $offset = FALSE) : string
    @@ -282,7 +318,7 @@ specified table Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.SQLite.html b/docs/classes/Query.Driver.SQLite.html index 6ecdc2c..a207b4d 100644 --- a/docs/classes/Query.Driver.SQLite.html +++ b/docs/classes/Query.Driver.SQLite.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -160,6 +160,10 @@
    + + + +
    codeCoverageIgnore

    Parameters

    $table

    @@ -206,7 +210,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.SQLite_SQL.html b/docs/classes/Query.Driver.SQLite_SQL.html index cdf315b..b2eb7f5 100644 --- a/docs/classes/Query.Driver.SQLite_SQL.html +++ b/docs/classes/Query.Driver.SQLite_SQL.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -66,7 +66,11 @@
  • SQL to show infromation about columns in a table
    column_list()
  • Returns sql to list other databases
    db_list()
  • Get the query plan for the sql query
    explain()
    • +
  • Get the list of foreign keys for the current +table
    fk_list()
  • Return sql to list functions
    function_list()
    • +
  • Get the list of indexes for the current table
    index_list()
  • Return sql to list stored procedures
    procedure_list()
  • Random ordering keyword
    random()
  • Return sql to list sequences
    sequence_list()
    • @@ -147,6 +151,23 @@
    string
    +
    +

    Get the list of foreign keys for the current +table

    +
    fk_list($table) : string
    +
    +
    +
    + + + +
    parmastring $table
    +

    Parameters

    +

    $table

    +

    Returns

    +
    string
    +
    +

    Return sql to list functions

    function_list() : NULL
    @@ -157,6 +178,21 @@
    NULL
    +
    +

    Get the list of indexes for the current table

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

    Parameters

    +
    +

    $table

    +string +
    +

    Returns

    +
    array
    +
    +

    Return sql to list stored procedures

    procedure_list() : NULL
    @@ -245,7 +281,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Driver.SQLite_Util.html b/docs/classes/Query.Driver.SQLite_Util.html index 8434d2d..e1f9df8 100644 --- a/docs/classes/Query.Driver.SQLite_Util.html +++ b/docs/classes/Query.Driver.SQLite_Util.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -65,8 +65,6 @@ @@ -1288,7 +1288,7 @@ passed array with key / value pairs  

    The current database driver

    -
    $db : \Query\Driver_Interface
    +
    $db : \Query\Driver\Driver_Interface

    Default

    @@ -1500,7 +1500,7 @@ array( Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Query_Builder_Interface.html b/docs/classes/Query.Query_Builder_Interface.html index 26b0987..aa6d7c1 100644 --- a/docs/classes/Query.Query_Builder_Interface.html +++ b/docs/classes/Query.Query_Builder_Interface.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -430,7 +430,7 @@ execute current compiled query

    Creates and executes a batch insertion query

    -
    insert_batch(string $table, array $data = array()) : \Query\PDOStatement
    +
    insert_batch(string $table, array $data = array()) : \PDOStatement | null
    @@ -444,7 +444,9 @@ execute current compiled query array

    Returns

    -
    \Query\PDOStatement
    +
    +\PDOStatementnull +
    @@ -904,7 +906,7 @@ passed array with key / value pairs Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Query_Parser.html b/docs/classes/Query.Query_Parser.html index 7446ac4..bd36f17 100644 --- a/docs/classes/Query.Query_Parser.html +++ b/docs/classes/Query.Query_Parser.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -208,7 +208,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/classes/Query.Table.Abstract_Table.html b/docs/classes/Query.Table.Abstract_Table.html new file mode 100644 index 0000000..e0abdb4 --- /dev/null +++ b/docs/classes/Query.Table.Abstract_Table.html @@ -0,0 +1,176 @@ + + + + + +Query » \Query\Table\Abstract_Table + + + + + + + + + +
    +
    +Query
    +
    +
    Back to top  
    +
    +
    + +
    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +

    Base class for table builder component classes`

    +
    +
    +

    + Methods

    +
    +

    Getters

    +
    __get(mixed $name) : mixed
    +
    +
    +
    +

    Parameters

    +
    +

    $name

    +mixed +
    +

    Returns

    +
    mixed
    +
    +
    +
    +

    Setters

    +
    __set(mixed $name, mixed $val) : \Query\Table_Column
    +
    +
    +
    +

    Parameters

    +
    +

    $name

    +mixed +
    +
    +

    $val

    +mixed +
    +

    Returns

    +
    \Query\Table_Column
    +
    +
    +
    +

    String representation of the column/index

    +
    __toString() 
    +
    +
    +
    +
    +

    Set options for the current column

    +
    set_options(array $options) 
    +
    +
    +
    +

    Parameters

    +
    +

    $options

    +array

    return \Query\Table_Column

    +
    +
    +

    + Properties

    + 
    +

    Valid options for the current class

    +
    $valid_options : array
    +
    +

    Default

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + + diff --git a/docs/classes/Query.Table_Builder.html b/docs/classes/Query.Table.Table_Builder.html similarity index 77% rename from docs/classes/Query.Table_Builder.html rename to docs/classes/Query.Table.Table_Builder.html index 5ddce7d..a36e894 100644 --- a/docs/classes/Query.Table_Builder.html +++ b/docs/classes/Query.Table.Table_Builder.html @@ -3,7 +3,7 @@ -Query » \Query\Table_Builder +Query » \Query\Table\Table_Builder @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -65,8 +65,8 @@  Methods @@ -116,20 +118,26 @@
  • » Private
    • -
    -
    diff --git a/docs/classes/Query.Table.Table_Foreign_Key.html b/docs/classes/Query.Table.Table_Foreign_Key.html new file mode 100644 index 0000000..cef541e --- /dev/null +++ b/docs/classes/Query.Table.Table_Foreign_Key.html @@ -0,0 +1,125 @@ + + + + + +Query » \Query\Table\Table_Foreign_Key + + + + + + + + + +
    +
    +Query
    +
    +
    Back to top  
    +
    +
    + +
    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +

    Class representing a foreign key

    +
    +
    +

    + Methods

    +
    +

    String representation of the foreign key

    +
    __toString() 
    +
    +
    +
    +

    + Properties

    + 
    +

    Valid options for a foreign key

    +
    $valid_options : \Query\Table\type
    +
    +

    Default

    +
    array('delete', 'update', 'constraint')
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + + diff --git a/docs/classes/Query.Table_Builder_Interface.html b/docs/classes/Query.Table.Table_Index.html similarity index 69% rename from docs/classes/Query.Table_Builder_Interface.html rename to docs/classes/Query.Table.Table_Index.html index 51ef9a4..9f58eb2 100644 --- a/docs/classes/Query.Table_Builder_Interface.html +++ b/docs/classes/Query.Table.Table_Index.html @@ -3,7 +3,7 @@ -Query » \Query\Table_Builder_Interface +Query » \Query\Table\Table_Index @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -60,57 +60,56 @@ -
    -
    diff --git a/docs/deprecated.html b/docs/deprecated.html index 5803f07..1bf8653 100644 --- a/docs/deprecated.html +++ b/docs/deprecated.html @@ -38,7 +38,7 @@
  •  Markers 
  •  Deprecated elements  - 2
    • + 1 @@ -53,8 +53,7 @@
    -

    -drivers/mysql/mysql_util.php1 -

    -
    - - - - - - - - - - -
    TypeLineDescription
    deprecated43
    -

    -drivers/sqlite/sqlite_util.php1 +

    +drivers/firebird/firebird_util.php1

    @@ -101,7 +85,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor 2.2.0 and
    - generated on 2014-04-03T14:45:59-04:00.
    + generated on 2014-04-09T11:31:52-04:00.
    diff --git a/docs/errors.html b/docs/errors.html index a93998b..bcec3b9 100644 --- a/docs/errors.html +++ b/docs/errors.html @@ -38,7 +38,7 @@
  •  Markers 
    •  Deprecated elements  - 2
      • + 1 @@ -92,13 +92,16 @@
      +
      +
      +
      + generated on 2014-04-09T11:31:52-04:00.
      diff --git a/docs/graph_class.html b/docs/graph_class.html index 7cb6bab..92feb6a 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -38,7 +38,7 @@
    •  Markers 
      •  Deprecated elements  - 2
        • + 1 @@ -66,7 +66,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
        Documentation is powered by phpDocumentor 2.2.0 and
        - generated on 2014-04-03T14:45:59-04:00.
        + generated on 2014-04-09T11:31:52-04:00.
        diff --git a/docs/markers.html b/docs/markers.html index ecfbc52..51c8b1f 100644 --- a/docs/markers.html +++ b/docs/markers.html @@ -38,7 +38,7 @@
      •  Markers 
        •  Deprecated elements  - 2
          • + 1 @@ -53,7 +53,6 @@
          @@ -63,25 +62,7 @@
        • Markers
          • -
          -
          -

          -drivers/firebird/firebird_util.php1 -

          -
          - - - - - - - - - - -
          TypeLineDescription
          todo36Implement Backup structure function
          -
          -
          +

          drivers/pgsql/pgsql_util.php1

          @@ -97,15 +78,14 @@ Implement Backup function
          -
          -
          +
          + generated on 2014-04-09T11:31:52-04:00.
          diff --git a/docs/namespaces/Query.Driver.html b/docs/namespaces/Query.Driver.html index 3812d1f..62d3a68 100644 --- a/docs/namespaces/Query.Driver.html +++ b/docs/namespaces/Query.Driver.html @@ -38,7 +38,7 @@
        •  Markers 
        •  Deprecated elements  - 2
          • + 1 @@ -210,7 +210,7 @@ data-fetching methods

          Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
          Documentation is powered by phpDocumentor 2.2.0 and
          - generated on 2014-04-03T14:45:59-04:00.
          + generated on 2014-04-09T11:31:52-04:00.
          diff --git a/docs/namespaces/Query.Table.html b/docs/namespaces/Query.Table.html new file mode 100644 index 0000000..379ab88 --- /dev/null +++ b/docs/namespaces/Query.Table.html @@ -0,0 +1,124 @@ + + + + + +Query » Query\Table + + + + + + + + + +
          +
          +Query
          +
          +
          Back to top  
          +
          +
          + +
          +
          +
          + +
          +
            +
          • + Namespaces
            • +
          • +Table
              +
              • +
            +
            +
            + +
            +

            + Classes and interfaces

            +
            +

            Abstract_Table +

            +

            Base class for table builder component classes`

            +
            +« More » +
            +
            +

            Table_Builder +

            +

            Abstract class defining database / table creation methods

            +
            +« More » +
            +
            +

            Table_Column +

            +

            Class representing a column when creating a table

            +
            +« More » +
            +
            +

            Table_Foreign_Key +

            +

            Class representing a foreign key

            +
            +« More » +
            +
            +

            Table_Index +

            +

            Class representing indicies when creating a table

            +
            +« More » +
            +
            +
            +
            +
            +
            + + diff --git a/docs/namespaces/Query.html b/docs/namespaces/Query.html index c32062a..b9839d9 100644 --- a/docs/namespaces/Query.html +++ b/docs/namespaces/Query.html @@ -38,7 +38,7 @@
          •  Markers 
          •  Deprecated elements  - 2
            • + 1 @@ -59,9 +59,14 @@
          • Namespaces
          • -Query
          • Functions
            • @@ -95,13 +100,6 @@ with array_map and glob
            do_include
            « More » -
            -

            Table_Builder_Interface -

            -

            Abstract class defining database / table creation methods

            -
            -« More » -

            BadDBDriverException

            @@ -132,13 +130,6 @@ instantiates the specific db driver

            « More »
            -
            -

            Table_Builder -

            -

            Abstract class defining database / table creation methods

            -
            -« More » -
            @@ -82,7 +82,7 @@ with array_map and glob
            do_include
            Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
            Documentation is powered by phpDocumentor 2.2.0 and
            - generated on 2014-04-03T14:45:59-04:00.
            + generated on 2014-04-09T11:31:52-04:00.
            diff --git a/docs/packages/Default.html b/docs/packages/Default.html index 7e778b9..12ecc17 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -38,7 +38,7 @@
          •  Markers 
          •  Deprecated elements  - 2
            • + 1 @@ -69,7 +69,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
            Documentation is powered by phpDocumentor 2.2.0 and
            - generated on 2014-04-03T14:45:59-04:00.
            + generated on 2014-04-09T11:31:52-04:00.
            diff --git a/docs/packages/Query.Core.html b/docs/packages/Query.Core.html index b25c2c3..a446993 100644 --- a/docs/packages/Query.Core.html +++ b/docs/packages/Query.Core.html @@ -38,7 +38,7 @@
          •  Markers 
          •  Deprecated elements  - 2
            • + 1 @@ -158,7 +158,7 @@ Query method

            Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
            Documentation is powered by phpDocumentor 2.2.0 and
            - generated on 2014-04-03T14:45:59-04:00.
            + generated on 2014-04-09T11:31:52-04:00.
            diff --git a/docs/packages/Query.Drivers.html b/docs/packages/Query.Drivers.html index ecfc691..ac028d5 100644 --- a/docs/packages/Query.Drivers.html +++ b/docs/packages/Query.Drivers.html @@ -38,7 +38,7 @@
          •  Markers 
          •  Deprecated elements  - 2
            • + 1 @@ -63,26 +63,26 @@
          • Interfaces
            • -
          • SQL_Interface
          • Driver_Interface
            • +
          • SQL_Interface
          • Classes
            • -
          • Abstract_SQL
            • -
          • Firebird_Result
            • +
          • SQLite
            • +
          • SQLite_SQL
            • +
          • SQLite_Util
            • +
          • Firebird_SQL
          • Firebird_Util
          • Firebird
            • -
          • MySQL_Util
            • -
          • Abstract_Driver
            • -
          • SQLite_Util
            • +
          • Firebird_Result
            • +
          • PgSQL
          • PgSQL_Util
          • PgSQL_SQL
          • MySQL_SQL
            • -
          • Firebird_SQL
            • -
          • SQLite
            • -
          • SQLite_SQL
            • -
          • PgSQL
            • +
          • MySQL_Util
          • MySQL
            • +
          • Abstract_SQL
            • +
          • Abstract_Driver
          • Abstract_Util
            • @@ -230,7 +230,7 @@ data-fetching methods

            Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
            Documentation is powered by phpDocumentor 2.2.0 and
            - generated on 2014-04-03T14:45:59-04:00.
            + generated on 2014-04-09T11:31:52-04:00.
            diff --git a/docs/packages/Query.Query_Builder.html b/docs/packages/Query.Query_Builder.html index a6d9fa1..08027bf 100644 --- a/docs/packages/Query.Query_Builder.html +++ b/docs/packages/Query.Query_Builder.html @@ -38,7 +38,7 @@
          •  Markers 
          •  Deprecated elements  - 2
            • + 1 @@ -110,7 +110,7 @@ instantiates the specific db driver

            Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
            Documentation is powered by phpDocumentor 2.2.0 and
            - generated on 2014-04-03T14:45:59-04:00.
            + generated on 2014-04-09T11:31:52-04:00.
            diff --git a/docs/packages/Query.Table_Builder.html b/docs/packages/Query.Table_Builder.html index bb187a6..14b2b77 100644 --- a/docs/packages/Query.Table_Builder.html +++ b/docs/packages/Query.Table_Builder.html @@ -38,7 +38,7 @@
          •  Markers 
          •  Deprecated elements  - 2
            • + 1 @@ -62,9 +62,6 @@ Table_Builder
          • - Interfaces
            • -
          • Table_Builder_Interface
            • -
          • Classes
          • Table_Builder
            • @@ -79,19 +76,12 @@

            Classes and interfaces

            -
            -

            Table_Builder_Interface -

            -

            Abstract class defining database / table creation methods

            -
            -« More » -
            -

            Table_Builder +

            Table_Builder

            Abstract class defining database / table creation methods

            -« More » +« More »
            @@ -100,7 +90,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
            Documentation is powered by phpDocumentor 2.2.0 and
            - generated on 2014-04-03T14:45:59-04:00.
            + generated on 2014-04-09T11:31:52-04:00.
            diff --git a/docs/packages/Query.html b/docs/packages/Query.html index b3169cc..7eaa651 100644 --- a/docs/packages/Query.html +++ b/docs/packages/Query.html @@ -38,7 +38,7 @@
          •  Markers 
          •  Deprecated elements  - 2
            • + 1 @@ -82,6 +82,12 @@ with array_map and glob">Bulk directory loading workaround for use with array_map and glob
            do_include
          • Multibyte-safe trim function
            mb_trim
            • +
          • + Classes
            • +
          • Abstract_Table
            • +
          • Table_Index
            • +
          • Table_Foreign_Key
            • +
          • Table_Column
            • @@ -93,7 +99,7 @@ with array_map and glob
            do_include
            Functions

            Connection function

            -
            Query(string|object|array $params = '') : \Query_Builder
            +
            Query(string|object|array $params = '') : \Query\Query_Builder | null
            @@ -103,7 +109,9 @@ with array_map and glob
            do_include
            stringobjectarray

            Returns

            -
            \Query_Builder
            +
            +\Query\Query_Buildernull +
            @@ -154,6 +162,36 @@ with array_map and glob
            string
            +

            + Classes and interfaces

            +
            +

            Abstract_Table +

            +

            Base class for table builder component classes`

            +
            +« More » +
            +
            +

            Table_Column +

            +

            Class representing a column when creating a table

            +
            +« More » +
            +
            +

            Table_Foreign_Key +

            +

            Class representing a foreign key

            +
            +« More » +
            +
            +

            Table_Index +

            +

            Class representing indicies when creating a table

            +
            +« More » +