From 2c358533a835fdd6a1a172fabbd0481a814337a3 Mon Sep 17 00:00:00 2001 From: Timothy J Warren Date: Fri, 26 Jan 2018 16:27:34 -0500 Subject: [PATCH] Update documentation --- README.md | 10 +- apiDocumentation/classes.html | 66 ++- .../classes/BadFunctionCallException.html | 124 ++++++ .../BadFunctionCallException/__clone.html | 84 ++++ .../BadFunctionCallException/__toString.html | 84 ++++ .../BadFunctionCallException/getCode.html | 84 ++++ .../BadFunctionCallException/getFile.html | 84 ++++ .../BadFunctionCallException/getLine.html | 84 ++++ .../BadFunctionCallException/getMessage.html | 84 ++++ .../BadFunctionCallException/getPrevious.html | 84 ++++ .../BadFunctionCallException/getTrace.html | 84 ++++ .../getTraceAsString.html | 84 ++++ .../classes/BadMethodCallException.html | 124 ++++++ .../BadMethodCallException/__clone.html | 84 ++++ .../BadMethodCallException/__toString.html | 84 ++++ .../BadMethodCallException/getCode.html | 84 ++++ .../BadMethodCallException/getFile.html | 84 ++++ .../BadMethodCallException/getLine.html | 84 ++++ .../BadMethodCallException/getMessage.html | 84 ++++ .../BadMethodCallException/getPrevious.html | 84 ++++ .../BadMethodCallException/getTrace.html | 84 ++++ .../getTraceAsString.html | 84 ++++ .../classes/Query_ConnectionManager.html | 22 +- .../Query_ConnectionManager/__clone.html | 2 +- .../Query_ConnectionManager/__sleep.html | 2 +- .../Query_ConnectionManager/__wakeup.html | 2 +- .../Query_ConnectionManager/connect.html | 4 +- .../getConnection.html | 4 +- .../Query_ConnectionManager/getInstance.html | 2 +- .../Query_ConnectionManager/parseParams.html | 4 +- .../classes/Query_Drivers_AbstractDriver.html | 26 +- .../classes/Query_Drivers_Mysql_SQL.html | 20 +- .../Query_Drivers_Mysql_SQL/columnList.html | 2 +- .../Query_Drivers_Mysql_SQL/fkList.html | 2 +- .../Query_Drivers_Mysql_SQL/functionList.html | 2 +- .../Query_Drivers_Mysql_SQL/indexList.html | 2 +- .../procedureList.html | 2 +- .../Query_Drivers_Mysql_SQL/sequenceList.html | 2 +- .../systemTableList.html | 2 +- .../Query_Drivers_Mysql_SQL/tableList.html | 2 +- .../Query_Drivers_Mysql_SQL/triggerList.html | 2 +- .../Query_Drivers_Mysql_SQL/typeList.html | 2 +- .../Query_Drivers_Mysql_SQL/viewList.html | 2 +- .../classes/Query_Drivers_Sqlite_SQL.html | 28 +- .../Query_Drivers_Sqlite_SQL/columnList.html | 2 +- .../Query_Drivers_Sqlite_SQL/dbList.html | 2 +- .../Query_Drivers_Sqlite_SQL/explain.html | 2 +- .../Query_Drivers_Sqlite_SQL/fkList.html | 2 +- .../functionList.html | 14 +- .../Query_Drivers_Sqlite_SQL/indexList.html | 2 +- .../procedureList.html | 14 +- .../Query_Drivers_Sqlite_SQL/random.html | 2 +- .../sequenceList.html | 2 +- .../systemTableList.html | 2 +- .../Query_Drivers_Sqlite_SQL/tableList.html | 2 +- .../Query_Drivers_Sqlite_SQL/triggerList.html | 2 +- .../Query_Drivers_Sqlite_SQL/typeList.html | 2 +- .../Query_Drivers_Sqlite_SQL/viewList.html | 2 +- .../classes/Query_Drivers_Sqlite_Util.html | 22 +- .../Query_Drivers_Sqlite_Util/backupData.html | 2 +- .../backupStructure.html | 2 +- ...Query_Exception_BadDBDriverException.html} | 18 +- ...eption_NonExistentConnectionException.html | 348 ++++++++++++++++ ...ery_Exception_NotImplementedException.html | 384 ++++++++++++++++++ .../classes/Query_QueryBuilder.html | 32 +- .../Query_Drivers_DriverInterface.html | 6 +- .../__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 | 2 +- .../quoteIdent.html | 2 +- .../quoteTable.html | 2 +- .../setLastQuery.html | 2 +- .../updateBatch.html | 2 +- .../Query_QueryBuilderInterface.html | 14 +- apiDocumentation/namespaces.html | 12 +- .../source/BadDBDriverException.php.html | 3 - .../source/ConnectionManager.php.html | 68 ++-- .../source/Drivers/AbstractDriver.php.html | 32 +- .../source/Drivers/DriverInterface.php.html | 2 +- .../source/Drivers/Mysql/SQL.php.html | 28 +- .../source/Drivers/Sqlite/SQL.php.html | 36 +- .../source/Drivers/Sqlite/Util.php.html | 68 ++-- .../Exception/BadDBDriverException.php.html | 3 + .../NonExistentConnectionException.php.html | 3 + .../NotImplementedException.php.html | 3 + apiDocumentation/source/QueryBuilder.php.html | 12 +- .../source/QueryBuilderInterface.php.html | 2 +- apiDocumentation/source/common.php.html | 16 +- 108 files changed, 2894 insertions(+), 302 deletions(-) create mode 100644 apiDocumentation/classes/BadFunctionCallException.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/__clone.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/__toString.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/getCode.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/getFile.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/getLine.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/getMessage.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/getPrevious.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/getTrace.html create mode 100644 apiDocumentation/classes/BadFunctionCallException/getTraceAsString.html create mode 100644 apiDocumentation/classes/BadMethodCallException.html create mode 100644 apiDocumentation/classes/BadMethodCallException/__clone.html create mode 100644 apiDocumentation/classes/BadMethodCallException/__toString.html create mode 100644 apiDocumentation/classes/BadMethodCallException/getCode.html create mode 100644 apiDocumentation/classes/BadMethodCallException/getFile.html create mode 100644 apiDocumentation/classes/BadMethodCallException/getLine.html create mode 100644 apiDocumentation/classes/BadMethodCallException/getMessage.html create mode 100644 apiDocumentation/classes/BadMethodCallException/getPrevious.html create mode 100644 apiDocumentation/classes/BadMethodCallException/getTrace.html create mode 100644 apiDocumentation/classes/BadMethodCallException/getTraceAsString.html rename apiDocumentation/classes/{Query_BadDBDriverException.html => Query_Exception_BadDBDriverException.html} (95%) create mode 100644 apiDocumentation/classes/Query_Exception_NonExistentConnectionException.html create mode 100644 apiDocumentation/classes/Query_Exception_NotImplementedException.html delete mode 100644 apiDocumentation/source/BadDBDriverException.php.html create mode 100644 apiDocumentation/source/Exception/BadDBDriverException.php.html create mode 100644 apiDocumentation/source/Exception/NonExistentConnectionException.php.html create mode 100644 apiDocumentation/source/Exception/NotImplementedException.php.html diff --git a/README.md b/README.md index 1c75bc4..cd276f0 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Create a connection array or object similar to this: 'mysql', // mysql, pgsql, firebird, sqlite + 'type' => 'mysql', // mysql, pgsql, sqlite 'host' => 'localhost', // address or socket 'user' => 'root', 'pass' => '', @@ -43,7 +43,7 @@ $params = array( // SQLite 'file' => '/path/to/db/file', - // Optional paramaters + // Optional parameters 'prefix' => 'tbl_', // Database table prefix 'alias' => 'old' // Connection name for the Query function ); @@ -119,8 +119,10 @@ ORDER BY "val" DESC LIMIT 3 OFFSET 1 ``` - -To retrieve the results of a query, use the PDO method [fetch](http://php.net/manual/en/pdostatement.fetch.php) and/or [fetchAll](http://php.net/manual/en/pdostatement.fetchall.php). +The query execution methods `get`, `getWhere`, `insert`, + `insertBatch`,`update`, and `delete` return a native [PDOStatemnt](http://php.net/manual/en/class.pdostatement.php) object. +To retrieve the results of a query, use the PDOStatement method [fetch](http://php.net/manual/en/pdostatement.fetch.php) and/or +[fetchAll](http://php.net/manual/en/pdostatement.fetchall.php). ```php + + + BadFunctionCallException + + + No description available + + EMPTY + + + + + BadMethodCallException + + + No description available + + EMPTY + + Exception @@ -95,14 +115,6 @@ - - - BadDBDriverException - - Generic exception for bad drivers - EMPTY - - ConnectionManager @@ -290,6 +302,44 @@ +
+

\Query\Exception

+ + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription +
+ BadDBDriverException + Generic exception for bad driversEMPTY +
+ NonExistentConnectionException + Exception for missing database connectionEMPTY +
+ NotImplementedException + Exception for non-implemented methodEMPTY +
+