Do you wish to register an account?
A Query Builder and Database abstraction layer
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

134 lines
4.1KB

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE html SYSTEM "about:legacy-compat">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  4. <head>
  5. <title>phpDox - Query\QueryBuilder::getCompiledSelect</title>
  6. <link rel="stylesheet" type="text/css" href="../../css/style.css" media="screen"/>
  7. <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  8. </head>
  9. <body>
  10. <nav class="topnav">
  11. <ul>
  12. <li>
  13. <div class="logo"><span>/**</span>phpDox</div>
  14. </li>
  15. <li class="separator">
  16. <a href="../../index.html">Overview</a>
  17. </li>
  18. <li class="separator">
  19. <a href="../../namespaces.html">Namespaces</a>
  20. </li>
  21. <li>
  22. <a href="../../interfaces.html">Interfaces</a>
  23. </li>
  24. <li>
  25. <a href="../../classes.html">Classes</a>
  26. </li>
  27. <li class="separator">
  28. <a href="../../source/index.html">Source</a>
  29. </li>
  30. </ul>
  31. </nav>
  32. <div id="mainstage">
  33. <div class="box">
  34. <ul class="breadcrumb">
  35. <li>
  36. <a href="../../index.html">Overview</a>
  37. </li>
  38. <li class="separator">
  39. <a href="../../classes.html">Classes</a>
  40. </li>
  41. <li class="separator">
  42. <a href="../../classes.html#Query">Query</a>
  43. </li>
  44. <li class="separator">
  45. <a title="Query\QueryBuilder" href="../../classes/Query_QueryBuilder.html">QueryBuilder</a>
  46. </li>
  47. <li class="separator">getCompiledSelect</li>
  48. </ul>
  49. </div>
  50. <nav class="box">
  51. <ul>
  52. <li>
  53. <a href="#introduction">Introduction</a>
  54. </li>
  55. <li>
  56. <a href="#synopsis">Synopsis</a>
  57. </li>
  58. <li>
  59. <a href="#parameter">Parameter</a>
  60. </li>
  61. <li>
  62. <a href="#return">Return</a>
  63. </li>
  64. <li>
  65. <a href="#interface">Interface</a>
  66. </li>
  67. <li>
  68. <a href="../../source/QueryBuilder.php.html#line774">Source</a>
  69. </li>
  70. </ul>
  71. </nav>
  72. <section>
  73. <h1><small>Query\QueryBuilder::</small>getCompiledSelect</h1>
  74. <h4>Returns the generated 'select' sql query</h4>
  75. <p/>
  76. <ul/>
  77. <h2 id="signature">Signature</h2>
  78. <div class="styled synopsis">
  79. <code>public function getCompiledSelect([string
  80. $table = '',
  81. [boolean
  82. $reset = TRUE]] )
  83. </code>
  84. </div>
  85. <h2 id="parameterlist">Parameters</h2>
  86. <dl class="styled">
  87. <dt><code>$table</code>
  88. string</dt>
  89. <dd/>
  90. <dt><code>$reset</code>
  91. boolean</dt>
  92. <dd><br/><br/><br/> </dd>
  93. </dl>
  94. <h2 id="return">Returns</h2>
  95. <dl class="styled">
  96. <dt>string</dt>
  97. <dd/>
  98. </dl>
  99. <h2 id="interface">Defined by Interface</h2>
  100. <p class="styled">
  101. <code>
  102. <a title="Query\QueryBuilderInterface" href="../../interfaces/Query_QueryBuilderInterface.html">QueryBuilderInterface</a>
  103. </code>
  104. </p>
  105. <h2 id="violations">Violations</h2>
  106. <div class="styled">
  107. <h3>PHPMessDetector</h3>
  108. <table class="styled">
  109. <thead>
  110. <tr>
  111. <th>Line</th>
  112. <th>Rule</th>
  113. <th>Message</th>
  114. </tr>
  115. </thead>
  116. <tr>
  117. <td class="line">774</td>
  118. <td>
  119. <a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
  120. </td>
  121. <td>The method getCompiledSelect has a boolean flag argument $reset, which is a certain sign of a Single Responsibility Principle violation.</td>
  122. </tr>
  123. </table>
  124. </div>
  125. </section>
  126. </div>
  127. <footer>
  128. <span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
  129. </footer>
  130. </body>
  131. </html>