Do you wish to register an account?
Browse Source

Update docs

master
Timothy Warren 8 years ago
parent
commit
467c28f05e
48 changed files with 18494 additions and 363 deletions
  1. +317
    -74
      docs/classes.svg
  2. +714
    -0
      docs/classes/DB_PDO.html
  3. +306
    -0
      docs/classes/DB_SQL.html
  4. +217
    -0
      docs/classes/DB_Util.html
  5. +876
    -0
      docs/classes/Firebird.html
  6. +512
    -0
      docs/classes/Firebird_Result.html
  7. +316
    -0
      docs/classes/Firebird_SQL.html
  8. +220
    -0
      docs/classes/Firebird_Util.html
  9. +912
    -0
      docs/classes/MySQL.html
  10. +321
    -0
      docs/classes/MySQL_SQL.html
  11. +216
    -0
      docs/classes/MySQL_Util.html
  12. +914
    -0
      docs/classes/ODBC.html
  13. +316
    -0
      docs/classes/ODBC_SQL.html
  14. +211
    -0
      docs/classes/ODBC_Util.html
  15. +914
    -0
      docs/classes/PgSQL.html
  16. +316
    -0
      docs/classes/PgSQL_SQL.html
  17. +216
    -0
      docs/classes/PgSQL_Util.html
  18. +1230
    -0
      docs/classes/Query_Builder.html
  19. +929
    -0
      docs/classes/SQLite.html
  20. +316
    -0
      docs/classes/SQLite_SQL.html
  21. +216
    -0
      docs/classes/SQLite_Util.html
  22. +5
    -2
      docs/classes/miniMVC.Controller.html
  23. +1479
    -9
      docs/classes/miniMVC.DB.html
  24. +5
    -2
      docs/classes/miniMVC.Data_Store.html
  25. +5
    -2
      docs/classes/miniMVC.MM.html
  26. +5
    -2
      docs/classes/miniMVC.Model.html
  27. +5
    -2
      docs/classes/miniMVC.Output.html
  28. +5
    -2
      docs/classes/miniMVC.Page.html
  29. +5
    -2
      docs/classes/miniMVC.Session.html
  30. +5
    -2
      docs/classes/miniMVC.miniMVC.html
  31. +5
    -2
      docs/deprecated.html
  32. +26
    -2
      docs/errors.html
  33. +5
    -2
      docs/graph_class.html
  34. +10
    -3
      docs/index.html
  35. +103
    -6
      docs/markers.html
  36. +290
    -0
      docs/namespaces/default.html
  37. +8
    -17
      docs/namespaces/miniMVC.html
  38. +5
    -2
      docs/packages/.html
  39. +19
    -2
      docs/packages/Default.html
  40. +219
    -0
      docs/packages/Query.Drivers.html
  41. +123
    -0
      docs/packages/Query.Query.html
  42. +310
    -0
      docs/packages/Query.html
  43. +6
    -3
      docs/packages/miniMVC.Libraries.html
  44. +5
    -2
      docs/packages/miniMVC.System.html
  45. +9
    -19
      docs/packages/miniMVC.html
  46. +5324
    -201
      docs/structure.xml
  47. +2
    -2
      phpdoc.dist.xml
  48. +1
    -1
      sys/db

+ 317
- 74
docs/classes.svg View File

@@ -4,128 +4,371 @@
<!-- Generated by graphviz version 2.26.3 (20100126.1600)
-->
<!-- Title: G Pages: 1 -->
<svg width="682pt" height="403pt"
viewBox="0.00 0.00 682.00 403.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph1" class="graph" transform="scale(1 1) rotate(0) translate(4 399)">
<svg width="754pt" height="1327pt"
viewBox="0.00 0.00 754.00 1327.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph1" class="graph" transform="scale(1 1) rotate(0) translate(4 1323)">
<title>G</title>
<polygon fill="white" stroke="white" points="-4,5 -4,-399 679,-399 679,5 -4,5"/>
<g id="graph2" class="cluster"><title>cluster_miniMVC</title>
<polyline fill="none" stroke="gray" points="218,-44 654,-44 "/>
<path fill="none" stroke="gray" d="M654,-44C660,-44 666,-50 666,-56"/>
<polyline fill="none" stroke="gray" points="666,-56 666,-375 "/>
<path fill="none" stroke="gray" d="M666,-375C666,-381 660,-387 654,-387"/>
<polyline fill="none" stroke="gray" points="654,-387 218,-387 "/>
<path fill="none" stroke="gray" d="M218,-387C212,-387 206,-381 206,-375"/>
<polyline fill="none" stroke="gray" points="206,-375 206,-56 "/>
<path fill="none" stroke="gray" d="M206,-56C206,-50 212,-44 218,-44"/>
<text text-anchor="middle" x="436" y="-373.1" font-family="Times Roman,serif" font-size="11.00" fill="gray">miniMVC</text>
<polygon fill="white" stroke="white" points="-4,5 -4,-1323 751,-1323 751,5 -4,5"/>
<g id="graph2" class="cluster"><title>cluster_default</title>
<polyline fill="none" stroke="none" points="260,-44 570,-44 "/>
<path fill="none" stroke="none" d="M570,-44C576,-44 582,-50 582,-56"/>
<polyline fill="none" stroke="none" points="582,-56 582,-948 "/>
<path fill="none" stroke="none" d="M582,-948C582,-954 576,-960 570,-960"/>
<polyline fill="none" stroke="none" points="570,-960 260,-960 "/>
<path fill="none" stroke="none" d="M260,-960C254,-960 248,-954 248,-948"/>
<polyline fill="none" stroke="none" points="248,-948 248,-56 "/>
<path fill="none" stroke="none" d="M248,-56C248,-50 254,-44 260,-44"/>
</g>
<g id="graph3" class="cluster"><title>cluster_miniMVC</title>
<polyline fill="none" stroke="gray" points="276,-968 726,-968 "/>
<path fill="none" stroke="gray" d="M726,-968C732,-968 738,-974 738,-980"/>
<polyline fill="none" stroke="gray" points="738,-980 738,-1299 "/>
<path fill="none" stroke="gray" d="M738,-1299C738,-1305 732,-1311 726,-1311"/>
<polyline fill="none" stroke="gray" points="726,-1311 276,-1311 "/>
<path fill="none" stroke="gray" d="M276,-1311C270,-1311 264,-1305 264,-1299"/>
<polyline fill="none" stroke="gray" points="264,-1299 264,-980 "/>
<path fill="none" stroke="gray" d="M264,-980C264,-974 270,-968 276,-968"/>
<text text-anchor="middle" x="501" y="-1297.1" font-family="Times Roman,serif" font-size="11.00" fill="gray">miniMVC</text>
</g>
<!-- \\DB_SQL -->
<g id="node2" class="node"><title>\\DB_SQL</title>
<a xlink:href="sys.db.classes.db_sql.html" xlink:title="«abstract»&lt;br/&gt;DB_SQL" target="_parent">
<polygon fill="none" stroke="black" points="341,-520 257,-520 257,-484 341,-484 341,-520"/>
<text text-anchor="start" x="265" y="-507.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="278.5" y="-494.233" font-family="Courier,monospace" font-size="11.00">DB_SQL</text>
</a>
</g>
<!-- \\DB_PDO -->
<g id="node3" class="node"><title>\\DB_PDO</title>
<a xlink:href="sys.db.classes.db_pdo.html" xlink:title="«abstract»&lt;br/&gt;DB_PDO" target="_parent">
<polygon fill="none" stroke="black" points="341,-250 257,-250 257,-214 341,-214 341,-250"/>
<text text-anchor="start" x="265" y="-237.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="278.5" y="-224.233" font-family="Courier,monospace" font-size="11.00">DB_PDO</text>
</a>
</g>
<!-- \\PDO -->
<g id="node33" class="node"><title>\\PDO</title>
<ellipse fill="none" stroke="black" cx="71" cy="-232" rx="35.0527" ry="18"/>
<text text-anchor="middle" x="71" y="-227.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDO</text>
</g>
<!-- \\DB_PDO&#45;&gt;\\PDO -->
<g id="edge4" class="edge"><title>\\DB_PDO&#45;&gt;\\PDO</title>
<path fill="none" stroke="black" d="M256.382,-232C216.662,-232 157.596,-232 116.862,-232"/>
<polygon fill="none" stroke="black" points="116.667,-228.5 106.667,-232 116.667,-235.5 116.667,-228.5"/>
</g>
<!-- \\Query_Builder -->
<g id="node4" class="node"><title>\\Query_Builder</title>
<a xlink:href="sys.db.classes.query_builder.html" xlink:title="Query_Builder" target="_parent">
<polygon fill="none" stroke="black" points="567,-952 463,-952 463,-916 567,-916 567,-952"/>
<text text-anchor="middle" x="515" y="-930.6" font-family="Courier,monospace" font-size="11.00">Query_Builder</text>
</a>
</g>
<!-- \\DB_Util -->
<g id="node5" class="node"><title>\\DB_Util</title>
<a xlink:href="sys.db.classes.db_util.html" xlink:title="«abstract»&lt;br/&gt;DB_Util" target="_parent">
<polygon fill="none" stroke="black" points="341,-790 257,-790 257,-754 341,-754 341,-790"/>
<text text-anchor="start" x="265" y="-777.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="275" y="-764.233" font-family="Courier,monospace" font-size="11.00">DB_Util</text>
</a>
</g>
<!-- \\PgSQL_SQL -->
<g id="node6" class="node"><title>\\PgSQL_SQL</title>
<a xlink:href="sys.db.drivers.pgsql.pgsql_sql.html" xlink:title="PgSQL_SQL" target="_parent">
<polygon fill="none" stroke="black" points="553,-628 477,-628 477,-592 553,-592 553,-628"/>
<text text-anchor="middle" x="515" y="-606.6" font-family="Courier,monospace" font-size="11.00">PgSQL_SQL</text>
</a>
</g>
<!-- \\PgSQL_SQL&#45;&gt;\\DB_SQL -->
<g id="edge6" class="edge"><title>\\PgSQL_SQL&#45;&gt;\\DB_SQL</title>
<path fill="none" stroke="black" d="M476.475,-592.687C469.629,-589.52 462.584,-586.203 456,-583 416.965,-564.012 373.105,-541.262 341.686,-524.713"/>
<polygon fill="none" stroke="black" points="343.24,-521.575 332.762,-520.003 339.972,-527.766 343.24,-521.575"/>
</g>
<!-- \\PgSQL_Util -->
<g id="node7" class="node"><title>\\PgSQL_Util</title>
<a xlink:href="sys.db.drivers.pgsql.pgsql_util.html" xlink:title="PgSQL_Util" target="_parent">
<polygon fill="none" stroke="black" points="557,-898 473,-898 473,-862 557,-862 557,-898"/>
<text text-anchor="middle" x="515" y="-876.6" font-family="Courier,monospace" font-size="11.00">PgSQL_Util</text>
</a>
</g>
<!-- \\PgSQL_Util&#45;&gt;\\DB_Util -->
<g id="edge8" class="edge"><title>\\PgSQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M474.892,-861.953C468.548,-859.01 462.078,-855.957 456,-853 416.965,-834.012 373.105,-811.262 341.686,-794.713"/>
<polygon fill="none" stroke="black" points="343.24,-791.575 332.762,-790.003 339.972,-797.766 343.24,-791.575"/>
</g>
<!-- \\PgSQL -->
<g id="node8" class="node"><title>\\PgSQL</title>
<a xlink:href="sys.db.drivers.pgsql.pgsql_driver.html" xlink:title="PgSQL" target="_parent">
<polygon fill="none" stroke="black" points="542,-358 488,-358 488,-322 542,-322 542,-358"/>
<text text-anchor="middle" x="515" y="-336.6" font-family="Courier,monospace" font-size="11.00">PgSQL</text>
</a>
</g>
<!-- \\PgSQL&#45;&gt;\\DB_PDO -->
<g id="edge10" class="edge"><title>\\PgSQL&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M487.852,-327.9C477.798,-323.333 466.332,-318.026 456,-313 416.965,-294.012 373.105,-271.262 341.686,-254.713"/>
<polygon fill="none" stroke="black" points="343.24,-251.575 332.762,-250.003 339.972,-257.766 343.24,-251.575"/>
</g>
<!-- \\ODBC_Util -->
<g id="node9" class="node"><title>\\ODBC_Util</title>
<a xlink:href="sys.db.drivers.odbc.odbc_util.html" xlink:title="ODBC_Util" target="_parent">
<polygon fill="none" stroke="black" points="553,-844 477,-844 477,-808 553,-808 553,-844"/>
<text text-anchor="middle" x="515" y="-822.6" font-family="Courier,monospace" font-size="11.00">ODBC_Util</text>
</a>
</g>
<!-- \\ODBC_Util&#45;&gt;\\DB_Util -->
<g id="edge12" class="edge"><title>\\ODBC_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M476.384,-816.346C441.629,-807.657 390.251,-794.813 351.723,-785.181"/>
<polygon fill="none" stroke="black" points="352.273,-781.711 341.723,-782.681 350.576,-788.502 352.273,-781.711"/>
</g>
<!-- \\ODBC_SQL -->
<g id="node10" class="node"><title>\\ODBC_SQL</title>
<a xlink:href="sys.db.drivers.odbc.odbc_sql.html" xlink:title="ODBC_SQL" target="_parent">
<polygon fill="none" stroke="black" points="550,-574 480,-574 480,-538 550,-538 550,-574"/>
<text text-anchor="middle" x="515" y="-552.6" font-family="Courier,monospace" font-size="11.00">ODBC_SQL</text>
</a>
</g>
<!-- \\ODBC_SQL&#45;&gt;\\DB_SQL -->
<g id="edge14" class="edge"><title>\\ODBC_SQL&#45;&gt;\\DB_SQL</title>
<path fill="none" stroke="black" d="M479.815,-547.204C444.991,-538.498 391.26,-525.065 351.41,-515.103"/>
<polygon fill="none" stroke="black" points="352.148,-511.679 341.598,-512.65 350.451,-518.47 352.148,-511.679"/>
</g>
<!-- \\ODBC -->
<g id="node11" class="node"><title>\\ODBC</title>
<a xlink:href="sys.db.drivers.odbc.odbc_driver.html" xlink:title="ODBC" target="_parent">
<polygon fill="none" stroke="black" points="542,-304 488,-304 488,-268 542,-268 542,-304"/>
<text text-anchor="middle" x="515" y="-282.6" font-family="Courier,monospace" font-size="11.00">ODBC</text>
</a>
</g>
<!-- \\ODBC&#45;&gt;\\DB_PDO -->
<g id="edge16" class="edge"><title>\\ODBC&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M487.643,-279.161C453.521,-270.63 394.445,-255.861 351.476,-245.119"/>
<polygon fill="none" stroke="black" points="352.298,-241.717 341.747,-242.687 350.6,-248.508 352.298,-241.717"/>
</g>
<!-- \\MySQL_Util -->
<g id="node12" class="node"><title>\\MySQL_Util</title>
<a xlink:href="sys.db.drivers.mysql.mysql_util.html" xlink:title="MySQL_Util" target="_parent">
<polygon fill="none" stroke="black" points="557,-790 473,-790 473,-754 557,-754 557,-790"/>
<text text-anchor="middle" x="515" y="-768.6" font-family="Courier,monospace" font-size="11.00">MySQL_Util</text>
</a>
</g>
<!-- \\MySQL_Util&#45;&gt;\\DB_Util -->
<g id="edge18" class="edge"><title>\\MySQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M472.325,-772C437.712,-772 388.759,-772 351.701,-772"/>
<polygon fill="none" stroke="black" points="351.586,-768.5 341.586,-772 351.586,-775.5 351.586,-768.5"/>
</g>
<!-- \\MySQL -->
<g id="node13" class="node"><title>\\MySQL</title>
<a xlink:href="sys.db.drivers.mysql.mysql_driver.html" xlink:title="MySQL" target="_parent">
<polygon fill="none" stroke="black" points="542,-250 488,-250 488,-214 542,-214 542,-250"/>
<text text-anchor="middle" x="515" y="-228.6" font-family="Courier,monospace" font-size="11.00">MySQL</text>
</a>
</g>
<!-- \\MySQL&#45;&gt;\\DB_PDO -->
<g id="edge20" class="edge"><title>\\MySQL&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M487.643,-232C453.593,-232 394.693,-232 351.747,-232"/>
<polygon fill="none" stroke="black" points="351.747,-228.5 341.747,-232 351.747,-235.5 351.747,-228.5"/>
</g>
<!-- \\MySQL_SQL -->
<g id="node14" class="node"><title>\\MySQL_SQL</title>
<a xlink:href="sys.db.drivers.mysql.mysql_sql.html" xlink:title="MySQL_SQL" target="_parent">
<polygon fill="none" stroke="black" points="554,-520 476,-520 476,-484 554,-484 554,-520"/>
<text text-anchor="middle" x="515" y="-498.6" font-family="Courier,monospace" font-size="11.00">MySQL_SQL</text>
</a>
</g>
<!-- \\MySQL_SQL&#45;&gt;\\DB_SQL -->
<g id="edge22" class="edge"><title>\\MySQL_SQL&#45;&gt;\\DB_SQL</title>
<path fill="none" stroke="black" d="M475.884,-502C441.213,-502 390.287,-502 351.97,-502"/>
<polygon fill="none" stroke="black" points="351.522,-498.5 341.522,-502 351.522,-505.5 351.522,-498.5"/>
</g>
<!-- \\SQLite_Util -->
<g id="node15" class="node"><title>\\SQLite_Util</title>
<a xlink:href="sys.db.drivers.sqlite.sqlite_util.html" xlink:title="SQLite_Util" target="_parent">
<polygon fill="none" stroke="black" points="560,-736 470,-736 470,-700 560,-700 560,-736"/>
<text text-anchor="middle" x="515" y="-714.6" font-family="Courier,monospace" font-size="11.00">SQLite_Util</text>
</a>
</g>
<!-- \\SQLite_Util&#45;&gt;\\DB_Util -->
<g id="edge24" class="edge"><title>\\SQLite_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M469.456,-729.386C434.949,-738.013 387.482,-749.879 351.4,-758.9"/>
<polygon fill="none" stroke="black" points="350.398,-755.543 341.545,-761.364 352.096,-762.334 350.398,-755.543"/>
</g>
<!-- \\SQLite -->
<g id="node16" class="node"><title>\\SQLite</title>
<a xlink:href="sys.db.drivers.sqlite.sqlite_driver.html" xlink:title="SQLite" target="_parent">
<polygon fill="none" stroke="black" points="543,-196 487,-196 487,-160 543,-160 543,-196"/>
<text text-anchor="middle" x="515" y="-174.6" font-family="Courier,monospace" font-size="11.00">SQLite</text>
</a>
</g>
<!-- \\SQLite&#45;&gt;\\DB_PDO -->
<g id="edge26" class="edge"><title>\\SQLite&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M486.317,-185.171C452.001,-193.75 393.875,-208.281 351.456,-218.886"/>
<polygon fill="none" stroke="black" points="350.429,-215.535 341.577,-221.356 352.127,-222.326 350.429,-215.535"/>
</g>
<!-- \\SQLite_SQL -->
<g id="node17" class="node"><title>\\SQLite_SQL</title>
<a xlink:href="sys.db.drivers.sqlite.sqlite_sql.html" xlink:title="SQLite_SQL" target="_parent">
<polygon fill="none" stroke="black" points="557,-466 473,-466 473,-430 557,-430 557,-466"/>
<text text-anchor="middle" x="515" y="-444.6" font-family="Courier,monospace" font-size="11.00">SQLite_SQL</text>
</a>
</g>
<!-- \\SQLite_SQL&#45;&gt;\\DB_SQL -->
<g id="edge28" class="edge"><title>\\SQLite_SQL&#45;&gt;\\DB_SQL</title>
<path fill="none" stroke="black" d="M472.84,-458.54C438.276,-467.181 389.162,-479.46 351.95,-488.763"/>
<polygon fill="none" stroke="black" points="350.644,-485.481 341.792,-491.302 352.342,-492.272 350.644,-485.481"/>
</g>
<!-- \\Firebird_SQL -->
<g id="node18" class="node"><title>\\Firebird_SQL</title>
<a xlink:href="sys.db.drivers.firebird.firebird_sql.html" xlink:title="Firebird_SQL" target="_parent">
<polygon fill="none" stroke="black" points="563,-412 467,-412 467,-376 563,-376 563,-412"/>
<text text-anchor="middle" x="515" y="-390.6" font-family="Courier,monospace" font-size="11.00">Firebird_SQL</text>
</a>
</g>
<!-- \\Firebird_SQL&#45;&gt;\\DB_SQL -->
<g id="edge30" class="edge"><title>\\Firebird_SQL&#45;&gt;\\DB_SQL</title>
<path fill="none" stroke="black" d="M474.892,-412.047C468.548,-414.99 462.078,-418.043 456,-421 416.965,-439.988 373.105,-462.738 341.686,-479.287"/>
<polygon fill="none" stroke="black" points="339.972,-476.234 332.762,-483.997 343.24,-482.425 339.972,-476.234"/>
</g>
<!-- \\Firebird_Result -->
<g id="node19" class="node"><title>\\Firebird_Result</title>
<a xlink:href="sys.db.drivers.firebird.firebird_result.html" xlink:title="Firebird_Result" target="_parent">
<polygon fill="none" stroke="black" points="573,-88 457,-88 457,-52 573,-52 573,-88"/>
<text text-anchor="middle" x="515" y="-66.6" font-family="Courier,monospace" font-size="11.00">Firebird_Result</text>
</a>
</g>
<!-- \\PDOStatement -->
<g id="node48" class="node"><title>\\PDOStatement</title>
<ellipse fill="none" stroke="black" cx="299" cy="-18" rx="85.1942" ry="18"/>
<text text-anchor="middle" x="299" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDOStatement</text>
</g>
<!-- \\Firebird_Result&#45;&gt;\\PDOStatement -->
<g id="edge32" class="edge"><title>\\Firebird_Result&#45;&gt;\\PDOStatement</title>
<path fill="none" stroke="black" d="M456.262,-55.8595C428.213,-49.1069 394.522,-40.996 365.531,-34.0167"/>
<polygon fill="none" stroke="black" points="366.031,-30.5372 355.49,-31.5994 364.393,-37.3428 366.031,-30.5372"/>
</g>
<!-- \\Firebird -->
<g id="node20" class="node"><title>\\Firebird</title>
<a xlink:href="sys.db.drivers.firebird.firebird_driver.html" xlink:title="Firebird" target="_parent">
<polygon fill="none" stroke="black" points="550,-142 480,-142 480,-106 550,-106 550,-142"/>
<text text-anchor="middle" x="515" y="-120.6" font-family="Courier,monospace" font-size="11.00">Firebird</text>
</a>
</g>
<!-- \\Firebird&#45;&gt;\\DB_PDO -->
<g id="edge34" class="edge"><title>\\Firebird&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M479.906,-138.262C471.844,-142.026 463.454,-146.349 456,-151 420.9,-172.9 420.888,-191.268 384,-210 374.01,-215.073 362.75,-219.046 351.773,-222.133"/>
<polygon fill="none" stroke="black" points="350.611,-218.819 341.815,-224.725 352.375,-225.593 350.611,-218.819"/>
</g>
<!-- \\Firebird_Util -->
<g id="node21" class="node"><title>\\Firebird_Util</title>
<a xlink:href="sys.db.drivers.firebird.firebird_util.html" xlink:title="Firebird_Util" target="_parent">
<polygon fill="none" stroke="black" points="567,-682 463,-682 463,-646 567,-646 567,-682"/>
<text text-anchor="middle" x="515" y="-660.6" font-family="Courier,monospace" font-size="11.00">Firebird_Util</text>
</a>
</g>
<!-- \\Firebird_Util&#45;&gt;\\DB_Util -->
<g id="edge36" class="edge"><title>\\Firebird_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M474.892,-682.047C468.548,-684.99 462.078,-688.043 456,-691 416.965,-709.988 373.105,-732.738 341.686,-749.287"/>
<polygon fill="none" stroke="black" points="339.972,-746.234 332.762,-753.997 343.24,-752.425 339.972,-746.234"/>
</g>
<!-- \\miniMVC\\Page -->
<g id="node2" class="node"><title>\\miniMVC\\Page</title>
<g id="node23" class="node"><title>\\miniMVC\\Page</title>
<a xlink:href="sys.core.Page.html" xlink:title="Page" target="_parent">
<polygon fill="none" stroke="black" points="643,-358 589,-358 589,-322 643,-322 643,-358"/>
<text text-anchor="middle" x="616" y="-336.6" font-family="Courier,monospace" font-size="11.00">Page</text>
<polygon fill="none" stroke="black" points="715,-1282 661,-1282 661,-1246 715,-1246 715,-1282"/>
<text text-anchor="middle" x="688" y="-1260.6" font-family="Courier,monospace" font-size="11.00">Page</text>
</a>
</g>
<!-- \\miniMVC\\Output -->
<g id="node8" class="node"><title>\\miniMVC\\Output</title>
<g id="node29" class="node"><title>\\miniMVC\\Output</title>
<a xlink:href="sys.core.Output.html" xlink:title="Output" target="_parent">
<polygon fill="none" stroke="black" points="449,-358 393,-358 393,-322 449,-322 449,-358"/>
<text text-anchor="middle" x="421" y="-336.6" font-family="Courier,monospace" font-size="11.00">Output</text>
<polygon fill="none" stroke="black" points="543,-1282 487,-1282 487,-1246 543,-1246 543,-1282"/>
<text text-anchor="middle" x="515" y="-1260.6" font-family="Courier,monospace" font-size="11.00">Output</text>
</a>
</g>
<!-- \\miniMVC\\Page&#45;&gt;\\miniMVC\\Output -->
<g id="edge3" class="edge"><title>\\miniMVC\\Page&#45;&gt;\\miniMVC\\Output</title>
<path fill="none" stroke="black" d="M588.886,-340C555.406,-340 498.218,-340 460.02,-340"/>
<polygon fill="none" stroke="black" points="459.786,-336.5 449.786,-340 459.786,-343.5 459.786,-336.5"/>
<g id="edge38" class="edge"><title>\\miniMVC\\Page&#45;&gt;\\miniMVC\\Output</title>
<path fill="none" stroke="black" d="M660.969,-1264C632.156,-1264 586.282,-1264 553.656,-1264"/>
<polygon fill="none" stroke="black" points="553.567,-1260.5 543.567,-1264 553.567,-1267.5 553.567,-1260.5"/>
</g>
<!-- \\miniMVC\\Model -->
<g id="node3" class="node"><title>\\miniMVC\\Model</title>
<g id="node24" class="node"><title>\\miniMVC\\Model</title>
<a xlink:href="sys.core.Model.html" xlink:title="Model" target="_parent">
<polygon fill="none" stroke="black" points="643,-304 589,-304 589,-268 643,-268 643,-304"/>
<text text-anchor="middle" x="616" y="-282.6" font-family="Courier,monospace" font-size="11.00">Model</text>
<polygon fill="none" stroke="black" points="715,-1228 661,-1228 661,-1192 715,-1192 715,-1228"/>
<text text-anchor="middle" x="688" y="-1206.6" font-family="Courier,monospace" font-size="11.00">Model</text>
</a>
</g>
<!-- \\miniMVC\\miniMVC -->
<g id="node6" class="node"><title>\\miniMVC\\miniMVC</title>
<g id="node27" class="node"><title>\\miniMVC\\miniMVC</title>
<a xlink:href="sys.core.miniMVC.html" xlink:title="miniMVC" target="_parent">
<polygon fill="none" stroke="black" points="453,-304 389,-304 389,-268 453,-268 453,-304"/>
<text text-anchor="middle" x="421" y="-282.6" font-family="Courier,monospace" font-size="11.00">miniMVC</text>
<polygon fill="none" stroke="black" points="547,-1228 483,-1228 483,-1192 547,-1192 547,-1228"/>
<text text-anchor="middle" x="515" y="-1206.6" font-family="Courier,monospace" font-size="11.00">miniMVC</text>
</a>
</g>
<!-- \\miniMVC\\Model&#45;&gt;\\miniMVC\\miniMVC -->
<g id="edge5" class="edge"><title>\\miniMVC\\Model&#45;&gt;\\miniMVC\\miniMVC</title>
<path fill="none" stroke="black" d="M588.886,-286C556.554,-286 502.111,-286 464.015,-286"/>
<polygon fill="none" stroke="black" points="463.735,-282.5 453.735,-286 463.735,-289.5 463.735,-282.5"/>
<g id="edge40" class="edge"><title>\\miniMVC\\Model&#45;&gt;\\miniMVC\\miniMVC</title>
<path fill="none" stroke="black" d="M660.969,-1210C633.357,-1210 590.075,-1210 557.801,-1210"/>
<polygon fill="none" stroke="black" points="557.743,-1206.5 547.743,-1210 557.743,-1213.5 557.743,-1206.5"/>
</g>
<!-- \\miniMVC\\Controller -->
<g id="node4" class="node"><title>\\miniMVC\\Controller</title>
<g id="node25" class="node"><title>\\miniMVC\\Controller</title>
<a xlink:href="sys.core.Controller.html" xlink:title="Controller" target="_parent">
<polygon fill="none" stroke="black" points="658,-250 574,-250 574,-214 658,-214 658,-250"/>
<text text-anchor="middle" x="616" y="-228.6" font-family="Courier,monospace" font-size="11.00">Controller</text>
<polygon fill="none" stroke="black" points="730,-1174 646,-1174 646,-1138 730,-1138 730,-1174"/>
<text text-anchor="middle" x="688" y="-1152.6" font-family="Courier,monospace" font-size="11.00">Controller</text>
</a>
</g>
<!-- \\miniMVC\\Controller&#45;&gt;\\miniMVC\\miniMVC -->
<g id="edge7" class="edge"><title>\\miniMVC\\Controller&#45;&gt;\\miniMVC\\miniMVC</title>
<path fill="none" stroke="black" d="M573.796,-243.939C552.313,-249.992 525.778,-257.434 502,-264 489.476,-267.459 475.85,-271.177 463.409,-274.554"/>
<polygon fill="none" stroke="black" points="462.465,-271.184 453.729,-277.178 464.296,-277.94 462.465,-271.184"/>
<g id="edge42" class="edge"><title>\\miniMVC\\Controller&#45;&gt;\\miniMVC\\miniMVC</title>
<path fill="none" stroke="black" d="M645.679,-1169.21C618.892,-1177.57 584.377,-1188.34 557.547,-1196.72"/>
<polygon fill="none" stroke="black" points="556.175,-1193.48 547.672,-1199.8 558.26,-1200.16 556.175,-1193.48"/>
</g>
<!-- \\miniMVC\\DB -->
<g id="node5" class="node"><title>\\miniMVC\\DB</title>
<g id="node26" class="node"><title>\\miniMVC\\DB</title>
<a xlink:href="sys.core.db.html" xlink:title="DB" target="_parent">
<polygon fill="none" stroke="black" points="643,-196 589,-196 589,-160 643,-160 643,-196"/>
<text text-anchor="middle" x="616" y="-174.6" font-family="Courier,monospace" font-size="11.00">DB</text>
<polygon fill="none" stroke="black" points="715,-1120 661,-1120 661,-1084 715,-1084 715,-1120"/>
<text text-anchor="middle" x="688" y="-1098.6" font-family="Courier,monospace" font-size="11.00">DB</text>
</a>
</g>
<!-- \\Query_Builder -->
<g id="node15" class="node"><title>\\Query_Builder</title>
<ellipse fill="none" stroke="black" cx="421" cy="-18" rx="81.1693" ry="18"/>
<text text-anchor="middle" x="421" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\Query_Builder</text>
</g>
<!-- \\miniMVC\\DB&#45;&gt;\\Query_Builder -->
<g id="edge9" class="edge"><title>\\miniMVC\\DB&#45;&gt;\\Query_Builder</title>
<path fill="none" stroke="black" d="M588.952,-163.032C583.679,-159.467 578.422,-155.404 574,-151 532.335,-109.505 549.504,-74.6572 502,-40 498.936,-37.7643 495.657,-35.7559 492.239,-33.9515"/>
<polygon fill="none" stroke="black" points="493.464,-30.6617 482.919,-29.6361 490.523,-37.0139 493.464,-30.6617"/>
<g id="edge44" class="edge"><title>\\miniMVC\\DB&#45;&gt;\\Query_Builder</title>
<path fill="none" stroke="black" d="M660.77,-1087.21C655.511,-1083.63 650.305,-1079.52 646,-1075 606.717,-1033.77 624.268,-1002.16 582,-964 579.415,-961.666 576.618,-959.488 573.684,-957.461"/>
<polygon fill="none" stroke="black" points="575.457,-954.441 565.116,-952.136 571.762,-960.387 575.457,-954.441"/>
</g>
<!-- \\miniMVC\\MM -->
<g id="node7" class="node"><title>\\miniMVC\\MM</title>
<g id="node28" class="node"><title>\\miniMVC\\MM</title>
<a xlink:href="sys.core.MM.html" xlink:title="MM" target="_parent">
<polygon fill="none" stroke="black" points="268,-331 214,-331 214,-295 268,-295 268,-331"/>
<text text-anchor="middle" x="241" y="-309.6" font-family="Courier,monospace" font-size="11.00">MM</text>
<polygon fill="none" stroke="black" points="326,-1255 272,-1255 272,-1219 326,-1219 326,-1255"/>
<text text-anchor="middle" x="299" y="-1233.6" font-family="Courier,monospace" font-size="11.00">MM</text>
</a>
</g>
<!-- \\miniMVC\\miniMVC&#45;&gt;\\miniMVC\\MM -->
<g id="edge11" class="edge"><title>\\miniMVC\\miniMVC&#45;&gt;\\miniMVC\\MM</title>
<path fill="none" stroke="black" d="M388.403,-290.889C357.322,-295.552 310.563,-302.566 278.075,-307.439"/>
<polygon fill="none" stroke="black" points="277.437,-303.995 268.067,-308.94 278.475,-310.918 277.437,-303.995"/>
<g id="edge46" class="edge"><title>\\miniMVC\\miniMVC&#45;&gt;\\miniMVC\\MM</title>
<path fill="none" stroke="black" d="M482.194,-1214.1C443.001,-1219 377.58,-1227.18 336.444,-1232.32"/>
<polygon fill="none" stroke="black" points="335.775,-1228.88 326.286,-1233.59 336.643,-1235.82 335.775,-1228.88"/>
</g>
<!-- \\ArrayObject -->
<g id="node18" class="node"><title>\\ArrayObject</title>
<ellipse fill="none" stroke="black" cx="71" cy="-313" rx="71.107" ry="18"/>
<text text-anchor="middle" x="71" y="-308.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\ArrayObject</text>
<g id="node57" class="node"><title>\\ArrayObject</title>
<ellipse fill="none" stroke="black" cx="71" cy="-1237" rx="71.107" ry="18"/>
<text text-anchor="middle" x="71" y="-1232.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\ArrayObject</text>
</g>
<!-- \\miniMVC\\MM&#45;&gt;\\ArrayObject -->
<g id="edge13" class="edge"><title>\\miniMVC\\MM&#45;&gt;\\ArrayObject</title>
<path fill="none" stroke="black" d="M213.687,-313C196.92,-313 174.483,-313 152.374,-313"/>
<polygon fill="none" stroke="black" points="152.26,-309.5 142.26,-313 152.26,-316.5 152.26,-309.5"/>
<g id="edge48" class="edge"><title>\\miniMVC\\MM&#45;&gt;\\ArrayObject</title>
<path fill="none" stroke="black" d="M271.95,-1237C242.636,-1237 194.438,-1237 152.593,-1237"/>
<polygon fill="none" stroke="black" points="152.386,-1233.5 142.386,-1237 152.386,-1240.5 152.386,-1233.5"/>
</g>
<!-- \\miniMVC\\Output&#45;&gt;\\miniMVC\\MM -->
<g id="edge15" class="edge"><title>\\miniMVC\\Output&#45;&gt;\\miniMVC\\MM</title>
<path fill="none" stroke="black" d="M392.478,-335.722C361.574,-331.086 312.145,-323.672 278.207,-318.581"/>
<polygon fill="none" stroke="black" points="278.618,-315.104 268.21,-317.081 277.58,-322.026 278.618,-315.104"/>
<g id="edge50" class="edge"><title>\\miniMVC\\Output&#45;&gt;\\miniMVC\\MM</title>
<path fill="none" stroke="black" d="M486.317,-1260.41C447.621,-1255.58 378.648,-1246.96 336.062,-1241.63"/>
<polygon fill="none" stroke="black" points="336.455,-1238.15 326.098,-1240.39 335.586,-1245.1 336.455,-1238.15"/>
</g>
<!-- \\miniMVC\\Data_Store -->
<g id="node9" class="node"><title>\\miniMVC\\Data_Store</title>
<a xlink:href="sys.libraries.data_store.html" xlink:title="Data_Store" target="_parent">
<polygon fill="none" stroke="black" points="658,-142 574,-142 574,-106 658,-106 658,-142"/>
<text text-anchor="middle" x="616" y="-120.6" font-family="Courier,monospace" font-size="11.00">Data_Store</text>
<!-- \\miniMVC\\Session -->
<g id="node30" class="node"><title>\\miniMVC\\Session</title>
<a xlink:href="sys.libraries.Session.html" xlink:title="Session" target="_parent">
<polygon fill="none" stroke="black" points="720,-1066 656,-1066 656,-1030 720,-1030 720,-1066"/>
<text text-anchor="middle" x="688" y="-1044.6" font-family="Courier,monospace" font-size="11.00">Session</text>
</a>
</g>
<!-- \\miniMVC\\Session -->
<g id="node10" class="node"><title>\\miniMVC\\Session</title>
<a xlink:href="sys.libraries.session.html" xlink:title="Session" target="_parent">
<polygon fill="none" stroke="black" points="648,-88 584,-88 584,-52 648,-52 648,-88"/>
<text text-anchor="middle" x="616" y="-66.6" font-family="Courier,monospace" font-size="11.00">Session</text>
<!-- \\miniMVC\\Data_Store -->
<g id="node31" class="node"><title>\\miniMVC\\Data_Store</title>
<a xlink:href="sys.libraries.Data_Store.html" xlink:title="Data_Store" target="_parent">
<polygon fill="none" stroke="black" points="730,-1012 646,-1012 646,-976 730,-976 730,-1012"/>
<text text-anchor="middle" x="688" y="-990.6" font-family="Courier,monospace" font-size="11.00">Data_Store</text>
</a>
</g>
</g>


+ 714
- 0
docs/classes/DB_PDO.html View File

@@ -0,0 +1,714 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>miniMVC » \DB_PDO</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">5</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: PDO constructor wrapper"><span class="description">PDO constructor wrapper</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
</span><pre>__sleep()</pre></a></li>
<li class="method public "><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
</span><pre>__wakeup()</pre></a></li>
<li class="method public "><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
<li class="method public "><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
</span><pre>beginTransaction()</pre></a></li>
<li class="method public "><a href="#commit" title="commit :: "><span class="description">commit()
</span><pre>commit()</pre></a></li>
<li class="method public "><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
<li class="method public "><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
<li class="method public "><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
</span><pre>errorCode()</pre></a></li>
<li class="method public "><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
</span><pre>errorInfo()</pre></a></li>
<li class="method public "><a href="#exec" title="exec :: "><span class="description">exec()
</span><pre>exec()</pre></a></li>
<li class="method public "><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
</span><pre>getAttribute()</pre></a></li>
<li class="method public "><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
</span><pre>getAvailableDrivers()</pre></a></li>
<li class="method public "><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
<li class="method public "><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public "><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
<li class="method public "><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public "><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
<li class="method public "><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public "><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
<li class="method public "><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public "><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
the connection/database"><span class="description">Retreives an array of non-user-created tables for
the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public "><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
<li class="method public "><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
<li class="method public "><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
<li class="method public "><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
<li class="method public "><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
</span><pre>inTransaction()</pre></a></li>
<li class="method public "><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
</span><pre>lastInsertId()</pre></a></li>
<li class="method public "><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
<li class="method public "><a href="#prepare" title="prepare :: "><span class="description">prepare()
</span><pre>prepare()</pre></a></li>
<li class="method public "><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
<li class="method public "><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
<li class="method public "><a href="#query" title="query :: "><span class="description">query()
</span><pre>query()</pre></a></li>
<li class="method public "><a href="#quote" title="quote :: "><span class="description">quote()
</span><pre>quote()</pre></a></li>
<li class="method public "><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
<li class="method public "><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
</span><pre>rollBack()</pre></a></li>
<li class="method public "><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
</span><pre>setAttribute()</pre></a></li>
<li class="method public "><a href="#switch_db" title="switch_db :: Connect to a different database"><span class="description">Connect to a different database</span><pre>switch_db()</pre></a></li>
<li class="method public "><a href="#truncate" title="truncate :: Empty the passed table"><span class="description">Empty the passed table</span><pre>truncate()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected "><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public "><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
<li class="property public "><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
<li class="property protected "><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CDB_PDO" id="\DB_PDO"></a><div href="../classes/DB_PDO.html" class="element class">
<p class="short_description">Base Database class</p>
<div class="details">
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Query</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>PDO constructor wrapper</h2>
<pre>__construct(string $dsn, string $username, string $password, array $driver_options) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$dsn</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$username</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$password</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$driver_options</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
<h2>__sleep()
</h2>
<pre>__sleep() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::__sleep()</td>
</tr></table>
</div></div>
</div>
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
<h2>__wakeup()
</h2>
<pre>__wakeup() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::__wakeup()</td>
</tr></table>
</div></div>
</div>
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
<h2>beginTransaction()
</h2>
<pre>beginTransaction() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::beginTransaction()</td>
</tr></table>
</div></div>
</div>
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
<h2>commit()
</h2>
<pre>commit() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::commit()</td>
</tr></table>
</div></div>
</div>
<a name="driver_query" id="driver_query"></a><div class="element clickable method public driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
<h2>Method to simplify retreiving db results for meta-data queries</h2>
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$filtered_index</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
<h2>Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</h2>
<pre>empty_table(string $table) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
<h2>errorCode()
</h2>
<pre>errorCode() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::errorCode()</td>
</tr></table>
</div></div>
</div>
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
<h2>errorInfo()
</h2>
<pre>errorInfo() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::errorInfo()</td>
</tr></table>
</div></div>
</div>
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
<h2>exec()
</h2>
<pre>exec() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::exec()</td>
</tr></table>
</div></div>
</div>
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
<h2>getAttribute()
</h2>
<pre>getAttribute() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::getAttribute()</td>
</tr></table>
</div></div>
</div>
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
<h2>getAvailableDrivers()
</h2>
<pre>getAvailableDrivers() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::getAvailableDrivers()</td>
</tr></table>
</div></div>
</div>
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
<h2>Retrieve column information for the current database table</h2>
<pre>get_columns(string $table) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
<h2>Return list of dbs for the current connection, if possible</h2>
<pre>get_dbs() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
<h2>Return list of function for the current database</h2>
<pre>get_functions() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
<h2>Return the last error for the current database connection</h2>
<pre>get_last_error() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
<h2>Return list of stored procedures for the current database</h2>
<pre>get_procedures() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
<h2>Retreives the data from a select query</h2>
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
<h2>Return schemas for databases that list them</h2>
<pre>get_schemas() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
<h2>Return list of sequences for the current database, if they exist</h2>
<pre>get_sequences() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
<h2>Retreives an array of non-user-created tables for
the connection/database</h2>
<pre>get_system_tables() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
<h2>Return list of tables for the current database</h2>
<pre>get_tables() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
<h2>Return list of triggers for the current database</h2>
<pre>get_triggers() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
<h2>Retrieve list of data types for the database</h2>
<pre>get_types() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
<h2>Return list of views for the current database</h2>
<pre>get_views() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
<h2>inTransaction()
</h2>
<pre>inTransaction() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::inTransaction()</td>
</tr></table>
</div></div>
</div>
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
<h2>lastInsertId()
</h2>
<pre>lastInsertId() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::lastInsertId()</td>
</tr></table>
</div></div>
</div>
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
<h2>Return the number of rows returned for a SELECT query</h2>
<pre>num_rows() : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
<h2>prepare()
</h2>
<pre>prepare() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::prepare()</td>
</tr></table>
</div></div>
</div>
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
<h2>Create and execute a prepared statement with the provided parameters</h2>
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
</div></div>
</div>
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
<h2>Simplifies prepared statements for database queries</h2>
<pre>prepare_query(string $sql, array $data) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>PDOStatement / FALSE</div>
</div></div>
</div>
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
<h2>query()
</h2>
<pre>query() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::query()</td>
</tr></table>
</div></div>
</div>
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
<h2>quote()
</h2>
<pre>quote() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::quote()</td>
</tr></table>
</div></div>
</div>
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
<h2>Surrounds the string with the databases identifier escape characters</h2>
<pre>quote_ident(mixed $ident) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$ident</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
<h2>rollBack()
</h2>
<pre>rollBack() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::rollBack()</td>
</tr></table>
</div></div>
</div>
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
<h2>setAttribute()
</h2>
<pre>setAttribute() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>PDO::setAttribute()</td>
</tr></table>
</div></div>
</div>
<a name="switch_db" id="switch_db"></a><div class="element clickable method public switch_db" data-toggle="collapse" data-target=".switch_db .collapse">
<h2>Connect to a different database</h2>
<pre>switch_db(string $name) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
<h2>Empty the passed table</h2>
<pre>truncate(string $table) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
<h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
<h2>Reference to sql sub class</h2>
<pre>$sql : Object</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
<h2>Reference to util sub class</h2>
<pre>$util : Object</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
<h2>Character to escape identifiers</h2>
<pre>$escape_char : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
<h2>Reference to the last executed query</h2>
<pre>$statement : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-06-06T16:50:20-04:00.<br></footer></div>
</div>
</body>
</html>

+ 306
- 0
docs/classes/DB_SQL.html View File

@@ -0,0 +1,306 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>miniMVC » \DB_SQL</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">5</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
<li class="method public "><a href="#column_list" title="column_list :: Get information about the columns in the
specified table"><span class="description">Get information about the columns in the
specified table</span><pre>column_list()</pre></a></li>
<li class="method public "><a href="#db_list" title="db_list :: Returns sql to list other databases"><span class="description">Returns sql to list other databases</span><pre>db_list()</pre></a></li>
<li class="method public "><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
<li class="method public "><a href="#limit" title="limit :: Get database specific sql for limit clause"><span class="description">Get database specific sql for limit clause</span><pre>limit()</pre></a></li>
<li class="method public "><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
<li class="method public "><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
<li class="method public "><a href="#random" title="random :: Get the sql for random ordering"><span class="description">Get the sql for random ordering</span><pre>random()</pre></a></li>
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
<li class="method public "><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
<li class="method public "><a href="#type_list" title="type_list :: Return sql to list database field types"><span class="description">Return sql to list database field types</span><pre>type_list()</pre></a></li>
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CDB_SQL" id="\DB_SQL"></a><div href="../classes/DB_SQL.html" class="element class">
<p class="short_description">Abstract parent for database manipulation subclasses</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Query</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
<h2>Get the 'average' keyword</h2>
<pre>avg() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
<h2>Get information about the columns in the
specified table</h2>
<pre>column_list($table) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code></code><p>string</p></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse">
<h2>Returns sql to list other databases</h2>
<pre>db_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
<h2>Get the 'distinct' keyword</h2>
<pre>distinct() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
<h2>Return sql to list functions</h2>
<pre>function_list() : FALSE</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>FALSE</code></div>
</div></div>
</div>
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
<h2>Get database specific sql for limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$limit</h4>
<code>int</code>
</div>
<div class="subelement argument">
<h4>$offset</h4>
<code>int</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
<h2>Get the max keyword sql</h2>
<pre>max() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
<h2>Get the min keyword sql</h2>
<pre>min() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse">
<h2>Get the sql for random ordering</h2>
<pre>random() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse">
<h2>Return sql to list sequences</h2>
<pre>sequence_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
<h2>Get the 'sum' keyword</h2>
<pre>sum() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
<h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse">
<h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse">
<h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse">
<h2>Return sql to list database field types</h2>
<pre>type_list() : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse">
<h2>Returns sql to list views</h2>
<pre>view_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-06-06T16:50:20-04:00.<br></footer></div>
</div>
</body>
</html>

+ 217
- 0
docs/classes/DB_Util.html View File

@@ -0,0 +1,217 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>miniMVC » \DB_Util</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">5</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the connection object for later use"><span class="description">Save a reference to the connection object for later use</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#backup_data" title="backup_data :: Return an SQL file with the database data as insert statements"><span class="description">Return an SQL file with the database data as insert statements</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#backup_structure" title="backup_structure :: Return an SQL file with the database table structure"><span class="description">Return an SQL file with the database table structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#create_table" title="create_table :: Get database-specific sql to create a new table"><span class="description">Get database-specific sql to create a new table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#delete_table" title="delete_table :: Get database-specific sql to drop a table"><span class="description">Get database-specific sql to drop a table</span><pre>delete_table()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CDB_Util" id="\DB_Util"></a><div href="../classes/DB_Util.html" class="element class">
<p class="short_description">Abstract class defining database / table creation methods</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Query.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Query</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
<h2>Enable calling driver methods</h2>
<pre>__call(string $method, array $args) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$args</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Save a reference to the connection object for later use</h2>
<pre>__construct(object $conn) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$conn</h4>
<code>object</code><p>&$conn</p>
</div>
</div></div>
</div>
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse">
<h2>Return an SQL file with the database data as insert statements</h2>
<pre>backup_data() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse">
<h2>Return an SQL file with the database table structure</h2>
<pre>backup_structure() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse">
<h2>Get database-specific sql to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$columns</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$constraints</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$indexes</h4>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse">
<h2>Get database-specific sql to drop a table</h2>
<pre>delete_table(string $name) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>abstract</th>
<td></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
<h2>Reference to the current connection object</h2>
<pre>$conn </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-06-06T16:50:20-04:00.<br></footer></div>
</div>
</body>
</html>

+ 876
- 0
docs/classes/Firebird.html View File

@@ -0,0 +1,876 @@
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>miniMVC » \Firebird</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">5</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Open the link to the database"><span class="description">Open the link to the database</span><pre>__construct()</pre></a></li>
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
</span><pre>__sleep()</pre></a></li>
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
</span><pre>__wakeup()</pre></a></li>
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
<li class="method public "><a href="#beginTransaction" title="beginTransaction :: Start a database transaction"><span class="description">Start a database transaction</span><pre>beginTransaction()</pre></a></li>
<li class="method public "><a href="#commit" title="commit :: Commit a database transaction"><span class="description">Commit a database transaction</span><pre>commit()</pre></a></li>
<li class="method public inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
<li class="method public "><a href="#errorCode" title="errorCode :: Method to emulate PDO-&gt;errorCode"><span class="description">Method to emulate PDO-&gt;errorCode</span><pre>errorCode()</pre></a></li>
<li class="method public "><a href="#errorInfo" title="errorInfo :: Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo"><span class="description">Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</span><pre>errorInfo()</pre></a></li>
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
</span><pre>exec()</pre></a></li>
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
</span><pre>getAttribute()</pre></a></li>
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
</span><pre>getAvailableDrivers()</pre></a></li>
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
<li class="method public inherited"><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
the connection/database"><span class="description">Retreives an array of non-user-created tables for
the connection/database</span><pre>get_system_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
</span><pre>inTransaction()</pre></a></li>
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
</span><pre>lastInsertId()</pre></a></li>
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
<li class="method public "><a href="#prepare" title="prepare :: Emulate PDO prepare"><span class="description">Emulate PDO prepare</span><pre>prepare()</pre></a></li>
<li class="method public "><a href="#prepare_execute" title="prepare_execute :: Prepare and execute a query"><span class="description">Prepare and execute a query</span><pre>prepare_execute()</pre></a></li>
<li class="method public "><a href="#prepare_query" title="prepare_query :: Bind a prepared query with arguments for executing"><span class="description">Bind a prepared query with arguments for executing</span><pre>prepare_query()</pre></a></li>
<li class="method public "><a href="#query" title="query :: Wrapper public function to better match PDO"><span class="description">Wrapper public function to better match PDO</span><pre>query()</pre></a></li>
<li class="method public "><a href="#quote" title="quote :: Method to emulate PDO-&gt;quote"><span class="description">Method to emulate PDO-&gt;quote</span><pre>quote()</pre></a></li>
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
<li class="method public "><a href="#rollBack" title="rollBack :: Rollback a transaction"><span class="description">Rollback a transaction</span><pre>rollBack()</pre></a></li>
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
</span><pre>setAttribute()</pre></a></li>
<li class="method public "><a href="#switch_db" title="switch_db :: Doesn't apply to Firebird"><span class="description">Doesn't apply to Firebird</span><pre>switch_db()</pre></a></li>
<li class="method public "><a href="#truncate" title="truncate :: Empty a database table"><span class="description">Empty a database table</span><pre>truncate()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24conn" title="$conn :: Reference to the connection resource"><span class="description">Reference to the connection resource</span><pre>$conn</pre></a></li>
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
<li class="property protected "><a href="#%24statement" title="$statement :: Reference to the last query executed"><span class="description">Reference to the last query executed</span><pre>$statement</pre></a></li>
<li class="property protected "><a href="#%24statement_link" title="$statement_link :: Reference to the resource returned by
the last query executed"><span class="description">Reference to the resource returned by
the last query executed</span><pre>$statement_link</pre></a></li>
<li class="property protected "><a href="#%24trans" title="$trans :: Reference to the current transaction"><span class="description">Reference to the current transaction</span><pre>$trans</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CFirebird" id="\Firebird"></a><div href="../classes/Firebird.html" class="element class">
<p class="short_description">Firebird Database class</p>
<div class="details">
<p class="long_description"><p>PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.</p></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Drivers</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Open the link to the database</h2>
<pre>__construct(string $dbpath, string $user, string $pass) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$dbpath</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$user</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$pass</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
<h2>__sleep()
</h2>
<pre>__sleep() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>PDO::__sleep()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__sleep()</td>
</tr>
</table>
</div></div>
</div>
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
<h2>__wakeup()
</h2>
<pre>__wakeup() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>PDO::__wakeup()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\DB_PDO::__wakeup()</td>
</tr>
</table>
</div></div>
</div>
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\DB_PDO::affected_rows()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
<h2>Start a database transaction</h2>
<pre>beginTransaction() : bool</pre>