From 4eb234db7044799d4eab49af1be5d3448b3ddc35 Mon Sep 17 00:00:00 2001 From: Timothy J Warren Date: Thu, 23 Apr 2020 18:21:35 -0400 Subject: [PATCH] Update API docs --- apiDocumentation/classes.html | 16 ++ .../classes/Query_ConnectionManager.html | 79 ++++++++ .../Query_ConnectionManager/connect.html | 69 +++++++ .../Query_ConnectionManager/parseParams.html | 20 ++ .../classes/Query_Drivers_AbstractDriver.html | 35 ++-- .../Query_Drivers_AbstractDriver/__call.html | 2 +- .../__construct.html | 2 +- .../Query_Drivers_AbstractDriver/_quote.html | 22 ++- .../affectedRows.html | 2 +- .../driverQuery.html | 22 ++- .../getColumns.html | 2 +- .../Query_Drivers_AbstractDriver/getDbs.html | 2 +- .../Query_Drivers_AbstractDriver/getFks.html | 2 +- .../getFunctions.html | 2 +- .../getIndexes.html | 2 +- .../getLastQuery.html | 2 +- .../getProcedures.html | 2 +- .../getSchemas.html | 2 +- .../getSequences.html | 2 +- .../Query_Drivers_AbstractDriver/getSql.html | 2 +- .../getSystemTables.html | 2 +- .../getTables.html | 2 +- .../getTriggers.html | 2 +- .../getTypes.html | 2 +- .../Query_Drivers_AbstractDriver/getUtil.html | 2 +- .../getVersion.html | 2 +- .../getViews.html | 2 +- .../insertBatch.html | 2 +- .../Query_Drivers_AbstractDriver/numRows.html | 2 +- .../prefixTable.html | 2 +- .../prepareExecute.html | 2 +- .../prepareQuery.html | 2 +- .../quoteIdent.html | 32 +--- .../quoteTable.html | 2 +- .../returning.html | 2 +- .../setLastQuery.html | 2 +- .../setTablePrefix.html | 2 +- .../truncate.html | 2 +- .../updateBatch.html | 2 +- .../classes/Query_Drivers_AbstractUtil.html | 23 +++ .../createTable.html | 20 ++ .../classes/Query_Drivers_Mysql_Util.html | 44 +++++ .../backupStructure.html | 41 ++++ .../classes/Query_Drivers_Pgsql_Driver.html | 44 +++++ .../Query_Drivers_Pgsql_Driver/getFks.html | 41 ++++ .../classes/Query_Drivers_Sqlite_Util.html | 30 +++ .../Query_Drivers_Sqlite_Util/backupData.html | 27 +++ apiDocumentation/classes/Query_JoinType.html | 110 +++++++++++ apiDocumentation/classes/Query_LikeType.html | 102 ++++++++++ .../classes/Query_QueryBuilder.html | 175 +++++++++++++++++- .../classes/Query_QueryBuilder/countAll.html | 2 +- .../Query_QueryBuilder/countAllResults.html | 22 ++- .../classes/Query_QueryBuilder/delete.html | 2 +- .../classes/Query_QueryBuilder/distinct.html | 2 +- .../classes/Query_QueryBuilder/explain.html | 2 +- .../classes/Query_QueryBuilder/from.html | 6 +- .../classes/Query_QueryBuilder/get.html | 2 +- .../Query_QueryBuilder/getCompiledDelete.html | 22 ++- .../Query_QueryBuilder/getCompiledInsert.html | 22 ++- .../Query_QueryBuilder/getCompiledSelect.html | 22 ++- .../Query_QueryBuilder/getCompiledUpdate.html | 22 ++- .../classes/Query_QueryBuilder/getWhere.html | 2 +- .../classes/Query_QueryBuilder/groupBy.html | 22 ++- .../classes/Query_QueryBuilder/groupEnd.html | 2 +- .../Query_QueryBuilder/groupStart.html | 2 +- .../classes/Query_QueryBuilder/having.html | 2 +- .../classes/Query_QueryBuilder/insert.html | 2 +- .../Query_QueryBuilder/insertBatch.html | 36 +++- .../classes/Query_QueryBuilder/join.html | 2 +- .../classes/Query_QueryBuilder/like.html | 4 +- .../classes/Query_QueryBuilder/limit.html | 2 +- .../Query_QueryBuilder/notGroupStart.html | 2 +- .../classes/Query_QueryBuilder/notLike.html | 4 +- .../Query_QueryBuilder/orGroupStart.html | 2 +- .../classes/Query_QueryBuilder/orHaving.html | 2 +- .../classes/Query_QueryBuilder/orLike.html | 4 +- .../Query_QueryBuilder/orNotGroupStart.html | 2 +- .../classes/Query_QueryBuilder/orNotLike.html | 4 +- .../classes/Query_QueryBuilder/orWhere.html | 2 +- .../classes/Query_QueryBuilder/orWhereIn.html | 2 +- .../Query_QueryBuilder/orWhereNotIn.html | 2 +- .../classes/Query_QueryBuilder/orderBy.html | 2 +- .../classes/Query_QueryBuilder/returning.html | 2 +- .../classes/Query_QueryBuilder/select.html | 2 +- .../classes/Query_QueryBuilder/selectAvg.html | 29 ++- .../classes/Query_QueryBuilder/selectMax.html | 29 ++- .../classes/Query_QueryBuilder/selectMin.html | 29 ++- .../classes/Query_QueryBuilder/selectSum.html | 29 ++- .../classes/Query_QueryBuilder/set.html | 22 ++- .../classes/Query_QueryBuilder/table.html | 108 +++++++++++ .../classes/Query_QueryBuilder/update.html | 2 +- .../Query_QueryBuilder/updateBatch.html | 43 ++++- .../classes/Query_QueryBuilder/where.html | 2 +- .../classes/Query_QueryBuilder/whereIn.html | 2 +- .../Query_QueryBuilder/whereNotIn.html | 2 +- .../classes/Query_QueryParser.html | 23 +++ .../Query_QueryParser/__construct.html | 20 ++ .../Query_Drivers_DriverInterface.html | 22 ++- .../driverQuery.html | 20 ++ .../quoteTable.html | 11 +- .../Query_QueryBuilderInterface.html | 107 +++++++++++ .../Query_QueryBuilderInterface/countAll.html | 2 +- .../countAllResults.html | 22 ++- .../Query_QueryBuilderInterface/delete.html | 2 +- .../Query_QueryBuilderInterface/from.html | 6 +- .../Query_QueryBuilderInterface/get.html | 2 +- .../getCompiledDelete.html | 22 ++- .../getCompiledInsert.html | 22 ++- .../getCompiledSelect.html | 22 ++- .../getCompiledUpdate.html | 22 ++- .../Query_QueryBuilderInterface/getWhere.html | 2 +- .../Query_QueryBuilderInterface/groupBy.html | 2 +- .../Query_QueryBuilderInterface/groupEnd.html | 2 +- .../groupStart.html | 2 +- .../Query_QueryBuilderInterface/having.html | 2 +- .../Query_QueryBuilderInterface/insert.html | 2 +- .../insertBatch.html | 2 +- .../Query_QueryBuilderInterface/join.html | 4 +- .../Query_QueryBuilderInterface/like.html | 4 +- .../Query_QueryBuilderInterface/limit.html | 2 +- .../notGroupStart.html | 2 +- .../Query_QueryBuilderInterface/notLike.html | 4 +- .../orGroupStart.html | 2 +- .../Query_QueryBuilderInterface/orHaving.html | 2 +- .../Query_QueryBuilderInterface/orLike.html | 4 +- .../orNotGroupStart.html | 2 +- .../orNotLike.html | 4 +- .../Query_QueryBuilderInterface/orWhere.html | 2 +- .../orWhereIn.html | 2 +- .../orWhereNotIn.html | 2 +- .../Query_QueryBuilderInterface/orderBy.html | 2 +- .../resetQuery.html | 2 +- .../selectAvg.html | 27 +++ .../selectMax.html | 27 +++ .../selectMin.html | 27 +++ .../selectSum.html | 27 +++ .../Query_QueryBuilderInterface/set.html | 2 +- .../Query_QueryBuilderInterface/table.html | 99 ++++++++++ .../Query_QueryBuilderInterface/update.html | 2 +- .../updateBatch.html | 2 +- .../Query_QueryBuilderInterface/where.html | 2 +- .../Query_QueryBuilderInterface/whereIn.html | 2 +- .../whereNotIn.html | 2 +- apiDocumentation/namespaces.html | 2 +- .../source/Drivers/AbstractDriver.php.html | 2 +- .../source/Drivers/DriverInterface.php.html | 2 +- apiDocumentation/source/JoinType.php.html | 3 + apiDocumentation/source/LikeType.php.html | 3 + apiDocumentation/source/QueryBuilder.php.html | 2 +- .../source/QueryBuilderBase.php.html | 2 +- .../source/QueryBuilderInterface.php.html | 2 +- 151 files changed, 1977 insertions(+), 184 deletions(-) create mode 100644 apiDocumentation/classes/Query_JoinType.html create mode 100644 apiDocumentation/classes/Query_LikeType.html create mode 100644 apiDocumentation/classes/Query_QueryBuilder/table.html create mode 100644 apiDocumentation/interfaces/Query_QueryBuilderInterface/table.html create mode 100644 apiDocumentation/source/JoinType.php.html create mode 100644 apiDocumentation/source/LikeType.php.html diff --git a/apiDocumentation/classes.html b/apiDocumentation/classes.html index 6fd35fd..49a4db4 100644 --- a/apiDocumentation/classes.html +++ b/apiDocumentation/classes.html @@ -123,6 +123,22 @@ EMPTY + + + JoinType + + 'Enum' of join types + EMPTY + + + + + LikeType + + 'Enum' of join types + EMPTY + + MapType diff --git a/apiDocumentation/classes/Query_ConnectionManager.html b/apiDocumentation/classes/Query_ConnectionManager.html index a25875b..95c5300 100644 --- a/apiDocumentation/classes/Query_ConnectionManager.html +++ b/apiDocumentation/classes/Query_ConnectionManager.html @@ -52,6 +52,9 @@
  • Synopsis
    • +
  • + Violations +
  • Methods
    • @@ -77,6 +80,82 @@ }
    +

    Violations

    +
    +

    PHPMessDetector

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    LineRuleMessage
    129 + UndefinedVariable + Avoid using undefined variables such as '$dsn' which will lead to PHP notices.
    129 + UndefinedVariable + Avoid using undefined variables such as '$options' which will lead to PHP notices.
    135 + ShortVariable + Avoid variables with short names like $db. Configured minimum length is 3.
    136 + UndefinedVariable + Avoid using undefined variables such as '$dsn' which will lead to PHP notices.
    136 + UndefinedVariable + Avoid using undefined variables such as '$options' which will lead to PHP notices.
    137 + UndefinedVariable + Avoid using undefined variables such as '$dsn' which will lead to PHP notices.
    137 + UndefinedVariable + Avoid using undefined variables such as '$options' which will lead to PHP notices.
    155 - 157 + ElseExpression + The method connect uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    196 - 198 + ElseExpression + The method parseParams uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    +

    Methods

    public

    diff --git a/apiDocumentation/classes/Query_ConnectionManager/connect.html b/apiDocumentation/classes/Query_ConnectionManager/connect.html index 4afee89..f66c0dc 100644 --- a/apiDocumentation/classes/Query_ConnectionManager/connect.html +++ b/apiDocumentation/classes/Query_ConnectionManager/connect.html @@ -102,6 +102,75 @@
    +

    Violations

    +
    +

    PHPMessDetector

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    LineRuleMessage
    129 + UndefinedVariable + Avoid using undefined variables such as '$dsn' which will lead to PHP notices.
    129 + UndefinedVariable + Avoid using undefined variables such as '$options' which will lead to PHP notices.
    135 + ShortVariable + Avoid variables with short names like $db. Configured minimum length is 3.
    136 + UndefinedVariable + Avoid using undefined variables such as '$dsn' which will lead to PHP notices.
    136 + UndefinedVariable + Avoid using undefined variables such as '$options' which will lead to PHP notices.
    137 + UndefinedVariable + Avoid using undefined variables such as '$dsn' which will lead to PHP notices.
    137 + UndefinedVariable + Avoid using undefined variables such as '$options' which will lead to PHP notices.
    155 - 157 + ElseExpression + The method connect uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    +