From 6a3db6581a4bc87d4b2c70b21c30f9a6a6bad636 Mon Sep 17 00:00:00 2001 From: Timothy J Warren Date: Fri, 26 Jan 2018 09:16:13 -0500 Subject: [PATCH] Update README and documentation --- README.md | 13 +- .../classes/Query_ConnectionManager.html | 22 +- .../Query_ConnectionManager/connect.html | 18 +- .../Query_ConnectionManager/parseParams.html | 11 +- .../classes/Query_Drivers_AbstractDriver.html | 40 +- .../Query_Drivers_AbstractDriver/_quote.html | 2 +- .../truncate.html | 2 +- .../updateBatch.html | 29 +- .../classes/Query_Drivers_AbstractUtil.html | 20 +- .../classes/Query_Drivers_Mysql_Driver.html | 18 +- .../classes/Query_Drivers_Pgsql_Driver.html | 18 +- .../classes/Query_Drivers_Sqlite_Driver.html | 18 +- .../classes/Query_QueryBuilder.html | 22 +- .../classes/Query_QueryBuilder/delete.html | 2 +- .../Query_QueryBuilder/getCompiledDelete.html | 2 +- .../Query_QueryBuilder/getCompiledInsert.html | 2 +- .../Query_QueryBuilder/getCompiledSelect.html | 2 +- .../Query_QueryBuilder/getCompiledUpdate.html | 2 +- .../classes/Query_QueryBuilder/replace.html | 2 +- .../Query_QueryBuilder/resetQuery.html | 2 +- .../Query_QueryBuilder/updateBatch.html | 8 +- apiDocumentation/classes/Query_State.html | 10 + .../Query_Drivers_DriverInterface.html | 7 +- .../__construct.html | 2 +- .../affectedRows.html | 2 +- .../driverQuery.html | 2 +- .../getColumns.html | 2 +- .../Query_Drivers_DriverInterface/getDbs.html | 2 +- .../Query_Drivers_DriverInterface/getFks.html | 2 +- .../getFunctions.html | 2 +- .../getIndexes.html | 2 +- .../getProcedures.html | 2 +- .../getSequences.html | 2 +- .../Query_Drivers_DriverInterface/getSql.html | 2 +- .../getSystemTables.html | 2 +- .../getTables.html | 2 +- .../getTriggers.html | 2 +- .../getTypes.html | 2 +- .../getUtil.html | 2 +- .../getViews.html | 2 +- .../insertBatch.html | 2 +- .../numRows.html | 2 +- .../prefixTable.html | 2 +- .../prepareExecute.html | 2 +- .../prepareQuery.html | 2 +- .../Query_Drivers_DriverInterface/quote.html | 104 ++++++ .../quoteIdent.html | 2 +- .../quoteTable.html | 2 +- .../setLastQuery.html | 2 +- .../updateBatch.html | 13 +- .../Query_QueryBuilderInterface.html | 2 +- .../updateBatch.html | 12 +- .../source/BadDBDriverException.php.html | 2 +- .../source/ConnectionManager.php.html | 52 +-- .../source/Drivers/AbstractDriver.php.html | 210 +++++++---- .../source/Drivers/AbstractSQL.php.html | 2 +- .../source/Drivers/AbstractUtil.php.html | 4 +- .../source/Drivers/DriverInterface.php.html | 2 +- .../source/Drivers/Mysql/Driver.php.html | 2 +- .../source/Drivers/Mysql/SQL.php.html | 2 +- .../source/Drivers/Mysql/Util.php.html | 2 +- .../source/Drivers/Pgsql/Driver.php.html | 2 +- .../source/Drivers/Pgsql/SQL.php.html | 2 +- .../source/Drivers/Pgsql/Util.php.html | 2 +- .../source/Drivers/SQLInterface.php.html | 2 +- .../source/Drivers/Sqlite/Driver.php.html | 2 +- .../source/Drivers/Sqlite/SQL.php.html | 2 +- .../source/Drivers/Sqlite/Util.php.html | 2 +- apiDocumentation/source/QueryBuilder.php.html | 348 +++++++++--------- .../source/QueryBuilderInterface.php.html | 2 +- apiDocumentation/source/QueryParser.php.html | 2 +- apiDocumentation/source/State.php.html | 4 +- apiDocumentation/source/common.php.html | 6 +- 73 files changed, 613 insertions(+), 494 deletions(-) create mode 100644 apiDocumentation/interfaces/Query_Drivers_DriverInterface/quote.html diff --git a/README.md b/README.md index b5df5fa..1c75bc4 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ A query builder/database abstraction layer, using prepared statements for securi ## Requirements * PDO extensions for the databases you wish to use (unless it's Firebird, in which case, the interbase extension is required) -* Supported version of PHP (Older versions may work, but are not supported) - +* PHP 7.1 or later + ## Databases Supported * MySQL @@ -78,8 +78,13 @@ Query('old')->query($sql); ``` ### Running Queries -Query uses the same interface as CodeIgniter's [Query Builder](http://www.codeigniter.com/user_guide/database/query_builder.html) class. However, it does not implement the `update_batch` or caching methods. For specific query builder methods, see the [class documentation](https://gitdev.timshomepage.net/Query/docs/classes/Query_QueryBuilder.html#methods). -Underscored methods are also aliased to camel case methods. +Query is based on CodeIgniter's [Query Builder](http://www.codeigniter.com/user_guide/database/query_builder.html) class. +However, it has camelCased method names, and does not implement the caching methods. +For specific query builder methods, see the [class documentation](https://gitdev.timshomepage.net/Query/apiDocumentation/classes/Query_QueryBuilder.html#methods). + +Other database methods not directly involved in building queries, are also available from the query builder object. +The methods available depend on the database, but common methods are documented +[here](https://gitdev.timshomepage.net/Query/apiDocumentation/classes/Query_Drivers_AbstractDriver.html#methods). #### You can also run queries manually. diff --git a/apiDocumentation/classes/Query_ConnectionManager.html b/apiDocumentation/classes/Query_ConnectionManager.html index 20da68e..ba75c15 100644 --- a/apiDocumentation/classes/Query_ConnectionManager.html +++ b/apiDocumentation/classes/Query_ConnectionManager.html @@ -118,6 +118,16 @@

History

diff --git a/apiDocumentation/classes/Query_ConnectionManager/connect.html b/apiDocumentation/classes/Query_ConnectionManager/connect.html index 1c646fd..85e3e56 100644 --- a/apiDocumentation/classes/Query_ConnectionManager/connect.html +++ b/apiDocumentation/classes/Query_ConnectionManager/connect.html @@ -62,7 +62,10 @@ Return
  • - Source + Throws +
    • +
  • + Source
    • @@ -73,7 +76,7 @@ @@ -76,7 +76,7 @@ diff --git a/apiDocumentation/classes/Query_Drivers_AbstractDriver/truncate.html b/apiDocumentation/classes/Query_Drivers_AbstractDriver/truncate.html index b735847..d36af60 100644 --- a/apiDocumentation/classes/Query_Drivers_AbstractDriver/truncate.html +++ b/apiDocumentation/classes/Query_Drivers_AbstractDriver/truncate.html @@ -62,7 +62,7 @@ Return
  • - Source + Source
    • diff --git a/apiDocumentation/classes/Query_Drivers_AbstractDriver/updateBatch.html b/apiDocumentation/classes/Query_Drivers_AbstractDriver/updateBatch.html index c43a805..aadd533 100644 --- a/apiDocumentation/classes/Query_Drivers_AbstractDriver/updateBatch.html +++ b/apiDocumentation/classes/Query_Drivers_AbstractDriver/updateBatch.html @@ -64,9 +64,6 @@
  • Interface
    • -
  • - Tasks -
  • Source
    • @@ -81,7 +78,7 @@
    public function updateBatch(string $table, - array|object + array $data, string $where ) @@ -92,20 +89,20 @@
    $table — string
    -
    +
    The table to update
    $data — - object
    -



    + array +
    an array of update values
    $where — string
    -
    +
    The where key

    Returns

    -
    int|null
    -

    +
    array<string
    +
    array,int>

    Defined by Interface

    @@ -114,18 +111,6 @@ DriverInterface

    - - - - - - - - - - - -
    LineTask
    571implement