Browse Source

Update API docs

pull/1/head
Timothy Warren 2 years ago
parent
commit
4eb234db70
  1. 16
      apiDocumentation/classes.html
  2. 79
      apiDocumentation/classes/Query_ConnectionManager.html
  3. 69
      apiDocumentation/classes/Query_ConnectionManager/connect.html
  4. 20
      apiDocumentation/classes/Query_ConnectionManager/parseParams.html
  5. 35
      apiDocumentation/classes/Query_Drivers_AbstractDriver.html
  6. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/__call.html
  7. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/__construct.html
  8. 22
      apiDocumentation/classes/Query_Drivers_AbstractDriver/_quote.html
  9. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/affectedRows.html
  10. 22
      apiDocumentation/classes/Query_Drivers_AbstractDriver/driverQuery.html
  11. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getColumns.html
  12. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getDbs.html
  13. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getFks.html
  14. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getFunctions.html
  15. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getIndexes.html
  16. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getLastQuery.html
  17. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getProcedures.html
  18. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getSchemas.html
  19. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getSequences.html
  20. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getSql.html
  21. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getSystemTables.html
  22. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getTables.html
  23. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getTriggers.html
  24. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getTypes.html
  25. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getUtil.html
  26. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getVersion.html
  27. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/getViews.html
  28. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/insertBatch.html
  29. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/numRows.html
  30. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/prefixTable.html
  31. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/prepareExecute.html
  32. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/prepareQuery.html
  33. 32
      apiDocumentation/classes/Query_Drivers_AbstractDriver/quoteIdent.html
  34. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/quoteTable.html
  35. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/returning.html
  36. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/setLastQuery.html
  37. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/setTablePrefix.html
  38. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/truncate.html
  39. 2
      apiDocumentation/classes/Query_Drivers_AbstractDriver/updateBatch.html
  40. 23
      apiDocumentation/classes/Query_Drivers_AbstractUtil.html
  41. 20
      apiDocumentation/classes/Query_Drivers_AbstractUtil/createTable.html
  42. 44
      apiDocumentation/classes/Query_Drivers_Mysql_Util.html
  43. 41
      apiDocumentation/classes/Query_Drivers_Mysql_Util/backupStructure.html
  44. 44
      apiDocumentation/classes/Query_Drivers_Pgsql_Driver.html
  45. 41
      apiDocumentation/classes/Query_Drivers_Pgsql_Driver/getFks.html
  46. 30
      apiDocumentation/classes/Query_Drivers_Sqlite_Util.html
  47. 27
      apiDocumentation/classes/Query_Drivers_Sqlite_Util/backupData.html
  48. 110
      apiDocumentation/classes/Query_JoinType.html
  49. 102
      apiDocumentation/classes/Query_LikeType.html
  50. 175
      apiDocumentation/classes/Query_QueryBuilder.html
  51. 2
      apiDocumentation/classes/Query_QueryBuilder/countAll.html
  52. 22
      apiDocumentation/classes/Query_QueryBuilder/countAllResults.html
  53. 2
      apiDocumentation/classes/Query_QueryBuilder/delete.html
  54. 2
      apiDocumentation/classes/Query_QueryBuilder/distinct.html
  55. 2
      apiDocumentation/classes/Query_QueryBuilder/explain.html
  56. 6
      apiDocumentation/classes/Query_QueryBuilder/from.html
  57. 2
      apiDocumentation/classes/Query_QueryBuilder/get.html
  58. 22
      apiDocumentation/classes/Query_QueryBuilder/getCompiledDelete.html
  59. 22
      apiDocumentation/classes/Query_QueryBuilder/getCompiledInsert.html
  60. 22
      apiDocumentation/classes/Query_QueryBuilder/getCompiledSelect.html
  61. 22
      apiDocumentation/classes/Query_QueryBuilder/getCompiledUpdate.html
  62. 2
      apiDocumentation/classes/Query_QueryBuilder/getWhere.html
  63. 22
      apiDocumentation/classes/Query_QueryBuilder/groupBy.html
  64. 2
      apiDocumentation/classes/Query_QueryBuilder/groupEnd.html
  65. 2
      apiDocumentation/classes/Query_QueryBuilder/groupStart.html
  66. 2
      apiDocumentation/classes/Query_QueryBuilder/having.html
  67. 2
      apiDocumentation/classes/Query_QueryBuilder/insert.html
  68. 36
      apiDocumentation/classes/Query_QueryBuilder/insertBatch.html
  69. 2
      apiDocumentation/classes/Query_QueryBuilder/join.html
  70. 4
      apiDocumentation/classes/Query_QueryBuilder/like.html
  71. 2
      apiDocumentation/classes/Query_QueryBuilder/limit.html
  72. 2
      apiDocumentation/classes/Query_QueryBuilder/notGroupStart.html
  73. 4
      apiDocumentation/classes/Query_QueryBuilder/notLike.html
  74. 2
      apiDocumentation/classes/Query_QueryBuilder/orGroupStart.html
  75. 2
      apiDocumentation/classes/Query_QueryBuilder/orHaving.html
  76. 4
      apiDocumentation/classes/Query_QueryBuilder/orLike.html
  77. 2
      apiDocumentation/classes/Query_QueryBuilder/orNotGroupStart.html
  78. 4
      apiDocumentation/classes/Query_QueryBuilder/orNotLike.html
  79. 2
      apiDocumentation/classes/Query_QueryBuilder/orWhere.html
  80. 2
      apiDocumentation/classes/Query_QueryBuilder/orWhereIn.html
  81. 2
      apiDocumentation/classes/Query_QueryBuilder/orWhereNotIn.html
  82. 2
      apiDocumentation/classes/Query_QueryBuilder/orderBy.html
  83. 2
      apiDocumentation/classes/Query_QueryBuilder/returning.html
  84. 2
      apiDocumentation/classes/Query_QueryBuilder/select.html
  85. 29
      apiDocumentation/classes/Query_QueryBuilder/selectAvg.html
  86. 29
      apiDocumentation/classes/Query_QueryBuilder/selectMax.html
  87. 29
      apiDocumentation/classes/Query_QueryBuilder/selectMin.html
  88. 29
      apiDocumentation/classes/Query_QueryBuilder/selectSum.html
  89. 22
      apiDocumentation/classes/Query_QueryBuilder/set.html
  90. 108
      apiDocumentation/classes/Query_QueryBuilder/table.html
  91. 2
      apiDocumentation/classes/Query_QueryBuilder/update.html
  92. 43
      apiDocumentation/classes/Query_QueryBuilder/updateBatch.html
  93. 2
      apiDocumentation/classes/Query_QueryBuilder/where.html
  94. 2
      apiDocumentation/classes/Query_QueryBuilder/whereIn.html
  95. 2
      apiDocumentation/classes/Query_QueryBuilder/whereNotIn.html
  96. 23
      apiDocumentation/classes/Query_QueryParser.html
  97. 20
      apiDocumentation/classes/Query_QueryParser/__construct.html
  98. 22
      apiDocumentation/interfaces/Query_Drivers_DriverInterface.html
  99. 20
      apiDocumentation/interfaces/Query_Drivers_DriverInterface/driverQuery.html
  100. 11
      apiDocumentation/interfaces/Query_Drivers_DriverInterface/quoteTable.html

16
apiDocumentation/classes.html

@ -123,6 +123,22 @@
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Query_JoinType.html">JoinType</a>
</td>
<td>'Enum' of join types</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Query_LikeType.html">LikeType</a>
</td>
<td>'Enum' of join types</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Query_MapType.html">MapType</a>

79
apiDocumentation/classes/Query_ConnectionManager.html

@ -52,6 +52,9 @@
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#violations">Violations</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
@ -77,6 +80,82 @@
</li></ul>
}<br/></div>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">129</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">129</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">135</td>
<td>
<a href="https://phpmd.org/rules/naming.html#shortvariable" target="_blank" title="Naming Rules">ShortVariable</a>
</td>
<td>Avoid variables with short names like $db. Configured minimum length is 3.</td>
</tr>
<tr>
<td class="line">136</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">136</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">137</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">137</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">155 - 157</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#elseexpression" target="_blank" title="Clean Code Rules">ElseExpression</a>
</td>
<td>The method connect uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.</td>
</tr>
<tr>
<td class="line">196 - 198</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#elseexpression" target="_blank" title="Clean Code Rules">ElseExpression</a>
</td>
<td>The method parseParams uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.</td>
</tr>
</table>
</div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>

69
apiDocumentation/classes/Query_ConnectionManager/connect.html

@ -102,6 +102,75 @@
</dt>
<dd/>
</dl>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">129</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">129</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">135</td>
<td>
<a href="https://phpmd.org/rules/naming.html#shortvariable" target="_blank" title="Naming Rules">ShortVariable</a>
</td>
<td>Avoid variables with short names like $db. Configured minimum length is 3.</td>
</tr>
<tr>
<td class="line">136</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">136</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">137</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">137</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">155 - 157</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#elseexpression" target="_blank" title="Clean Code Rules">ElseExpression</a>
</td>
<td>The method connect uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

20
apiDocumentation/classes/Query_ConnectionManager/parseParams.html

@ -101,6 +101,26 @@
</dt>
<dd/>
</dl>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">196 - 198</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#elseexpression" target="_blank" title="Clean Code Rules">ElseExpression</a>
</td>
<td>The method parseParams uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

35
apiDocumentation/classes/Query_Drivers_AbstractDriver.html

@ -62,7 +62,7 @@
<a href="#methods">Methods</a>
</li>
<li>
<a href="../source/Drivers/AbstractDriver.php.html#line30">Source</a>
<a href="../source/Drivers/AbstractDriver.php.html#line32">Source</a>
</li>
</ul>
</nav>
@ -145,31 +145,42 @@
</div>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>Checkstyle</h3>
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Column</th>
<th>Severity</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">333</td>
<td>23</td>
<td class="line">82 - 721</td>
<td>
<span title="Generic.Arrays.DisallowLongArraySyntax.Found">error</span>
<a href="https://phpmd.org/rules/codesize.html#toomanypublicmethods" target="_blank" title="Code Size Rules">TooManyPublicMethods</a>
</td>
<td>Short array syntax must be used to define arrays</td>
<td>The class AbstractDriver has 15 public methods. Consider refactoring AbstractDriver to keep number of public methods under 10.</td>
</tr>
<tr>
<td class="line">333</td>
<td>44</td>
<td class="line">82 - 721</td>
<td>
<span title="Generic.Arrays.DisallowLongArraySyntax.Found">error</span>
<a href="https://phpmd.org/rules/codesize.html#excessiveclasscomplexity" target="_blank" title="Code Size Rules">ExcessiveClassComplexity</a>
</td>
<td>Short array syntax must be used to define arrays</td>
<td>The class AbstractDriver has an overall complexity of 62 which is very high. The configured complexity threshold is 50.</td>
</tr>
<tr>
<td class="line">500</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
</td>
<td>The method driverQuery has a boolean flag argument $filteredIndex, which is a certain sign of a Single Responsibility Principle violation.</td>
</tr>
<tr>
<td class="line">690 - 703</td>
<td>
<a href="#" target="_blank" title="Controversial Rules">CamelCaseMethodName</a>
</td>
<td>The method _quote is not named in camelCase.</td>
</tr>
</table>
</div>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/__call.html

@ -62,7 +62,7 @@
<a href="#return">Return</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line126">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line128">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/__construct.html

@ -59,7 +59,7 @@
<a href="#parameter">Parameter</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line90">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line92">Source</a>
</li>
</ul>
</nav>

22
apiDocumentation/classes/Query_Drivers_AbstractDriver/_quote.html

@ -62,7 +62,7 @@
<a href="#return">Return</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line685">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line690">Source</a>
</li>
</ul>
</nav>
@ -89,6 +89,26 @@
<dt>mixed</dt>
<dd/>
</dl>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">690 - 703</td>
<td>
<a href="#" target="_blank" title="Controversial Rules">CamelCaseMethodName</a>
</td>
<td>The method _quote is not named in camelCase.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/affectedRows.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line249">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line251">Source</a>
</li>
</ul>
</nav>

22
apiDocumentation/classes/Query_Drivers_AbstractDriver/driverQuery.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line495">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line500">Source</a>
</li>
</ul>
</nav>
@ -105,6 +105,26 @@
<a title="Query\Drivers\DriverInterface" href="../../interfaces/Query_Drivers_DriverInterface.html">DriverInterface</a>
</code>
</p>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">500</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
</td>
<td>The method driverQuery has a boolean flag argument $filteredIndex, which is a certain sign of a Single Responsibility Principle violation.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getColumns.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line441">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line446">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getDbs.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line367">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line372">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getFks.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line452">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line457">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getFunctions.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line399">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line404">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getIndexes.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line463">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line468">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getLastQuery.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line149">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line151">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getProcedures.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line409">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line414">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getSchemas.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line344">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line349">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getSequences.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line389">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line394">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getSql.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line170">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line172">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getSystemTables.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line430">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line435">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getTables.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line355">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line360">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getTriggers.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line419">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line424">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getTypes.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line473">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line478">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getUtil.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line180">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line182">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getVersion.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line483">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line488">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/getViews.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line377">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line382">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/insertBatch.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line546">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line551">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/numRows.html

@ -62,7 +62,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line525">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line530">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/prefixTable.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line260">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line262">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/prepareExecute.html

@ -68,7 +68,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line236">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line238">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/prepareQuery.html

@ -68,7 +68,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line208">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line210">Source</a>
</li>
</ul>
</nav>

32
apiDocumentation/classes/Query_Drivers_AbstractDriver/quoteIdent.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line304">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line306">Source</a>
</li>
</ul>
</nav>
@ -99,36 +99,6 @@
<a title="Query\Drivers\DriverInterface" href="../../interfaces/Query_Drivers_DriverInterface.html">DriverInterface</a>
</code>
</p>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>Checkstyle</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Column</th>
<th>Severity</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">333</td>
<td>23</td>
<td>
<span title="Generic.Arrays.DisallowLongArraySyntax.Found">error</span>
</td>
<td>Short array syntax must be used to define arrays</td>
</tr>
<tr>
<td class="line">333</td>
<td>44</td>
<td>
<span title="Generic.Arrays.DisallowLongArraySyntax.Found">error</span>
</td>
<td>Short array syntax must be used to define arrays</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/quoteTable.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line290">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line292">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/returning.html

@ -62,7 +62,7 @@
<a href="#return">Return</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line674">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line679">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/setLastQuery.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line160">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line162">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/setTablePrefix.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line191">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line193">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/truncate.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line655">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line660">Source</a>
</li>
</ul>
</nav>

2
apiDocumentation/classes/Query_Drivers_AbstractDriver/updateBatch.html

@ -65,7 +65,7 @@
<a href="#interface">Interface</a>
</li>
<li>
<a href="../../source/Drivers/AbstractDriver.php.html#line585">Source</a>
<a href="../../source/Drivers/AbstractDriver.php.html#line590">Source</a>
</li>
</ul>
</nav>

23
apiDocumentation/classes/Query_Drivers_AbstractUtil.html

@ -52,6 +52,9 @@
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#violations">Violations</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
@ -76,6 +79,26 @@
</li></ul>
}<br/></div>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">58</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
</td>
<td>The method createTable has a boolean flag argument $ifNotExists, which is a certain sign of a Single Responsibility Principle violation.</td>
</tr>
</table>
</div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>

20
apiDocumentation/classes/Query_Drivers_AbstractUtil/createTable.html

@ -107,6 +107,26 @@
<dt>string</dt>
<dd/>
</dl>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">58</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
</td>
<td>The method createTable has a boolean flag argument $ifNotExists, which is a certain sign of a Single Responsibility Principle violation.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

44
apiDocumentation/classes/Query_Drivers_Mysql_Util.html

@ -55,6 +55,9 @@
<li>
<a href="#hierarchy">Hierarchy</a>
</li>
<li>
<a href="#violations">Violations</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
@ -91,6 +94,47 @@
</li>
</ul>
</div>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">39</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$d' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">43</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$d' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">50</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$d' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">54</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$d' which will lead to PHP notices.</td>
</tr>
</table>
</div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>

41
apiDocumentation/classes/Query_Drivers_Mysql_Util/backupStructure.html

@ -89,6 +89,47 @@
</code>
</li>
</ul>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">39</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$d' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">43</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$d' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">50</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$d' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">54</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$d' which will lead to PHP notices.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

44
apiDocumentation/classes/Query_Drivers_Pgsql_Driver.html

@ -55,6 +55,9 @@
<li>
<a href="#hierarchy">Hierarchy</a>
</li>
<li>
<a href="#violations">Violations</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
@ -135,6 +138,47 @@
</li>
</ul>
</div>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">75</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$key' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">79</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$key' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">86</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$key' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">86</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$key' which will lead to PHP notices.</td>
</tr>
</table>
</div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>

41
apiDocumentation/classes/Query_Drivers_Pgsql_Driver/getFks.html

@ -109,6 +109,47 @@
</code>
</li>
</ul>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">75</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$key' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">79</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$key' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">86</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$key' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">86</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$key' which will lead to PHP notices.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

30
apiDocumentation/classes/Query_Drivers_Sqlite_Util.html

@ -55,6 +55,9 @@
<li>
<a href="#hierarchy">Hierarchy</a>
</li>
<li>
<a href="#violations">Violations</a>
</li>
<li>
<a href="#methods">Methods</a>
</li>
@ -91,6 +94,33 @@
</li>
</ul>
</div>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">32 - 97</td>
<td>
<a href="#" target="_blank" title="Controversial Rules">CamelCaseVariableName</a>
</td>
<td>The variable $_ is not named in camelCase.</td>
</tr>
<tr>
<td class="line">77</td>
<td>
<a href="https://phpmd.org/rules/unusedcode.html#unusedlocalvariable" target="_blank" title="Unused Code Rules">UnusedLocalVariable</a>
</td>
<td>Avoid unused local variables such as '$_'.</td>
</tr>
</table>
</div>
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>

27
apiDocumentation/classes/Query_Drivers_Sqlite_Util/backupData.html

@ -100,6 +100,33 @@
</code>
</li>
</ul>
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">32 - 97</td>
<td>
<a href="#" target="_blank" title="Controversial Rules">CamelCaseVariableName</a>
</td>
<td>The variable $_ is not named in camelCase.</td>
</tr>
<tr>
<td class="line">77</td>
<td>
<a href="https://phpmd.org/rules/unusedcode.html#unusedlocalvariable" target="_blank" title="Unused Code Rules">UnusedLocalVariable</a>
</td>
<td>Avoid unused local variables such as '$_'.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>

110
apiDocumentation/classes/Query_JoinType.html

@ -0,0 +1,110 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Query\JoinType</title>
<link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../namespaces.html">Namespaces</a>
</li>
<li>
<a href="../interfaces.html">Interfaces</a>
</li>
<li>
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../source/index.html">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../classes.html#Query">Query</a>
</li>
<li class="separator">JoinType</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#constants">Constants</a>
</li>
<li>
<a href="../source/JoinType.php.html#line21">Source</a>
</li>
</ul>
</nav>
<section>
<h1 id="introduction"><small>Query\</small>JoinType</h1>
<h4>'Enum' of join types</h4>
<p/>
<ul/>
<h2 id="synopsis">Synopsis</h2>
<div class="synopsis">class JoinType
{<br/><ul class="none"><li>// constants</li><li>const CROSS = 'cross';</li><li>const INNER = 'inner';</li><li>const OUTER = 'outer';</li><li>const LEFT = 'left';</li><li>const RIGHT = 'right';</li></ul>
}<br/></div>
<h2 id="constants">Constants</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td id="CROSS">CROSS</td>
<td>'cross'</td>
</tr>
<tr>
<td id="INNER">INNER</td>
<td>'inner'</td>
</tr>
<tr>
<td id="OUTER">OUTER</td>
<td>'outer'</td>
</tr>
<tr>
<td