From 555865bdb79fcaaf042ad43e45b3c9b0abbe02cc Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Fri, 31 Jul 2015 10:56:16 -0400 Subject: [PATCH] Update docs --- docs/classes/Query.Abstract_Driver.html | 469 ++++++++++------- .../classes/Query.Abstract_Query_Builder.html | 292 +++++------ docs/classes/Query.Abstract_SQL.html | 164 +++--- docs/classes/Query.Abstract_Util.html | 164 +++--- docs/classes/Query.BadDBDriverException.html | 164 +++--- docs/classes/Query.Connection_Manager.html | 442 ++++++++-------- docs/classes/Query.Driver_Interface.html | 186 +++---- .../Query.Drivers.Firebird.Driver.html | 495 +++++++++++------- .../Query.Drivers.Firebird.Result.html | 174 +++--- docs/classes/Query.Drivers.Firebird.SQL.html | 164 +++--- docs/classes/Query.Drivers.Firebird.Util.html | 164 +++--- docs/classes/Query.Drivers.Mysql.Driver.html | 487 ++++++++++------- docs/classes/Query.Drivers.Mysql.SQL.html | 164 +++--- docs/classes/Query.Drivers.Mysql.Util.html | 164 +++--- .../Query.Drivers.Pdo_firebird.Driver.html | 487 ++++++++++------- .../Query.Drivers.Pdo_firebird.SQL.html | 164 +++--- .../Query.Drivers.Pdo_firebird.Util.html | 164 +++--- docs/classes/Query.Drivers.Pgsql.Driver.html | 487 ++++++++++------- docs/classes/Query.Drivers.Pgsql.SQL.html | 172 +++--- docs/classes/Query.Drivers.Pgsql.Util.html | 164 +++--- docs/classes/Query.Drivers.Sqlite.Driver.html | 487 ++++++++++------- docs/classes/Query.Drivers.Sqlite.SQL.html | 164 +++--- docs/classes/Query.Drivers.Sqlite.Util.html | 164 +++--- docs/classes/Query.Query_Builder.html | 300 +++++------ .../Query.Query_Builder_Interface.html | 168 +++--- docs/classes/Query.Query_Parser.html | 248 ++++----- docs/classes/Query.SQL_Interface.html | 164 +++--- docs/files/autoload.php.html | 164 +++--- docs/files/autoload.php.txt | 7 +- docs/files/src.Query.Abstract_Driver.php.html | 164 +++--- .../src.Query.Abstract_Query_Builder.php.html | 164 +++--- docs/files/src.Query.Abstract_SQL.php.html | 164 +++--- docs/files/src.Query.Abstract_Util.php.html | 164 +++--- .../src.Query.BadDBDriverException.php.html | 164 +++--- .../src.Query.Connection_Manager.php.html | 164 +++--- .../files/src.Query.Driver_Interface.php.html | 164 +++--- ...src.Query.Drivers.Firebird.Driver.php.html | 164 +++--- ...src.Query.Drivers.Firebird.Result.php.html | 164 +++--- .../src.Query.Drivers.Firebird.SQL.php.html | 164 +++--- .../src.Query.Drivers.Firebird.Util.php.html | 164 +++--- .../src.Query.Drivers.Mysql.Driver.php.html | 164 +++--- .../src.Query.Drivers.Mysql.SQL.php.html | 164 +++--- .../src.Query.Drivers.Mysql.Util.php.html | 164 +++--- ...Query.Drivers.Pdo_firebird.Driver.php.html | 164 +++--- ...rc.Query.Drivers.Pdo_firebird.SQL.php.html | 164 +++--- ...c.Query.Drivers.Pdo_firebird.Util.php.html | 164 +++--- .../src.Query.Drivers.Pgsql.Driver.php.html | 164 +++--- .../src.Query.Drivers.Pgsql.SQL.php.html | 164 +++--- .../src.Query.Drivers.Pgsql.Util.php.html | 164 +++--- .../src.Query.Drivers.Sqlite.Driver.php.html | 164 +++--- .../src.Query.Drivers.Sqlite.SQL.php.html | 164 +++--- .../src.Query.Drivers.Sqlite.Util.php.html | 164 +++--- docs/files/src.Query.Query_Builder.php.html | 164 +++--- ...src.Query.Query_Builder_Interface.php.html | 164 +++--- docs/files/src.Query.Query_Parser.php.html | 164 +++--- docs/files/src.Query.SQL_Interface.php.html | 164 +++--- docs/files/src/Query/Abstract_Driver.php.txt | 50 +- .../src/Query/Abstract_Query_Builder.php.txt | 14 +- .../src/Query/Connection_Manager.php.txt | 32 +- docs/files/src/Query/Driver_Interface.php.txt | 13 +- .../src/Query/Drivers/Firebird/Driver.php.txt | 9 +- .../src/Query/Drivers/Firebird/Result.php.txt | 17 +- .../src/Query/Drivers/Firebird/Util.php.txt | 3 +- .../src/Query/Drivers/Mysql/Driver.php.txt | 1 + .../Query/Drivers/Pdo_firebird/Driver.php.txt | 2 +- .../Query/Drivers/Pdo_firebird/Util.php.txt | 1 - .../src/Query/Drivers/Pgsql/Driver.php.txt | 1 + .../files/src/Query/Drivers/Pgsql/SQL.php.txt | 1 - .../src/Query/Query_Builder_Interface.php.txt | 2 +- docs/files/src/Query/Query_Parser.php.txt | 4 +- docs/graphs/class.html | 2 +- docs/graphs/classes.svg | 404 +++++++------- docs/namespaces/Query.Drivers.Firebird.html | 172 +++--- docs/namespaces/Query.Drivers.Mysql.html | 172 +++--- .../Query.Drivers.Pdo_firebird.html | 172 +++--- docs/namespaces/Query.Drivers.Pgsql.html | 172 +++--- docs/namespaces/Query.Drivers.Sqlite.html | 164 +++--- docs/namespaces/Query.Drivers.html | 176 +++---- docs/namespaces/Query.html | 200 +++---- docs/namespaces/default.html | 164 +++--- docs/reports/deprecated.html | 2 +- docs/reports/errors.html | 2 +- docs/reports/markers.html | 10 +- src/Query/Abstract_Driver.php | 2 +- 84 files changed, 7178 insertions(+), 6411 deletions(-) diff --git a/docs/classes/Query.Abstract_Driver.html b/docs/classes/Query.Abstract_Driver.html index d9897de..b6fb3d0 100644 --- a/docs/classes/Query.Abstract_Driver.html +++ b/docs/classes/Query.Abstract_Driver.html @@ -139,98 +139,37 @@
- + \
-
+
- + Query
-
+
- + Drivers
-
+
- - Firebird -
-
-
- - - -
-
-
-
- -
-
-
- - Mysql -
-
-
- - - -
-
-
-
- -
-
-
- - Pgsql -
-
-
- - - -
-
-
-
- -
-
-
- + Sqlite
-
+
@@ -247,17 +186,78 @@
- - Pdo_firebird + + Firebird
-
+
+
+
+
+
+ +
+
+
+ + Mysql +
+
+
+ + + +
+
+
+
+ +
+
+
+ + Pdo_firebird +
+
+
+ + + +
+
+
+
+ +
+
+
+ + Pgsql +
+
+
+ + +
@@ -277,14 +277,14 @@
  • Query_Builder_Interface
  • Driver_Interface
  • SQL_Interface
    • -
  • Query_Builder
    • -
  • Query_Parser
    • -
  • BadDBDriverException
    • -
  • Connection_Manager
    • -
  • Abstract_Query_Builder
    • -
  • Abstract_Util
    • -
  • Abstract_Driver
    • +
  • Abstract_Util
  • Abstract_SQL
    • +
  • BadDBDriverException
    • +
  • Query_Builder
    • +
  • Abstract_Query_Builder
    • +
  • Abstract_Driver
    • +
  • Connection_Manager
    • +
  • Query_Parser
    • @@ -331,8 +331,11 @@
    __construct()
    __call()
    + get_last_query()
    + set_last_query()
    get_sql()
    get_util()
    + set_table_prefix()
    prepare_query()
    prepare_execute()
    affected_rows()
    @@ -359,9 +362,7 @@ truncate()
    - $util
    - $last_query
    - $table_prefix
    + No public properties found
    No constants found @@ -376,6 +377,9 @@ $statement
    $escape_char
    $sql
    + $util
    + $last_query
    + $table_prefix
    $has_truncate
    @@ -438,96 +442,6 @@
    -
    -
    - -
    -

    $util

    - 
    $util : \Query\Abstract_Util
    -

    Reference to util class

    - - -

    Type

    - \Query\Abstract_Util -
    -
    - -
    - -
    -
    - -
    -

    $last_query

    - 
    $last_query : string
    -

    Last query executed

    - - -

    Type

    - string -
    -
    - -
    - -
    -
    - -
    -

    $table_prefix

    - 
    $table_prefix : string
    -

    Prefix to apply to table names

    - - -

    Type

    - string -
    -
    - -
    -
    @@ -620,6 +534,96 @@
    + +
    +

    $util

    + 
    $util : \Query\Abstract_Util
    +

    Reference to util class

    + + +

    Type

    + \Query\Abstract_Util +
    +
    + +
    + +
    +
    + +
    +

    $last_query

    + 
    $last_query : string
    +

    Last query executed

    + + +

    Type

    + string +
    +
    + +
    + +
    +
    + +
    +

    $table_prefix

    + 
    $table_prefix : string
    +

    Prefix to apply to table names

    + + +

    Type

    + string +
    +
    + +
    + +
    +

    $has_truncate

    @@ -765,6 +769,78 @@
    + +
    +

    get_last_query()

    + + 
    get_last_query() : string
    +

    Get the last sql query exexcuted

    + + + + +

    Returns

    + string +
    +
    + +
    + +
    +
    + +
    +

    set_last_query()

    + + 
    set_last_query(string $query_string) : void
    +

    Set the last query sql

    + + +

    Parameters

    + + + + + + +
    string$query_string
    + + +
    +
    + +
    + +
    +

    get_sql()

    @@ -831,6 +907,45 @@
    + +
    +

    set_table_prefix()

    + + 
    set_table_prefix(string $prefix) : void
    +

    Set the common table name prefix

    + + +

    Parameters

    + + + + + + +
    string$prefix
    + + +
    +
    + +
    + +
    +

    prepare_query()

    @@ -1624,7 +1739,7 @@ the connection/database

    insert_batch()

    - 
    insert_batch(string $table, array $data) : array
    + 
    insert_batch(string $table, array $data) : null|\Query\array<string|array|\Query\null>

    Create sql for batch insert

    @@ -1644,7 +1759,7 @@ the connection/database

    Returns

    - array + null|\Query\array
    -
    -
    - -
    -

    $util

    - 
    $util : \Query\Driver\Abstract_Util
    -

    Alias to driver util class

    - - -

    Type

    - \Query\Driver\Abstract_Util -
    -
    - -
    - -
    -
    - -
    -

    $sql

    - 
    $sql : \Query\Driver\SQL_Interface
    -

    Alias to driver sql class

    - - -

    Type

    - \Query\Driver\SQL_Interface -
    -
    - -
    -
    @@ -1161,6 +1101,66 @@ array(

    +
    +
    + +
    +

    $util

    + 
    $util : \Query\Driver\Abstract_Util
    +

    Alias to driver util class

    + + +

    Type

    + \Query\Driver\Abstract_Util +
    +
    + +
    + +
    +
    + +
    +

    $sql

    + 
    $sql : \Query\Driver\SQL_Interface
    +

    Alias to driver sql class

    + + +

    Type

    + \Query\Driver\SQL_Interface +
    +
    + +
    +
    @@ -1796,7 +1796,7 @@ array(

    _compile()

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

    String together the sql statements for sending to the db

    @@ -1816,7 +1816,7 @@ array(

    Returns

    - \Query\$string + string
    -
    -
    - -
    -

    __construct()

    - - 
    __construct()
    -

    Private constructor to prevent multiple instances

    - - - - -
    -
    - -
    - -
    -
    - -
    -

    __clone()

    - - 
    __clone()
    -

    Private clone method to prevent cloning

    - - - - -
    -
    - -
    - -
    -
    - -
    -

    __wakeup()

    - - 
    __wakeup()
    -

    Make sure serialize/deserialize doesn't work

    - - - -

    Throws

    -
    -
    \DomainException
    -
    -
    - -
    -
    - -
    -
    -

    parse_params()

    +

    parse_params()

    parse_params(\stdClass $params) : array

    Parses params into a dsn and option array

    @@ -775,6 +762,45 @@ Query method

    +
    +
    + +
    +

    __construct()

    + + 
    __construct()
    +

    Private constructor to prevent multiple instances

    + + + + +
    +
    + +
    +
    @@ -871,7 +897,7 @@ Query method

    Documentation is powered by phpDocumentor and authored - on July 29th, 2015 at 16:44. + on July 31st, 2015 at 10:55.
    diff --git a/docs/classes/Query.Driver_Interface.html b/docs/classes/Query.Driver_Interface.html index ae2bee5..a861bfc 100644 --- a/docs/classes/Query.Driver_Interface.html +++ b/docs/classes/Query.Driver_Interface.html @@ -139,98 +139,37 @@
    - + \
    -
    +
    - + Query
    -
    +
    - + Drivers
    -
    +
    - - Firebird -
    -
    -
    - - - -
    -
    -
    -
    - -
    -
    -
    - - Mysql -
    -
    -
    - - - -
    -
    -
    -
    - -
    -
    -
    - - Pgsql -
    -
    -
    - - - -
    -
    -
    -
    - -
    -
    -
    - + Sqlite
    -
    +
    @@ -247,17 +186,78 @@
    - - Pdo_firebird + + Firebird
    -
    +
    +
    +
    +
    +
    + +
    +
    +
    + + Mysql +
    +
    +
    + + + +
    +
    +
    +
    + +
    +
    +
    + + Pdo_firebird +
    +
    +
    + + + +
    +
    +
    +
    + +
    +
    +
    + + Pgsql +
    +
    +
    + + +
    @@ -277,14 +277,14 @@
  • Query_Builder_Interface
  • Driver_Interface
  • SQL_Interface
    • -
  • Query_Builder
    • -
  • Query_Parser
    • -
  • BadDBDriverException
    • -
  • Connection_Manager
    • -
  • Abstract_Query_Builder
    • -
  • Abstract_Util
    • -
  • Abstract_Driver
    • +
  • Abstract_Util
  • Abstract_SQL
    • +
  • BadDBDriverException
    • +
  • Query_Builder
    • +
  • Abstract_Query_Builder
    • +
  • Abstract_Driver
    • +
  • Connection_Manager
    • +
  • Query_Parser
    • @@ -416,7 +416,7 @@

    __construct()

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

    Constructor/Connection method

    @@ -1236,14 +1236,14 @@ the connection/database

    quote_ident()

    - 
    quote_ident(mixed $ident) : string
    + 
    quote_ident(string|array $ident) : string|array

    Surrounds the string with the databases identifier escape characters

    Parameters

    - + @@ -1251,7 +1251,7 @@ the connection/database

    Returns

    - string + string|array
    mixedstring|array $ident
    - + @@ -1292,7 +1292,7 @@ the connection/database

    Returns

    - string + string|array
    stringstring|array $table
    - - - - -
    - todo - -
    - -
    - -
    -
    - -
    -

    $last_query

    - 
    $last_query : string
    -

    Last query executed

    - - -

    Type

    - string -
    -
    - -
    - -
    -
    - -
    -

    $table_prefix

    - 
    $table_prefix : string
    -

    Prefix to apply to table names

    - - -

    Type

    - string -
    -
    - -
    -
    @@ -803,6 +711,102 @@ the last query executed

    +
    +
    + +
    +

    $util

    + 
    $util : \Query\Abstract_Util
    +

    Reference to util class

    + + +

    Type

    + \Query\Abstract_Util +
    +
    + +
    + +
    +
    + +
    +

    $last_query

    + 
    $last_query : string
    +

    Last query executed

    + + +

    Type

    + string +
    +
    + +
    + +
    +
    + +
    +

    $table_prefix

    + 
    $table_prefix : string
    +

    Prefix to apply to table names

    + + +

    Type

    + string +
    +
    + +
    +
    @@ -1100,7 +1104,7 @@ the last query executed

    query()

    - 
    query(string $sql) : \Query\Drivers\Firebird\Firebird_Result
    + 
    query(string $sql) : \Query\Drivers\Firebird\Result

    Wrapper public function to better match PDO

    @@ -1120,7 +1124,7 @@ the last query executed

    Returns

    - \Query\Drivers\Firebird\Firebird_Result + \Query\Drivers\Firebird\Result