aviat/Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity

Update docs

Browse Source
This commit is contained in:
Timothy Warren 2014-03-31 13:32:35 -04:00
parent 23c1cf0e5b
commit 621c2b7d91
34 changed files with 5550 additions and 3983 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

363
docs/classes.svg
View File

@ -4,243 +4,244 @@
<!-- Generated by graphviz version 2.26.3 (20100126.1600)
-->
<!-- Title: G Pages: 1 -->
<svg width="687pt" height="1105pt"
viewBox="0.00 0.00 687.00 1105.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 1101)">
<svg width="710pt" height="1051pt"
viewBox="0.00 0.00 710.00 1051.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 1047)">
<title>G</title>
<polygon fill="white" stroke="white" points="-4,5 -4,-1101 684,-1101 684,5 -4,5"/>
<polygon fill="white" stroke="white" points="-4,5 -4,-1047 707,-1047 707,5 -4,5"/>
<g id="graph2" class="cluster"><title>cluster_Global</title>
<polyline fill="none" stroke="gray" points="20,-152 659,-152 "/>
<path fill="none" stroke="gray" d="M659,-152C665,-152 671,-158 671,-164"/>
<polyline fill="none" stroke="gray" points="671,-164 671,-1077 "/>
<path fill="none" stroke="gray" d="M671,-1077C671,-1083 665,-1089 659,-1089"/>
<polyline fill="none" stroke="gray" points="659,-1089 20,-1089 "/>
<path fill="none" stroke="gray" d="M20,-1089C14,-1089 8,-1083 8,-1077"/>
<polyline fill="none" stroke="gray" points="8,-1077 8,-164 "/>
<path fill="none" stroke="gray" d="M8,-164C8,-158 14,-152 20,-152"/>
<text text-anchor="middle" x="339.5" y="-1075.1" font-family="Times Roman,serif" font-size="11.00" fill="gray">\</text>
</g>
<!-- \\DB_Util -->
<g id="node2" class="node"><title>\\DB_Util</title>
<polygon fill="none" stroke="black" points="332,-655 256,-655 256,-619 332,-619 332,-655"/>
<text text-anchor="start" x="264.5" y="-642.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="273.5" y="-629.233" font-family="Times Roman,serif" font-size="11.00">DB_Util</text>
<polyline fill="none" stroke="gray" points="20,-98 682,-98 "/>
<path fill="none" stroke="gray" d="M682,-98C688,-98 694,-104 694,-110"/>
<polyline fill="none" stroke="gray" points="694,-110 694,-1023 "/>
<path fill="none" stroke="gray" d="M694,-1023C694,-1029 688,-1035 682,-1035"/>
<polyline fill="none" stroke="gray" points="682,-1035 20,-1035 "/>
<path fill="none" stroke="gray" d="M20,-1035C14,-1035 8,-1029 8,-1023"/>
<polyline fill="none" stroke="gray" points="8,-1023 8,-110 "/>
<path fill="none" stroke="gray" d="M8,-110C8,-104 14,-98 20,-98"/>
<text text-anchor="middle" x="351" y="-1021.1" font-family="Times Roman,serif" font-size="11.00" fill="gray">\</text>
</g>
<!-- \\Query_Parser -->
<g id="node3" class="node"><title>\\Query_Parser</title>
<polygon fill="none" stroke="black" points="631,-1060 541,-1060 541,-1024 631,-1024 631,-1060"/>
<text text-anchor="middle" x="586" y="-1038.6" font-family="Times Roman,serif" font-size="11.00">Query_Parser</text>
<g id="node2" class="node"><title>\\Query_Parser</title>
<polygon fill="none" stroke="black" points="660,-1006 570,-1006 570,-970 660,-970 660,-1006"/>
<text text-anchor="middle" x="615" y="-984.6" font-family="Times Roman,serif" font-size="11.00">Query_Parser</text>
</g>
<!-- \\Abstract_Driver -->
<g id="node4" class="node"><title>\\Abstract_Driver</title>
<polygon fill="none" stroke="black" points="346,-412 242,-412 242,-376 346,-376 346,-412"/>
<text text-anchor="start" x="264.5" y="-399.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="250.5" y="-386.233" font-family="Times Roman,serif" font-size="11.00">Abstract_Driver</text>
<g id="node3" class="node"><title>\\Abstract_Driver</title>
<polygon fill="none" stroke="black" points="385,-736 281,-736 281,-700 385,-700 385,-736"/>
<text text-anchor="start" x="303.5" y="-723.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="289.5" y="-710.233" font-family="Times Roman,serif" font-size="11.00">Abstract_Driver</text>
</g>
<!-- \\idriver -->
<g id="node23" class="node"><title>\\idriver</title>
<polygon fill="none" stroke="black" points="70,-412 16,-412 16,-376 70,-376 70,-412"/>
<text text-anchor="middle" x="43" y="-390.6" font-family="Times Roman,serif" font-size="11.00">idriver</text>
<!-- \\Driver_Interface -->
<g id="node22" class="node"><title>\\Driver_Interface</title>
<polygon fill="none" stroke="black" points="121,-736 17,-736 17,-700 121,-700 121,-736"/>
<text text-anchor="middle" x="69" y="-714.6" font-family="Times Roman,serif" font-size="11.00">Driver_Interface</text>
</g>
<!-- \\Abstract_Driver&#45;&gt;\\idriver -->
<g id="edge5" class="edge"><title>\\Abstract_Driver&#45;&gt;\\idriver</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M241.993,-394C193.706,-394 123.009,-394 80.1678,-394"/>
<polygon fill="none" stroke="black" points="80.1671,-390.5 70.1671,-394 80.1671,-397.5 80.1671,-390.5"/>
<!-- \\Abstract_Driver&#45;&gt;\\Driver_Interface -->
<g id="edge5" class="edge"><title>\\Abstract_Driver&#45;&gt;\\Driver_Interface</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M280.842,-718C237.953,-718 177.051,-718 131.547,-718"/>
<polygon fill="none" stroke="black" points="131.501,-714.5 121.501,-718 131.501,-721.5 131.501,-714.5"/>
</g>
<!-- \\PDO -->
<g id="node25" class="node"><title>\\PDO</title>
<ellipse fill="none" stroke="black" cx="43" cy="-126" rx="35.0527" ry="18"/>
<text text-anchor="middle" x="43" y="-121.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDO</text>
<g id="node26" class="node"><title>\\PDO</title>
<ellipse fill="none" stroke="black" cx="69" cy="-72" rx="35.0527" ry="18"/>
<text text-anchor="middle" x="69" y="-67.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDO</text>
</g>
<!-- \\Abstract_Driver&#45;&gt;\\PDO -->
<g id="edge3" class="edge"><title>\\Abstract_Driver&#45;&gt;\\PDO</title>
<path fill="none" stroke="black" d="M241.885,-398.657C212.051,-398.492 175.748,-393.11 151,-372 71.4397,-304.136 143.661,-230.185 79,-148 78.2102,-146.996 77.361,-146.027 76.4642,-145.093"/>
<polygon fill="none" stroke="black" points="78.7319,-142.427 68.8503,-138.605 74.1919,-147.755 78.7319,-142.427"/>
<path fill="none" stroke="black" d="M311.167,-699.891C279.617,-672.369 221.999,-616.75 194,-556 107.017,-367.268 250.391,-257.406 122,-94 118.812,-89.9424 114.744,-86.6261 110.283,-83.9172"/>
<polygon fill="none" stroke="black" points="111.854,-80.7896 101.348,-79.4215 108.708,-87.0427 111.854,-80.7896"/>
</g>
<!-- \\Abstract_SQL -->
<g id="node4" class="node"><title>\\Abstract_SQL</title>
<polygon fill="none" stroke="black" points="379,-547 287,-547 287,-511 379,-511 379,-547"/>
<text text-anchor="start" x="303.5" y="-534.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="295.5" y="-521.233" font-family="Times Roman,serif" font-size="11.00">Abstract_SQL</text>
</g>
<!-- \\SQL_Interface -->
<g id="node23" class="node"><title>\\SQL_Interface</title>
<polygon fill="none" stroke="black" points="115,-547 23,-547 23,-511 115,-511 115,-547"/>
<text text-anchor="middle" x="69" y="-525.6" font-family="Times Roman,serif" font-size="11.00">SQL_Interface</text>
</g>
<!-- \\Abstract_SQL&#45;&gt;\\SQL_Interface -->
<g id="edge7" class="edge"><title>\\Abstract_SQL&#45;&gt;\\SQL_Interface</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M286.713,-529C241.937,-529 173.981,-529 125.92,-529"/>
<polygon fill="none" stroke="black" points="125.678,-525.5 115.678,-529 125.678,-532.5 125.678,-525.5"/>
</g>
<!-- \\Query_Builder -->
<g id="node5" class="node"><title>\\Query_Builder</title>
<polygon fill="none" stroke="black" points="633,-1006 539,-1006 539,-970 633,-970 633,-1006"/>
<text text-anchor="middle" x="586" y="-984.6" font-family="Times Roman,serif" font-size="11.00">Query_Builder</text>
<polygon fill="none" stroke="black" points="662,-952 568,-952 568,-916 662,-916 662,-952"/>
<text text-anchor="middle" x="615" y="-930.6" font-family="Times Roman,serif" font-size="11.00">Query_Builder</text>
</g>
<!-- \\iQuery_Builder -->
<g id="node22" class="node"><title>\\iQuery_Builder</title>
<polygon fill="none" stroke="black" points="343,-1006 245,-1006 245,-970 343,-970 343,-1006"/>
<text text-anchor="middle" x="294" y="-984.6" font-family="Times Roman,serif" font-size="11.00">iQuery_Builder</text>
<!-- \\Query_Builder_Interface -->
<g id="node24" class="node"><title>\\Query_Builder_Interface</title>
<polygon fill="none" stroke="black" points="407,-952 259,-952 259,-916 407,-916 407,-952"/>
<text text-anchor="middle" x="333" y="-930.6" font-family="Times Roman,serif" font-size="11.00">Query_Builder_Interface</text>
</g>
<!-- \\Query_Builder&#45;&gt;\\iQuery_Builder -->
<g id="edge7" class="edge"><title>\\Query_Builder&#45;&gt;\\iQuery_Builder</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M538.435,-988C487.879,-988 407.848,-988 353.235,-988"/>
<polygon fill="none" stroke="black" points="353.007,-984.5 343.007,-988 353.007,-991.5 353.007,-984.5"/>
<!-- \\Query_Builder&#45;&gt;\\Query_Builder_Interface -->
<g id="edge9" class="edge"><title>\\Query_Builder&#45;&gt;\\Query_Builder_Interface</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M567.481,-934C526.669,-934 466.838,-934 417.83,-934"/>
<polygon fill="none" stroke="black" points="417.547,-930.5 407.547,-934 417.547,-937.5 417.547,-930.5"/>
</g>
<!-- \\SQLite_Util -->
<g id="node6" class="node"><title>\\SQLite_Util</title>
<polygon fill="none" stroke="black" points="624,-736 548,-736 548,-700 624,-700 624,-736"/>
<text text-anchor="middle" x="586" y="-714.6" font-family="Times Roman,serif" font-size="11.00">SQLite_Util</text>
<!-- \\BadDBDriverException -->
<g id="node6" class="node"><title>\\BadDBDriverException</title>
<polygon fill="none" stroke="black" points="686,-196 544,-196 544,-160 686,-160 686,-196"/>
<text text-anchor="middle" x="615" y="-174.6" font-family="Times Roman,serif" font-size="11.00">BadDBDriverException</text>
</g>
<!-- \\SQLite_Util&#45;&gt;\\DB_Util -->
<g id="edge9" class="edge"><title>\\SQLite_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M547.225,-707.244C494.246,-692.548 399.288,-666.207 341.918,-650.292"/>
<polygon fill="none" stroke="black" points="342.579,-646.844 332.008,-647.543 340.708,-653.589 342.579,-646.844"/>
<!-- \\InvalidArgumentException -->
<g id="node31" class="node"><title>\\InvalidArgumentException</title>
<ellipse fill="none" stroke="black" cx="333" cy="-72" rx="138.86" ry="18"/>
<text text-anchor="middle" x="333" y="-67.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\InvalidArgumentException</text>
</g>
<!-- \\BadDBDriverException&#45;&gt;\\InvalidArgumentException -->
<g id="edge11" class="edge"><title>\\BadDBDriverException&#45;&gt;\\InvalidArgumentException</title>
<path fill="none" stroke="black" d="M561.829,-159.848C555.688,-157.15 549.619,-154.191 544,-151 508.51,-130.844 509.377,-110.392 472,-94 465.232,-91.0316 458.122,-88.4575 450.846,-86.226"/>
<polygon fill="none" stroke="black" points="451.413,-82.7491 440.838,-83.3906 449.505,-89.484 451.413,-82.7491"/>
</g>
<!-- \\Connection_Manager -->
<g id="node7" class="node"><title>\\Connection_Manager</title>
<polygon fill="none" stroke="black" points="681,-844 549,-844 549,-808 681,-808 681,-844"/>
<text text-anchor="middle" x="615" y="-822.6" font-family="Times Roman,serif" font-size="11.00">Connection_Manager</text>
</g>
<!-- \\DB_Util -->
<g id="node8" class="node"><title>\\DB_Util</title>
<polygon fill="none" stroke="black" points="371,-331 295,-331 295,-295 371,-295 371,-331"/>
<text text-anchor="start" x="303.5" y="-318.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="312.5" y="-305.233" font-family="Times Roman,serif" font-size="11.00">DB_Util</text>
</g>
<!-- \\SQLite -->
<g id="node7" class="node"><title>\\SQLite</title>
<polygon fill="none" stroke="black" points="613,-520 559,-520 559,-484 613,-484 613,-520"/>
<text text-anchor="middle" x="586" y="-498.6" font-family="Times Roman,serif" font-size="11.00">SQLite</text>
<g id="node9" class="node"><title>\\SQLite</title>
<polygon fill="none" stroke="black" points="642,-790 588,-790 588,-754 642,-754 642,-790"/>
<text text-anchor="middle" x="615" y="-768.6" font-family="Times Roman,serif" font-size="11.00">SQLite</text>
</g>
<!-- \\SQLite&#45;&gt;\\Abstract_Driver -->
<g id="edge11" class="edge"><title>\\SQLite&#45;&gt;\\Abstract_Driver</title>
<path fill="none" stroke="black" d="M558.863,-492.656C544.09,-487.525 525.508,-481.003 509,-475 454.982,-455.357 393.654,-432.163 350.361,-415.639"/>
<polygon fill="none" stroke="black" points="351.449,-412.308 340.859,-412.009 348.951,-418.848 351.449,-412.308"/>
<g id="edge13" class="edge"><title>\\SQLite&#45;&gt;\\Abstract_Driver</title>
<path fill="none" stroke="black" d="M587.961,-766.822C543.913,-758.388 455.549,-741.467 395.334,-729.936"/>
<polygon fill="none" stroke="black" points="395.66,-726.435 385.18,-727.992 394.344,-733.31 395.66,-726.435"/>
</g>
<!-- \\SQLite_SQL -->
<g id="node8" class="node"><title>\\SQLite_SQL</title>
<polygon fill="none" stroke="black" points="626,-952 546,-952 546,-916 626,-916 626,-952"/>
<text text-anchor="middle" x="586" y="-930.6" font-family="Times Roman,serif" font-size="11.00">SQLite_SQL</text>
<g id="node10" class="node"><title>\\SQLite_SQL</title>
<polygon fill="none" stroke="black" points="655,-574 575,-574 575,-538 655,-538 655,-574"/>
<text text-anchor="middle" x="615" y="-552.6" font-family="Times Roman,serif" font-size="11.00">SQLite_SQL</text>
</g>
<!-- \\iDB_SQL -->
<g id="node21" class="node"><title>\\iDB_SQL</title>
<polygon fill="none" stroke="black" points="325,-871 263,-871 263,-835 325,-835 325,-871"/>
<text text-anchor="middle" x="294" y="-849.6" font-family="Times Roman,serif" font-size="11.00">iDB_SQL</text>
<!-- \\SQLite_SQL&#45;&gt;\\Abstract_SQL -->
<g id="edge15" class="edge"><title>\\SQLite_SQL&#45;&gt;\\Abstract_SQL</title>
<path fill="none" stroke="black" d="M574.896,-552.16C526.325,-547.51 444.212,-539.648 389.311,-534.391"/>
<polygon fill="none" stroke="black" points="389.339,-530.878 379.051,-533.409 388.672,-537.846 389.339,-530.878"/>
</g>
<!-- \\SQLite_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge13" class="edge"><title>\\SQLite_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M545.705,-922.822C490.474,-907.501 391.742,-880.113 335.755,-864.583"/>
<polygon fill="none" stroke="black" points="336.39,-861.127 325.819,-861.826 334.519,-867.872 336.39,-861.127"/>
<!-- \\SQLite_Util -->
<g id="node11" class="node"><title>\\SQLite_Util</title>
<polygon fill="none" stroke="black" points="653,-358 577,-358 577,-322 653,-322 653,-358"/>
<text text-anchor="middle" x="615" y="-336.6" font-family="Times Roman,serif" font-size="11.00">SQLite_Util</text>
</g>
<!-- \\Firebird_SQL -->
<g id="node9" class="node"><title>\\Firebird_SQL</title>
<polygon fill="none" stroke="black" points="628,-898 544,-898 544,-862 628,-862 628,-898"/>
<text text-anchor="middle" x="586" y="-876.6" font-family="Times Roman,serif" font-size="11.00">Firebird_SQL</text>
</g>
<!-- \\Firebird_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge15" class="edge"><title>\\Firebird_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M543.228,-876.045C487.57,-870.899 390.933,-861.963 335.771,-856.862"/>
<polygon fill="none" stroke="black" points="335.925,-853.362 325.645,-855.926 335.28,-860.332 335.925,-853.362"/>
</g>
<!-- \\Firebird_Util -->
<g id="node10" class="node"><title>\\Firebird_Util</title>
<polygon fill="none" stroke="black" points="627,-682 545,-682 545,-646 627,-646 627,-682"/>
<text text-anchor="middle" x="586" y="-660.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Util</text>
</g>
<!-- \\Firebird_Util&#45;&gt;\\DB_Util -->
<g id="edge17" class="edge"><title>\\Firebird_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M544.783,-660.189C491.504,-655.262 398.879,-646.698 342.34,-641.47"/>
<polygon fill="none" stroke="black" points="342.501,-637.97 332.221,-640.534 341.856,-644.94 342.501,-637.97"/>
</g>
<!-- \\Firebird_Result -->
<g id="node11" class="node"><title>\\Firebird_Result</title>
<polygon fill="none" stroke="black" points="634,-304 538,-304 538,-268 634,-268 634,-304"/>
<text text-anchor="middle" x="586" y="-282.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Result</text>
</g>
<!-- \\PDOStatement -->
<g id="node34" class="node"><title>\\PDOStatement</title>
<ellipse fill="none" stroke="black" cx="294" cy="-126" rx="85.1942" ry="18"/>
<text text-anchor="middle" x="294" y="-121.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDOStatement</text>
</g>
<!-- \\Firebird_Result&#45;&gt;\\PDOStatement -->
<g id="edge19" class="edge"><title>\\Firebird_Result&#45;&gt;\\PDOStatement</title>
<path fill="none" stroke="black" d="M537.48,-274.443C527.419,-270.603 517.352,-265.567 509,-259 462.775,-222.654 486.379,-179.93 437,-148 422.718,-138.765 405.987,-132.876 389.102,-129.209"/>
<polygon fill="none" stroke="black" points="389.64,-125.748 379.159,-127.298 388.319,-132.623 389.64,-125.748"/>
<!-- \\SQLite_Util&#45;&gt;\\DB_Util -->
<g id="edge17" class="edge"><title>\\SQLite_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M576.38,-336.302C525.648,-331.445 436.548,-322.914 381.378,-317.632"/>
<polygon fill="none" stroke="black" points="381.441,-314.122 371.153,-316.653 380.774,-321.09 381.441,-314.122"/>
</g>
<!-- \\Firebird -->
<g id="node12" class="node"><title>\\Firebird</title>
<polygon fill="none" stroke="black" points="615,-466 557,-466 557,-430 615,-430 615,-466"/>
<text text-anchor="middle" x="586" y="-444.6" font-family="Times Roman,serif" font-size="11.00">Firebird</text>
<polygon fill="none" stroke="black" points="644,-898 586,-898 586,-862 644,-862 644,-898"/>
<text text-anchor="middle" x="615" y="-876.6" font-family="Times Roman,serif" font-size="11.00">Firebird</text>
</g>
<!-- \\Firebird&#45;&gt;\\Abstract_Driver -->
<g id="edge21" class="edge"><title>\\Firebird&#45;&gt;\\Abstract_Driver</title>
<path fill="none" stroke="black" d="M556.934,-442.625C510.406,-434.02 418.152,-416.96 356.249,-405.512"/>
<polygon fill="none" stroke="black" points="356.676,-402.032 346.206,-403.655 355.403,-408.915 356.676,-402.032"/>
<g id="edge19" class="edge"><title>\\Firebird&#45;&gt;\\Abstract_Driver</title>
<path fill="none" stroke="black" d="M585.749,-870.409C572.705,-865.745 557.311,-859.7 544,-853 477.815,-819.689 406.265,-770.919 365.808,-742.023"/>
<polygon fill="none" stroke="black" points="367.824,-739.162 357.66,-736.171 363.741,-744.847 367.824,-739.162"/>
</g>
<!-- \\PgSQL_Util -->
<g id="node13" class="node"><title>\\PgSQL_Util</title>
<polygon fill="none" stroke="black" points="624,-628 548,-628 548,-592 624,-592 624,-628"/>
<text text-anchor="middle" x="586" y="-606.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_Util</text>
<!-- \\Firebird_SQL -->
<g id="node13" class="node"><title>\\Firebird_SQL</title>
<polygon fill="none" stroke="black" points="657,-520 573,-520 573,-484 657,-484 657,-520"/>
<text text-anchor="middle" x="615" y="-498.6" font-family="Times Roman,serif" font-size="11.00">Firebird_SQL</text>
</g>
<!-- \\PgSQL_Util&#45;&gt;\\DB_Util -->
<g id="edge23" class="edge"><title>\\PgSQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M547.826,-613.53C495.144,-618.401 400.14,-627.186 342.494,-632.516"/>
<polygon fill="none" stroke="black" points="341.819,-629.063 332.183,-633.469 342.463,-636.034 341.819,-629.063"/>
<!-- \\Firebird_SQL&#45;&gt;\\Abstract_SQL -->
<g id="edge21" class="edge"><title>\\Firebird_SQL&#45;&gt;\\Abstract_SQL</title>
<path fill="none" stroke="black" d="M572.476,-506.071C523.619,-510.749 443.253,-518.444 389.253,-523.614"/>
<polygon fill="none" stroke="black" points="388.777,-520.144 379.156,-524.581 389.444,-527.112 388.777,-520.144"/>
</g>
<!-- \\PgSQL_SQL -->
<g id="node14" class="node"><title>\\PgSQL_SQL</title>
<polygon fill="none" stroke="black" points="626,-844 546,-844 546,-808 626,-808 626,-844"/>
<text text-anchor="middle" x="586" y="-822.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_SQL</text>
<!-- \\Firebird_Result -->
<g id="node14" class="node"><title>\\Firebird_Result</title>
<polygon fill="none" stroke="black" points="663,-142 567,-142 567,-106 663,-106 663,-142"/>
<text text-anchor="middle" x="615" y="-120.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Result</text>
</g>
<!-- \\PgSQL_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge25" class="edge"><title>\\PgSQL_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M545.705,-829.726C490.588,-834.822 392.151,-843.924 336.104,-849.107"/>
<polygon fill="none" stroke="black" points="335.454,-845.652 325.819,-850.058 336.098,-852.622 335.454,-845.652"/>
<!-- \\PDOStatement -->
<g id="node38" class="node"><title>\\PDOStatement</title>
<ellipse fill="none" stroke="black" cx="333" cy="-18" rx="85.1942" ry="18"/>
<text text-anchor="middle" x="333" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDOStatement</text>
</g>
<!-- \\Firebird_Result&#45;&gt;\\PDOStatement -->
<g id="edge23" class="edge"><title>\\Firebird_Result&#45;&gt;\\PDOStatement</title>
<path fill="none" stroke="black" d="M588.27,-105.876C560.416,-87.8131 514.923,-60.5848 472,-45 453.996,-38.4628 434.074,-33.4037 415.071,-29.5286"/>
<polygon fill="none" stroke="black" points="415.717,-26.0888 405.232,-27.6085 414.376,-32.9592 415.717,-26.0888"/>
</g>
<!-- \\Firebird_Util -->
<g id="node15" class="node"><title>\\Firebird_Util</title>
<polygon fill="none" stroke="black" points="656,-304 574,-304 574,-268 656,-268 656,-304"/>
<text text-anchor="middle" x="615" y="-282.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Util</text>
</g>
<!-- \\Firebird_Util&#45;&gt;\\DB_Util -->
<g id="edge25" class="edge"><title>\\Firebird_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M573.995,-289.926C522.906,-294.818 435.731,-303.164 381.413,-308.365"/>
<polygon fill="none" stroke="black" points="380.96,-304.892 371.339,-309.329 381.627,-311.86 380.96,-304.892"/>
</g>
<!-- \\PgSQL -->
<g id="node15" class="node"><title>\\PgSQL</title>
<polygon fill="none" stroke="black" points="613,-412 559,-412 559,-376 613,-376 613,-412"/>
<text text-anchor="middle" x="586" y="-390.6" font-family="Times Roman,serif" font-size="11.00">PgSQL</text>
<g id="node16" class="node"><title>\\PgSQL</title>
<polygon fill="none" stroke="black" points="642,-736 588,-736 588,-700 642,-700 642,-736"/>
<text text-anchor="middle" x="615" y="-714.6" font-family="Times Roman,serif" font-size="11.00">PgSQL</text>
</g>
<!-- \\PgSQL&#45;&gt;\\Abstract_Driver -->
<g id="edge27" class="edge"><title>\\PgSQL&#45;&gt;\\Abstract_Driver</title>
<path fill="none" stroke="black" d="M558.792,-394C512.925,-394 419.088,-394 356.351,-394"/>
<polygon fill="none" stroke="black" points="356.176,-390.5 346.176,-394 356.176,-397.5 356.176,-390.5"/>
<path fill="none" stroke="black" d="M587.961,-718C543.913,-718 455.549,-718 395.334,-718"/>
<polygon fill="none" stroke="black" points="395.18,-714.5 385.18,-718 395.18,-721.5 395.18,-714.5"/>
</g>
<!-- \\MySQL_SQL -->
<g id="node16" class="node"><title>\\MySQL_SQL</title>
<polygon fill="none" stroke="black" points="627,-790 545,-790 545,-754 627,-754 627,-790"/>
<text text-anchor="middle" x="586" y="-768.6" font-family="Times Roman,serif" font-size="11.00">MySQL_SQL</text>
<!-- \\PgSQL_SQL -->
<g id="node17" class="node"><title>\\PgSQL_SQL</title>
<polygon fill="none" stroke="black" points="655,-466 575,-466 575,-430 655,-430 655,-466"/>
<text text-anchor="middle" x="615" y="-444.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_SQL</text>
</g>
<!-- \\MySQL_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge29" class="edge"><title>\\MySQL_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M544.783,-783.434C489.284,-798.829 391.092,-826.067 335.466,-841.497"/>
<polygon fill="none" stroke="black" points="334.296,-838.19 325.595,-844.236 336.167,-844.935 334.296,-838.19"/>
<!-- \\PgSQL_SQL&#45;&gt;\\Abstract_SQL -->
<g id="edge29" class="edge"><title>\\PgSQL_SQL&#45;&gt;\\Abstract_SQL</title>
<path fill="none" stroke="black" d="M574.896,-459.519C526.224,-473.499 443.87,-497.154 388.969,-512.924"/>
<polygon fill="none" stroke="black" points="387.696,-509.648 379.051,-515.772 389.629,-516.376 387.696,-509.648"/>
</g>
<!-- \\MySQL_Util -->
<g id="node17" class="node"><title>\\MySQL_Util</title>
<polygon fill="none" stroke="black" points="625,-574 547,-574 547,-538 625,-538 625,-574"/>
<text text-anchor="middle" x="586" y="-552.6" font-family="Times Roman,serif" font-size="11.00">MySQL_Util</text>
<!-- \\PgSQL_Util -->
<g id="node18" class="node"><title>\\PgSQL_Util</title>
<polygon fill="none" stroke="black" points="653,-250 577,-250 577,-214 653,-214 653,-250"/>
<text text-anchor="middle" x="615" y="-228.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_Util</text>
</g>
<!-- \\MySQL_Util&#45;&gt;\\DB_Util -->
<g id="edge31" class="edge"><title>\\MySQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M546.316,-567.008C493.212,-581.739 399.123,-607.839 342.065,-623.667"/>
<polygon fill="none" stroke="black" points="340.905,-620.356 332.205,-626.402 342.777,-627.102 340.905,-620.356"/>
<!-- \\PgSQL_Util&#45;&gt;\\DB_Util -->
<g id="edge31" class="edge"><title>\\PgSQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M576.896,-246.05C566.206,-250.111 554.608,-254.629 544,-259 511.622,-272.34 505.58,-281.067 472,-291 442.396,-299.757 408.152,-305.229 381.061,-308.526"/>
<polygon fill="none" stroke="black" points="380.584,-305.057 371.053,-309.685 381.389,-312.011 380.584,-305.057"/>
</g>
<!-- \\MySQL -->
<g id="node18" class="node"><title>\\MySQL</title>
<polygon fill="none" stroke="black" points="613,-358 559,-358 559,-322 613,-322 613,-358"/>
<text text-anchor="middle" x="586" y="-336.6" font-family="Times Roman,serif" font-size="11.00">MySQL</text>
<g id="node19" class="node"><title>\\MySQL</title>
<polygon fill="none" stroke="black" points="642,-682 588,-682 588,-646 642,-646 642,-682"/>
<text text-anchor="middle" x="615" y="-660.6" font-family="Times Roman,serif" font-size="11.00">MySQL</text>
</g>
<!-- \\MySQL&#45;&gt;\\Abstract_Driver -->
<g id="edge33" class="edge"><title>\\MySQL&#45;&gt;\\Abstract_Driver</title>
<path fill="none" stroke="black" d="M558.362,-346.446C528.522,-353.286 479.543,-364.166 437,-372 410.62,-376.858 381.366,-381.491 356.225,-385.241"/>
<polygon fill="none" stroke="black" points="355.467,-381.815 346.087,-386.74 356.491,-388.74 355.467,-381.815"/>
<path fill="none" stroke="black" d="M587.447,-669.276C543.231,-677.743 455.32,-694.577 395.338,-706.063"/>
<polygon fill="none" stroke="black" points="394.385,-702.682 385.222,-708 395.702,-709.557 394.385,-702.682"/>
</g>
<!-- \\BadDBDriverException -->
<g id="node19" class="node"><title>\\BadDBDriverException</title>
<polygon fill="none" stroke="black" points="657,-250 515,-250 515,-214 657,-214 657,-250"/>
<text text-anchor="middle" x="586" y="-228.6" font-family="Times Roman,serif" font-size="11.00">BadDBDriverException</text>
<!-- \\MySQL_SQL -->
<g id="node20" class="node"><title>\\MySQL_SQL</title>
<polygon fill="none" stroke="black" points="656,-628 574,-628 574,-592 656,-592 656,-628"/>
<text text-anchor="middle" x="615" y="-606.6" font-family="Times Roman,serif" font-size="11.00">MySQL_SQL</text>
</g>
<!-- \\InvalidArgumentException -->
<g id="node43" class="node"><title>\\InvalidArgumentException</title>
<ellipse fill="none" stroke="black" cx="294" cy="-72" rx="138.86" ry="18"/>
<text text-anchor="middle" x="294" y="-67.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\InvalidArgumentException</text>
<!-- \\MySQL_SQL&#45;&gt;\\Abstract_SQL -->
<g id="edge35" class="edge"><title>\\MySQL_SQL&#45;&gt;\\Abstract_SQL</title>
<path fill="none" stroke="black" d="M573.995,-598.222C525.244,-584.219 443.636,-560.778 389.072,-545.106"/>
<polygon fill="none" stroke="black" points="389.79,-541.671 379.213,-542.274 387.858,-548.399 389.79,-541.671"/>
</g>
<!-- \\BadDBDriverException&#45;&gt;\\InvalidArgumentException -->
<g id="edge35" class="edge"><title>\\BadDBDriverException&#45;&gt;\\InvalidArgumentException</title>
<path fill="none" stroke="black" d="M523.256,-213.95C518.211,-211.337 513.379,-208.369 509,-205 463.859,-170.276 484.626,-130.229 437,-99 429.555,-94.1182 421.45,-90.0687 413.008,-86.715"/>
<polygon fill="none" stroke="black" points="413.944,-83.3318 403.35,-83.2169 411.56,-89.9134 413.944,-83.3318"/>
<!-- \\MySQL_Util -->
<g id="node21" class="node"><title>\\MySQL_Util</title>
<polygon fill="none" stroke="black" points="654,-412 576,-412 576,-376 654,-376 654,-412"/>
<text text-anchor="middle" x="615" y="-390.6" font-family="Times Roman,serif" font-size="11.00">MySQL_Util</text>
</g>
<!-- \\BadConnectionException -->
<g id="node20" class="node"><title>\\BadConnectionException</title>
<polygon fill="none" stroke="black" points="663,-196 509,-196 509,-160 663,-160 663,-196"/>
<text text-anchor="middle" x="586" y="-174.6" font-family="Times Roman,serif" font-size="11.00">BadConnectionException</text>
</g>
<!-- \\UnexpectedValueException -->
<g id="node45" class="node"><title>\\UnexpectedValueException</title>
<ellipse fill="none" stroke="black" cx="294" cy="-18" rx="142.885" ry="18"/>
<text text-anchor="middle" x="294" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\UnexpectedValueException</text>
</g>
<!-- \\BadConnectionException&#45;&gt;\\UnexpectedValueException -->
<g id="edge37" class="edge"><title>\\BadConnectionException&#45;&gt;\\UnexpectedValueException</title>
<path fill="none" stroke="black" d="M571.649,-159.998C547.297,-130.794 494.857,-73.4973 437,-45 427.639,-40.3894 417.577,-36.5637 407.283,-33.3896"/>
<polygon fill="none" stroke="black" points="407.935,-29.9357 397.358,-30.5418 406.005,-36.6642 407.935,-29.9357"/>
<!-- \\MySQL_Util&#45;&gt;\\DB_Util -->
<g id="edge37" class="edge"><title>\\MySQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M575.492,-382.652C524.548,-368.019 436.001,-342.585 381.167,-326.835"/>
<polygon fill="none" stroke="black" points="381.915,-323.409 371.337,-324.012 379.982,-330.137 381.915,-323.409"/>
</g>
</g>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

2
docs/classes/Abstract_Driver.html
View File

@ -522,7 +522,7 @@ the connection/database</h2>
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

40
docs/classes/BadConnectionException.html → docs/classes/Abstract_SQL.html
View File

@ -3,7 +3,7 @@
<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>Query » \BadConnectionException</title>
<title>Query » \Abstract_SQL</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
@ -57,19 +57,22 @@
<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>
</div>
<ul class="side-nav nav nav-list"></ul>
<ul class="side-nav nav nav-list"><li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
<ul><li class="method public "><a href="#method_limit" title="limit() :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li></ul>
</li></ul>
</div>
<div class="span8">
<a id="\BadConnectionException"></a><ul class="breadcrumb">
<a id="\Abstract_SQL"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/BadConnectionException.html">BadConnectionException</a>
<span class="divider">\</span><a href="../classes/Abstract_SQL.html">Abstract_SQL</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Generic exception for bad connection strings</p>
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered">
@ -82,6 +85,31 @@
<td>Query</td>
</tr>
</table>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse" title="public">
<h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<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>
</div>
</div>
</div>
@ -90,7 +118,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/BadDBDriverException.html
View File

@ -90,7 +90,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

267
docs/classes/Connection_Manager.html Normal file
View File

@ -0,0 +1,267 @@
<!DOCTYPE html><html 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>Query » \Connection_Manager</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">Query</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/Query.html"><i class="icon-folder-open"></i> Query</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></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">
<div class="btn-toolbar">
<div 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>
</div>
<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>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public "><a href="#method_connect" title="connect() :: Parse the passed parameters and return a connection"><span class="description">Parse the passed parameters and return a connection</span><pre>connect()</pre></a></li>
<li class="method public "><a href="#method_get_connection" title="get_connection() :: Returns the connection specified by the name given"><span class="description">Returns the connection specified by the name given</span><pre>get_connection()</pre></a></li>
<li class="method public "><a href="#method_get_instance" title="get_instance() :: Return a connection manager instance"><span class="description">Return a connection manager instance</span><pre>get_instance()</pre></a></li>
</ul>
</li>
<li class="nav-header private">» Private
<ul>
<li class="method private "><a href="#method___clone" title="__clone() :: "><span class="description">__clone()
</span><pre>__clone()</pre></a></li>
<li class="method private "><a href="#method___construct" title="__construct() :: Private methods for singleton"><span class="description">Private methods for singleton</span><pre>__construct()</pre></a></li>
<li class="method private "><a href="#method___wakup" title="__wakup() :: Make sure serialize/deseriaze doesn't work"><span class="description">Make sure serialize/deseriaze doesn't work</span><pre>__wakup()</pre></a></li>
<li class="method private "><a href="#method_create_dsn" title="create_dsn() :: Create the dsn from the db type and params"><span class="description">Create the dsn from the db type and params</span><pre>create_dsn()</pre></a></li>
<li class="method private "><a href="#method_parse_params" title="parse_params() :: Parses params into a dsn and option array"><span class="description">Parses params into a dsn and option array</span><pre>parse_params()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul>
</li>
<li class="nav-header private">» Private
<ul>
<li class="property private "><a href="#property_connections" title="$connections() :: Map of named database connections"><span class="description"></span><pre>$connections</pre></a></li>
<li class="property private "><a href="#property_instance" title="$instance() :: Class instance variable"><span class="description"></span><pre>$instance</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\Connection_Manager"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Connection_Manager.html">Connection_Manager</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Connection manager class to manage connections for the
Query method</p>
<div class="details">
<div class="long_description"></div>
<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 title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method_connect"></a><div class="element clickable method public method_connect" data-toggle="collapse" data-target=".method_connect .collapse" title="public">
<h2>Parse the passed parameters and return a connection</h2>
<pre>connect(array|object $params) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code><code>object</code>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="BadConnectionException.html">\BadConnectionException</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_get_connection"></a><div class="element clickable method public method_get_connection" data-toggle="collapse" data-target=".method_get_connection .collapse" title="public">
<h2>Returns the connection specified by the name given</h2>
<pre>get_connection(mixed $name<code> = ''</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>mixed</code>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="InvalidArgumentException.html">\InvalidArgumentException</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_get_instance"></a><div class="element clickable method public method_get_instance" data-toggle="collapse" data-target=".method_get_instance .collapse" title="public">
<h2>Return a connection manager instance</h2>
<pre>get_instance() : <a href="../classes/Connection_Manager.html">\Connection_Manager</a></pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>staticvar</th>
<td>null $instance</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Connection_Manager.html">\Connection_Manager</a></code></div>
</div></div>
</div>
<a id="method___clone"></a><div class="element clickable method private method___clone" data-toggle="collapse" data-target=".method___clone .collapse" title="private">
<h2>__clone()
</h2>
<pre>__clone() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method___construct"></a><div class="element clickable method private method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="private">
<h2>Private methods for singleton</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method___wakup"></a><div class="element clickable method private method___wakup" data-toggle="collapse" data-target=".method___wakup .collapse" title="private">
<h2>Make sure serialize/deseriaze doesn't work</h2>
<pre>__wakup() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="DomainException.html">\DomainException</a></code></th>
<td></td>
</tr></table>
</div></div>
</div>
<a id="method_create_dsn"></a><div class="element clickable method private method_create_dsn" data-toggle="collapse" data-target=".method_create_dsn .collapse" title="private">
<h2>Create the dsn from the db type and params</h2>
<pre>create_dsn(string $dbtype, array|object $params) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$dbtype</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code><code>object</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_parse_params"></a><div class="element clickable method private method_parse_params" data-toggle="collapse" data-target=".method_parse_params .collapse" title="private">
<h2>Parses params into a dsn and option array</h2>
<pre>parse_params(\ArrayObject $params) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$params</h4>
<code><a href="ArrayObject.html">\ArrayObject</a></code>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/BadDBDriverException.html">\BadDBDriverException</a></code></th>
<td></td>
</tr></table>
</div></div>
</div>
<h3>
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_connections"> </a><div class="element clickable property private property_connections" data-toggle="collapse" data-target=".property_connections .collapse" title="private">
<h2>Map of named database connections</h2>
<pre>$connections : array</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>array()</code></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_instance"> </a><div class="element clickable property private property_instance" data-toggle="collapse" data-target=".property_instance .collapse" title="private">
<h2>Class instance variable</h2>
<pre>$instance : <a href="../classes/Connection_Manager.html">\Connection_Manager</a></pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>null</code></div>
</div></div>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></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.2.0
</a> and<br>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

14
docs/classes/DB_Util.html
View File

@ -65,7 +65,7 @@
<li class="method public "><a href="#method___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="#method_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="#method_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="#method_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="#method_create_table" title="create_table() :: Convienience public function to generate sql for creating a db table"><span class="description">Convienience public function to generate sql for creating a db table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#method_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>
</ul>
</li>
@ -164,22 +164,18 @@
</div></div>
</div>
<a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse" title="public">
<h2>Get database-specific sql to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints<code> = array()</code>, array $indexes<code> = array()</code>) : string</pre>
<h2>Convienience public function to generate sql for creating a db table</h2>
<pre>create_table(string $name, array $fields, array $constraints<code> = array()</code>, array $indexes<code> = array()</code>) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<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>
<h4>$fields</h4>
<code>array</code>
</div>
<div class="subelement argument">
@ -233,7 +229,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

227
docs/classes/Driver_Interface.html Normal file
View File

@ -0,0 +1,227 @@
<!DOCTYPE html><html 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>Query » \Driver_Interface</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">Query</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/Query.html"><i class="icon-folder-open"></i> Query</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></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">
<div class="btn-toolbar">
<div 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>
</div>
<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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Constructor/Connection method"><span class="description">Constructor/Connection method</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_beginTransaction" title="beginTransaction() :: Begin a transaction"><span class="description">Begin a transaction</span><pre>beginTransaction()</pre></a></li>
<li class="method public "><a href="#method_commit" title="commit() :: Commit a transaction"><span class="description">Commit a transaction</span><pre>commit()</pre></a></li>
<li class="method public "><a href="#method_errorCode" title="errorCode() :: Return the current error code"><span class="description">Return the current error code</span><pre>errorCode()</pre></a></li>
<li class="method public "><a href="#method_errorInfo" title="errorInfo() :: Return information about the current error"><span class="description">Return information about the current error</span><pre>errorInfo()</pre></a></li>
<li class="method public "><a href="#method_exec" title="exec() :: Execute an SQL statement and return the number of affected rows"><span class="description">Execute an SQL statement and return the number of affected rows</span><pre>exec()</pre></a></li>
<li class="method public "><a href="#method_getAttribute" title="getAttribute() :: Get a connection attribute for the current db driver"><span class="description">Get a connection attribute for the current db driver</span><pre>getAttribute()</pre></a></li>
<li class="method public "><a href="#method_rollback" title="rollback() :: Rollback a transaction"><span class="description">Rollback a transaction</span><pre>rollback()</pre></a></li>
<li class="method public "><a href="#method_setAttribute" title="setAttribute() :: Set a connection attribute"><span class="description">Set a connection attribute</span><pre>setAttribute()</pre></a></li>
</ul>
</li></ul>
</div>
<div class="span8">
<a id="\Driver_Interface"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Driver_Interface.html">Driver_Interface</a>
</li>
</ul>
<div class="element interface">
<p class="short_description">PDO Interface to implement for database drivers</p>
<div class="details">
<div class="long_description"></div>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Constructor/Connection method</h2>
<pre>__construct(string $dsn, \[string] $username<code> = NULL</code>, \[string] $password<code> = NULL</code>, \[array] $driver_options<code> = array()</code>) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$dsn</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$username</h4>
<code><a href="%5Bstring%5D.html">\[string]</a></code>
</div>
<div class="subelement argument">
<h4>$password</h4>
<code><a href="%5Bstring%5D.html">\[string]</a></code>
</div>
<div class="subelement argument">
<h4>$driver_options</h4>
<code><a href="%5Barray%5D.html">\[array]</a></code>
</div>
</div></div>
</div>
<a id="method_beginTransaction"></a><div class="element clickable method public method_beginTransaction" data-toggle="collapse" data-target=".method_beginTransaction .collapse" title="public">
<h2>Begin a transaction</h2>
<pre>beginTransaction() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a id="method_commit"></a><div class="element clickable method public method_commit" data-toggle="collapse" data-target=".method_commit .collapse" title="public">
<h2>Commit a transaction</h2>
<pre>commit() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a id="method_errorCode"></a><div class="element clickable method public method_errorCode" data-toggle="collapse" data-target=".method_errorCode .collapse" title="public">
<h2>Return the current error code</h2>
<pre>errorCode() : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a id="method_errorInfo"></a><div class="element clickable method public method_errorInfo" data-toggle="collapse" data-target=".method_errorInfo .collapse" title="public">
<h2>Return information about the current error</h2>
<pre>errorInfo() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a id="method_exec"></a><div class="element clickable method public method_exec" data-toggle="collapse" data-target=".method_exec .collapse" title="public">
<h2>Execute an SQL statement and return the number of affected rows</h2>
<pre>exec(string $statement) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$statement</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>int</code></div>
</div></div>
</div>
<a id="method_getAttribute"></a><div class="element clickable method public method_getAttribute" data-toggle="collapse" data-target=".method_getAttribute .collapse" title="public">
<h2>Get a connection attribute for the current db driver</h2>
<pre>getAttribute(int $attribute) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>returm</th>
<td>mixed</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attribute</h4>
<code>int</code>
</div>
</div></div>
</div>
<a id="method_rollback"></a><div class="element clickable method public method_rollback" data-toggle="collapse" data-target=".method_rollback .collapse" title="public">
<h2>Rollback a transaction</h2>
<pre>rollback() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a id="method_setAttribute"></a><div class="element clickable method public method_setAttribute" data-toggle="collapse" data-target=".method_setAttribute .collapse" title="public">
<h2>Set a connection attribute</h2>
<pre>setAttribute(int $attribute, mixed $value) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attribute</h4>
<code>int</code>
</div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</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.2.0
</a> and<br>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/Firebird.html
View File

@ -456,7 +456,7 @@ the last query executed</h2>
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/Firebird_Result.html
View File

@ -386,7 +386,7 @@ the query</h2>
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/Firebird_SQL.html
View File

@ -262,7 +262,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

30
docs/classes/Firebird_Util.html
View File

@ -62,7 +62,6 @@
<ul>
<li class="method public "><a href="#method_backup_data" title="backup_data() :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#method_create_table" title="create_table() :: Convienience public function to generate sql for creating a db table"><span class="description">Convienience public function to generate sql for creating a db table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#method_delete_table" title="delete_table() :: Drop the selected table"><span class="description">Drop the selected table</span><pre>delete_table()</pre></a></li>
<li class="method public "><a href="#method_get_system_tables" title="get_system_tables() :: "><span class="description">get_system_tables()
</span><pre>get_system_tables()</pre></a></li>
@ -127,33 +126,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse" title="public">
<h2>Convienience public function to generate sql for creating a db table</h2>
<pre>create_table(string $name, array $fields, array $constraints<code> = array()</code>, array $indexes<code> = array()</code>) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$fields</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 id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse" title="public">
<h2>Drop the selected table</h2>
<pre>delete_table(string $name) : string</pre>
@ -240,7 +212,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/MySQL.html
View File

@ -157,7 +157,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/MySQL_SQL.html
View File

@ -267,7 +267,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/MySQL_Util.html
View File

@ -305,7 +305,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/PgSQL.html
View File

@ -147,7 +147,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

26
docs/classes/PgSQL_SQL.html
View File

@ -64,7 +64,6 @@
<li class="method public "><a href="#method_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="#method_explain" title="explain() :: Get the query plan for the sql query"><span class="description">Get the query plan for the sql query</span><pre>explain()</pre></a></li>
<li class="method public "><a href="#method_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="#method_limit" title="limit() :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
<li class="method public "><a href="#method_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="#method_random" title="random() :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
<li class="method public "><a href="#method_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>
@ -151,29 +150,6 @@
<div class="subelement response"><code>NULL</code></div>
</div></div>
</div>
<a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse" title="public">
<h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<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 id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse" title="public">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre>
@ -262,7 +238,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

30
docs/classes/PgSQL_Util.html
View File

@ -62,7 +62,6 @@
<ul>
<li class="method public "><a href="#method_backup_data" title="backup_data() :: Create an SQL backup file for the current database's data"><span class="description">Create an SQL backup file for the current database's data</span><pre>backup_data()</pre></a></li>
<li class="method public "><a href="#method_backup_structure" title="backup_structure() :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
<li class="method public "><a href="#method_create_table" title="create_table() :: Database-specific method to create a new table"><span class="description">Database-specific method to create a new table</span><pre>create_table()</pre></a></li>
<li class="method public "><a href="#method_delete_table" title="delete_table() :: Database-specific SQL for dropping a table"><span class="description">Database-specific SQL for dropping a table</span><pre>delete_table()</pre></a></li>
<li class="method public "><a href="#method_get_tables" title="get_tables() :: "><span class="description">get_tables()
</span><pre>get_tables()</pre></a></li>
@ -121,33 +120,6 @@
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_create_table"></a><div class="element clickable method public method_create_table" data-toggle="collapse" data-target=".method_create_table .collapse" title="public">
<h2>Database-specific method to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints<code> = array()</code>, array $indexes<code> = array()</code>) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<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 id="method_delete_table"></a><div class="element clickable method public method_delete_table" data-toggle="collapse" data-target=".method_delete_table .collapse" title="public">
<h2>Database-specific SQL for dropping a table</h2>
<pre>delete_table(string $name) : string</pre>
@ -213,7 +185,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

260
docs/classes/Query_Builder.html
View File

@ -218,14 +218,14 @@ instantiates the specific db driver</p>
</div>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Constructor</h2>
<pre>__construct(\DB_PDO $db, object $params) </pre>
<pre>__construct(\Abstract_driver $db, object $params) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$db</h4>
<code><a href="DB_PDO.html">\DB_PDO</a></code>
<code><a href="Abstract_driver.html">\Abstract_driver</a></code>
</div>
<div class="subelement argument">
<h4>$params</h4>
@ -273,7 +273,7 @@ in place of the get() method</h2>
</div>
<a id="method_delete"></a><div class="element clickable method public method_delete" data-toggle="collapse" data-target=".method_delete .collapse" title="public">
<h2>Deletes data from a table</h2>
<pre>delete(string $table, mixed $where<code> = ''</code>) : mixed</pre>
<pre>delete(string $table, mixed $where<code> = ''</code>) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
@ -287,60 +287,48 @@ in place of the get() method</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div>
</div>
<a id="method_distinct"></a><div class="element clickable method public method_distinct" data-toggle="collapse" data-target=".method_distinct .collapse" title="public">
<h2>Adds the 'distinct' keyword to a query</h2>
<pre>distinct() : \Query_Builder</pre>
<pre>distinct() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
<h2>Tell the database to give you the query plan instead of result set</h2>
<pre>explain() : \Query_Builder</pre>
<pre>explain() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_from"></a><div class="element clickable method public method_from" data-toggle="collapse" data-target=".method_from .collapse" title="public">
<h2>Specify the database table to select from</h2>
<pre>from(string $tblname) : \Query_Builder</pre>
<pre>from(string $tblname) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$tblname</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_get"></a><div class="element clickable method public method_get" data-toggle="collapse" data-target=".method_get .collapse" title="public">
<h2>Select and retrieve all records from the current table, and/or
execute current compiled query</h2>
<pre>get(mixed $table<code> = ''</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : object</pre>
<pre>get(mixed $table<code> = ''</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
@ -355,7 +343,7 @@ execute current compiled query</h2>
<code>int</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>object</code></div>
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div>
</div>
<a id="method_get_compiled_delete"></a><div class="element clickable method public method_get_compiled_delete" data-toggle="collapse" data-target=".method_get_compiled_delete .collapse" title="public">
@ -436,7 +424,7 @@ execute current compiled query</h2>
</div>
<a id="method_get_where"></a><div class="element clickable method public method_get_where" data-toggle="collapse" data-target=".method_get_where .collapse" title="public">
<h2>Convience method for get() with a where clause</h2>
<pre>get_where(string $table, array $where<code> = array()</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : object</pre>
<pre>get_where(string $table, array $where<code> = array()</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
@ -458,66 +446,50 @@ execute current compiled query</h2>
<code>int</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>object</code></div>
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div>
</div>
<a id="method_group_by"></a><div class="element clickable method public method_group_by" data-toggle="collapse" data-target=".method_group_by .collapse" title="public">
<h2>Group the results by the selected field(s)</h2>
<pre>group_by(mixed $field) : \Query_Builder</pre>
<pre>group_by(mixed $field) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_group_end"></a><div class="element clickable method public method_group_end" data-toggle="collapse" data-target=".method_group_end .collapse" title="public">
<h2>Ends a query group</h2>
<pre>group_end() : \Query_Builder</pre>
<pre>group_end() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_group_start"></a><div class="element clickable method public method_group_start" data-toggle="collapse" data-target=".method_group_start .collapse" title="public">
<h2>Adds a paren to the current query for query grouping</h2>
<pre>group_start() : \Query_Builder</pre>
<pre>group_start() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_having"></a><div class="element clickable method public method_having" data-toggle="collapse" data-target=".method_having .collapse" title="public">
<h2>Generates a 'Having' clause</h2>
<pre>having(mixed $key, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<pre>having(mixed $key, mixed $val<code> = array()</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
@ -528,12 +500,12 @@ execute current compiled query</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_insert"></a><div class="element clickable method public method_insert" data-toggle="collapse" data-target=".method_insert .collapse" title="public">
<h2>Creates an insert clause, and executes it</h2>
<pre>insert(string $table, mixed $data<code> = array()</code>) : mixed</pre>
<pre>insert(string $table, mixed $data<code> = array()</code>) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
@ -547,12 +519,12 @@ execute current compiled query</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div>
</div>
<a id="method_insert_batch"></a><div class="element clickable method public method_insert_batch" data-toggle="collapse" data-target=".method_insert_batch .collapse" title="public">
<h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data<code> = array()</code>) : string</pre>
<pre>insert_batch(string $table, array $data<code> = array()</code>) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
@ -566,19 +538,15 @@ execute current compiled query</h2>
<code>array</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div>
</div>
<a id="method_join"></a><div class="element clickable method public method_join" data-toggle="collapse" data-target=".method_join .collapse" title="public">
<h2>Creates a join phrase in a compiled query</h2>
<pre>join(string $table, string $condition, string $type<code> = ''</code>) : \Query_Builder</pre>
<pre>join(string $table, string $condition, string $type<code> = ''</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
@ -593,19 +561,15 @@ execute current compiled query</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_like"></a><div class="element clickable method public method_like" data-toggle="collapse" data-target=".method_like .collapse" title="public">
<h2>Creates a Like clause in the sql statement</h2>
<pre>like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \Query_Builder</pre>
<pre>like(string $field, mixed $val, string $pos<code> = 'both'</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -620,7 +584,7 @@ execute current compiled query</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse" title="public">
@ -644,14 +608,10 @@ execute current compiled query</h2>
</div>
<a id="method_not_like"></a><div class="element clickable method public method_not_like" data-toggle="collapse" data-target=".method_not_like .collapse" title="public">
<h2>Generates a NOT LIKE clause</h2>
<pre>not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \Query_Builder</pre>
<pre>not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -666,34 +626,26 @@ execute current compiled query</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_or_group_start"></a><div class="element clickable method public method_or_group_start" data-toggle="collapse" data-target=".method_or_group_start .collapse" title="public">
<h2>Adds a paren to the current query for query grouping,
prefixed with 'OR'</h2>
<pre>or_group_start() : \Query_Builder</pre>
<pre>or_group_start() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_or_having"></a><div class="element clickable method public method_or_having" data-toggle="collapse" data-target=".method_or_having .collapse" title="public">
<h2>Generates a 'Having' clause prefixed with 'OR'</h2>
<pre>or_having(mixed $key, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<pre>or_having(mixed $key, mixed $val<code> = array()</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
@ -704,19 +656,15 @@ prefixed with 'OR'</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_or_like"></a><div class="element clickable method public method_or_like" data-toggle="collapse" data-target=".method_or_like .collapse" title="public">
<h2>Generates an OR Like clause</h2>
<pre>or_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \Query_Builder</pre>
<pre>or_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -731,34 +679,26 @@ prefixed with 'OR'</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_or_not_group_start"></a><div class="element clickable method public method_or_not_group_start" data-toggle="collapse" data-target=".method_or_not_group_start .collapse" title="public">
<h2>Adds a paren to the current query for query grouping,
prefixed with 'OR NOT'</h2>
<pre>or_not_group_start() : \Query_Builder</pre>
<pre>or_not_group_start() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_or_not_like"></a><div class="element clickable method public method_or_not_like" data-toggle="collapse" data-target=".method_or_not_like .collapse" title="public">
<h2>Generates a OR NOT LIKE clause</h2>
<pre>or_not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \Query_Builder</pre>
<pre>or_not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -773,19 +713,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_or_where"></a><div class="element clickable method public method_or_where" data-toggle="collapse" data-target=".method_or_where .collapse" title="public">
<h2>Where clause prefixed with "OR"</h2>
<pre>or_where(string $key, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<pre>or_where(string $key, mixed $val<code> = array()</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
@ -796,19 +732,15 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_or_where_in"></a><div class="element clickable method public method_or_where_in" data-toggle="collapse" data-target=".method_or_where_in .collapse" title="public">
<h2>Where in statement prefixed with "or"</h2>
<pre>or_where_in(string $field, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<pre>or_where_in(string $field, mixed $val<code> = array()</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -819,19 +751,15 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_or_where_not_in"></a><div class="element clickable method public method_or_where_not_in" data-toggle="collapse" data-target=".method_or_where_not_in .collapse" title="public">
<h2>OR WHERE NOT IN (FOO) clause</h2>
<pre>or_where_not_in(string $field, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<pre>or_where_not_in(string $field, mixed $val<code> = array()</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -842,19 +770,15 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_order_by"></a><div class="element clickable method public method_order_by" data-toggle="collapse" data-target=".method_order_by .collapse" title="public">
<h2>Order the results by the selected field(s)</h2>
<pre>order_by(string $field, string $type<code> = ""</code>) : \Query_Builder</pre>
<pre>order_by(string $field, string $type<code> = ""</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -865,7 +789,7 @@ prefixed with 'OR NOT'</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_reset_query"></a><div class="element clickable method public method_reset_query" data-toggle="collapse" data-target=".method_reset_query .collapse" title="public">
@ -876,33 +800,25 @@ prefixed with 'OR NOT'</h2>
</div>
<a id="method_select"></a><div class="element clickable method public method_select" data-toggle="collapse" data-target=".method_select .collapse" title="public">
<h2>Specifies rows to select in a query</h2>
<pre>select(string $fields) : \Query_Builder</pre>
<pre>select(string $fields) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$fields</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_select_avg"></a><div class="element clickable method public method_select_avg" data-toggle="collapse" data-target=".method_select_avg .collapse" title="public">
<h2>Selects the average value of a field from a query</h2>
<pre>select_avg(string $field, string $as<code> = FALSE</code>) : \Query_Builder</pre>
<pre>select_avg(string $field, string $as<code> = FALSE</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -913,19 +829,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_select_max"></a><div class="element clickable method public method_select_max" data-toggle="collapse" data-target=".method_select_max .collapse" title="public">
<h2>Selects the maximum value of a field from a query</h2>
<pre>select_max(string $field, string $as<code> = FALSE</code>) : \Query_Builder</pre>
<pre>select_max(string $field, string $as<code> = FALSE</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -936,19 +848,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_select_min"></a><div class="element clickable method public method_select_min" data-toggle="collapse" data-target=".method_select_min .collapse" title="public">
<h2>Selects the minimum value of a field from a query</h2>
<pre>select_min(string $field, string $as<code> = FALSE</code>) : \Query_Builder</pre>
<pre>select_min(string $field, string $as<code> = FALSE</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -959,19 +867,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_select_sum"></a><div class="element clickable method public method_select_sum" data-toggle="collapse" data-target=".method_select_sum .collapse" title="public">
<h2>Selects the sum of a field from a query</h2>
<pre>select_sum(string $field, string $as<code> = FALSE</code>) : \Query_Builder</pre>
<pre>select_sum(string $field, string $as<code> = FALSE</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -982,19 +886,15 @@ prefixed with 'OR NOT'</h2>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_set"></a><div class="element clickable method public method_set" data-toggle="collapse" data-target=".method_set .collapse" title="public">
<h2>Sets values for inserts / updates / deletes</h2>
<pre>set(mixed $key, mixed $val<code> = NULL</code>) : \Query_Builder</pre>
<pre>set(mixed $key, mixed $val<code> = NULL</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
@ -1005,12 +905,12 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_update"></a><div class="element clickable method public method_update" data-toggle="collapse" data-target=".method_update .collapse" title="public">
<h2>Creates an update clause, and executes it</h2>
<pre>update(string $table, mixed $data<code> = array()</code>) : mixed</pre>
<pre>update(string $table, mixed $data<code> = array()</code>) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
@ -1024,21 +924,17 @@ prefixed with 'OR NOT'</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div>
</div>
<a id="method_where"></a><div class="element clickable method public method_where" data-toggle="collapse" data-target=".method_where .collapse" title="public">
<h2>Specify condition(s) in the where clause of a query
Note: this function works with key / value, or a
passed array with key / value pairs</h2>
<pre>where(mixed $key, mixed $val<code> = array()</code>, mixed $escape<code> = NULL</code>) : \Query_Builder</pre>
<pre>where(mixed $key, mixed $val<code> = array()</code>, mixed $escape<code> = NULL</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
@ -1053,19 +949,15 @@ passed array with key / value pairs</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_where_in"></a><div class="element clickable method public method_where_in" data-toggle="collapse" data-target=".method_where_in .collapse" title="public">
<h2>Where clause with 'IN' statement</h2>
<pre>where_in(mixed $field, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<pre>where_in(mixed $field, mixed $val<code> = array()</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -1076,19 +968,15 @@ passed array with key / value pairs</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method_where_not_in"></a><div class="element clickable method public method_where_not_in" data-toggle="collapse" data-target=".method_where_not_in .collapse" title="public">
<h2>WHERE NOT IN (FOO) clause</h2>
<pre>where_not_in(string $field, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<pre>where_not_in(string $field, mixed $val<code> = array()</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>fluent</th>
<td>This method is part of a fluent interface and will return the same instance</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$field</h4>
@ -1099,7 +987,7 @@ passed array with key / value pairs</h2>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
</div>
<a id="method__compile"></a><div class="element clickable method protected method__compile" data-toggle="collapse" data-target=".method__compile .collapse" title="protected">
@ -1229,7 +1117,7 @@ passed array with key / value pairs</h2>
</div>
<a id="method__run"></a><div class="element clickable method protected method__run" data-toggle="collapse" data-target=".method__run .collapse" title="protected">
<h2>Executes the compiled query</h2>
<pre>_run(string $type, string $table, string $sql<code> = NULL</code>, mixed $vals<code> = NULL</code>) : mixed</pre>
<pre>_run(string $type, string $table, string $sql<code> = NULL</code>, array|null $vals<code> = NULL</code>) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
@ -1248,10 +1136,10 @@ passed array with key / value pairs</h2>
</div>
<div class="subelement argument">
<h4>$vals</h4>
<code>mixed</code>
<code>array</code><code>null</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div>
</div>
<a id="method__select"></a><div class="element clickable method protected method__select" data-toggle="collapse" data-target=".method__select .collapse" title="protected">
@ -1572,7 +1460,7 @@ passed array with key / value pairs</h2>
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

1018
docs/classes/Query_Builder_Interface.html Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/classes/Query_Parser.html
View File

@ -173,7 +173,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

279
docs/classes/SQL_Interface.html Normal file
View File

@ -0,0 +1,279 @@
<!DOCTYPE html><html 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>Query » \SQL_Interface</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">Query</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/Query.html"><i class="icon-folder-open"></i> Query</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></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">
<div class="btn-toolbar">
<div 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>
</div>
<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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public "><a href="#method_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="#method_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="#method_explain" title="explain() :: Modify the query to get the query plan"><span class="description">Modify the query to get the query plan</span><pre>explain()</pre></a></li>
<li class="method public "><a href="#method_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="#method_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="#method_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="#method_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="#method_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="#method_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="#method_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="#method_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="#method_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="#method_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>
</li></ul>
</div>
<div class="span8">
<a id="\SQL_Interface"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/SQL_Interface.html">SQL_Interface</a>
</li>
</ul>
<div class="element interface">
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details">
<div class="long_description"></div>
<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 title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method_column_list"></a><div class="element clickable method public method_column_list" data-toggle="collapse" data-target=".method_column_list .collapse" title="public">
<h2>Get information about the columns in the
specified table</h2>
<pre>column_list(string $table) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_db_list"></a><div class="element clickable method public method_db_list" data-toggle="collapse" data-target=".method_db_list .collapse" title="public">
<h2>Returns sql to list other databases</h2>
<pre>db_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
<h2>Modify the query to get the query plan</h2>
<pre>explain(string $sql) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_function_list"></a><div class="element clickable method public method_function_list" data-toggle="collapse" data-target=".method_function_list .collapse" title="public">
<h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>NULL</code></div>
</div></div>
</div>
<a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse" title="public">
<h2>Get database specific sql for limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<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 id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse" title="public">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse" title="public">
<h2>Get the sql for random ordering</h2>
<pre>random() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<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 id="method_sequence_list"></a><div class="element clickable method public method_sequence_list" data-toggle="collapse" data-target=".method_sequence_list .collapse" title="public">
<h2>Return sql to list sequences</h2>
<pre>sequence_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_system_table_list"></a><div class="element clickable method public method_system_table_list" data-toggle="collapse" data-target=".method_system_table_list .collapse" title="public">
<h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_table_list"></a><div class="element clickable method public method_table_list" data-toggle="collapse" data-target=".method_table_list .collapse" title="public">
<h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_trigger_list"></a><div class="element clickable method public method_trigger_list" data-toggle="collapse" data-target=".method_trigger_list .collapse" title="public">
<h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a id="method_type_list"></a><div class="element clickable method public method_type_list" data-toggle="collapse" data-target=".method_type_list .collapse" title="public">
<h2>Return sql to list database field types</h2>
<pre>type_list() : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a id="method_view_list"></a><div class="element clickable method public method_view_list" data-toggle="collapse" data-target=".method_view_list .collapse" title="public">
<h2>Returns sql to list views</h2>
<pre>view_list() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<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.2.0
</a> and<br>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/SQLite.html
View File

@ -199,7 +199,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

26
docs/classes/SQLite_SQL.html
View File

@ -64,7 +64,6 @@
<li class="method public "><a href="#method_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="#method_explain" title="explain() :: Get the query plan for the sql query"><span class="description">Get the query plan for the sql query</span><pre>explain()</pre></a></li>
<li class="method public "><a href="#method_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="#method_limit" title="limit() :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
<li class="method public "><a href="#method_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="#method_random" title="random() :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
<li class="method public "><a href="#method_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>
@ -151,29 +150,6 @@
<div class="subelement response"><code>NULL</code></div>
</div></div>
</div>
<a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse" title="public">
<h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<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 id="method_procedure_list"></a><div class="element clickable method public method_procedure_list" data-toggle="collapse" data-target=".method_procedure_list .collapse" title="public">
<h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : NULL</pre>
@ -262,7 +238,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/SQLite_Util.html
View File

@ -209,7 +209,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/deprecated.html
View File

@ -66,7 +66,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

4
docs/errors.html
View File

@ -85,13 +85,15 @@
<div class="package-contents"></div>
<div class="package-contents"></div>
<div class="package-contents"></div>
<div class="package-contents"></div>
<div class="package-contents"></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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/graph_class.html
View File

@ -63,7 +63,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

6
docs/markers.html
View File

@ -73,7 +73,7 @@
</tr>
<tr>
<td>todo</td>
<td>107</td>
<td>47</td>
<td>Implement Backup structure function</td>
</tr>
</table></div>
@ -90,7 +90,7 @@
</tr>
<tr>
<td>todo</td>
<td>105</td>
<td>46</td>
<td>Implement Backup function</td>
</tr>
</table></div>
@ -102,7 +102,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

28
docs/namespaces/global.html
View File

@ -69,32 +69,34 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<li class="function "><a href="#function_query_autoload" title="query_autoload() :: Load query classes"><span class="description">Load query classes</span><pre>query_autoload</pre></a></li>
<li class="nav-header">
<i title="Interfaces" class="icon-custom icon-interface"></i> Interfaces</li>
<li><a href="#iDB_SQL" title="parent for database manipulation subclasses">iDB_SQL</a></li>
<li><a href="#iQuery_Builder" title="Interface defining the Query Builder class">iQuery_Builder</a></li>
<li><a href="#idriver" title="PDO Interface to implement for database drivers">idriver</a></li>
<li><a href="#Driver_Interface" title="PDO Interface to implement for database drivers">Driver_Interface</a></li>
<li><a href="#SQL_Interface" title="parent for database manipulation subclasses">SQL_Interface</a></li>
<li><a href="#Query_Builder_Interface" title="Interface defining the Query Builder class">Query_Builder_Interface</a></li>
<li class="nav-header">
<i title="Classes" class="icon-custom icon-class"></i> Classes</li>
<li><a href="#DB_Util" title="Abstract class defining database / table creation methods">DB_Util</a></li>
<li><a href="#Query_Parser" title="Utility Class to parse sql clauses for properly escaping identifiers">Query_Parser</a></li>
<li><a href="#Abstract_Driver" title="Base Database class">Abstract_Driver</a></li>
<li><a href="#Abstract_SQL" title="parent for database manipulation subclasses">Abstract_SQL</a></li>
<li><a href="#Query_Builder" title="Convienience class for creating sql queries - also the class that
instantiates the specific db driver">Query_Builder</a></li>
<li><a href="#SQLite_Util" title="SQLite-specific backup, import and creation methods">SQLite_Util</a></li>
<li><a href="#BadDBDriverException" title="Generic exception for bad drivers">BadDBDriverException</a></li>
<li><a href="#Connection_Manager" title="Connection manager class to manage connections for the
Query method">Connection_Manager</a></li>
<li><a href="#DB_Util" title="Abstract class defining database / table creation methods">DB_Util</a></li>
<li><a href="#SQLite" title="SQLite specific class">SQLite</a></li>
<li><a href="#SQLite_SQL" title="SQLite Specific SQL">SQLite_SQL</a></li>
<li><a href="#SQLite_Util" title="SQLite-specific backup, import and creation methods">SQLite_Util</a></li>
<li><a href="#Firebird" title="Firebird Database class">Firebird</a></li>
<li><a href="#Firebird_SQL" title="Firebird Specific SQL">Firebird_SQL</a></li>
<li><a href="#Firebird_Util" title="Firebird-specific backup, import and creation methods">Firebird_Util</a></li>
<li><a href="#Firebird_Result" title="Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods">Firebird_Result</a></li>
<li><a href="#Firebird" title="Firebird Database class">Firebird</a></li>
<li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li>
<li><a href="#PgSQL_SQL" title="PostgreSQL specifc SQL">PgSQL_SQL</a></li>
<li><a href="#Firebird_Util" title="Firebird-specific backup, import and creation methods">Firebird_Util</a></li>
<li><a href="#PgSQL" title="PostgreSQL specifc class">PgSQL</a></li>
<li><a href="#PgSQL_SQL" title="PostgreSQL specifc SQL">PgSQL_SQL</a></li>
<li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li>
<li><a href="#MySQL" title="MySQL specific class">MySQL</a></li>
<li><a href="#MySQL_SQL" title="MySQL specifc SQL">MySQL_SQL</a></li>
<li><a href="#MySQL_Util" title="MySQL-specific backup, import and creation methods">MySQL_Util</a></li>
<li><a href="#MySQL" title="MySQL specific class">MySQL</a></li>
<li><a href="#BadDBDriverException" title="Generic exception for bad drivers">BadDBDriverException</a></li>
<li><a href="#BadConnectionException" title="Generic exception for bad connection strings">BadConnectionException</a></li>
<li class="nav-header">
<i title="Constants" class="icon-custom icon-constant"></i> Constants</li>
<li class="constant "><a href="#constant_QBASE_PATH" title="QBASE_PATH() :: Reference to root path"><span class="description">Reference to root path</span><pre>QBASE_PATH</pre></a></li>
@ -107,7 +109,7 @@ data-fetching methods">Firebird_Result</a></li>
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/packages/Default.html
View File

@ -66,7 +66,7 @@
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

14
docs/packages/Query.Drivers.html
View File

@ -60,20 +60,20 @@
</li>
<li class="nav-header">
<i title="Classes" class="icon-custom icon-class"></i> Classes</li>
<li><a href="#SQLite_Util" title="SQLite-specific backup, import and creation methods">SQLite_Util</a></li>
<li><a href="#SQLite" title="SQLite specific class">SQLite</a></li>
<li><a href="#SQLite_SQL" title="SQLite Specific SQL">SQLite_SQL</a></li>
<li><a href="#SQLite_Util" title="SQLite-specific backup, import and creation methods">SQLite_Util</a></li>
<li><a href="#Firebird" title="Firebird Database class">Firebird</a></li>
<li><a href="#Firebird_SQL" title="Firebird Specific SQL">Firebird_SQL</a></li>
<li><a href="#Firebird_Util" title="Firebird-specific backup, import and creation methods">Firebird_Util</a></li>
<li><a href="#Firebird_Result" title="Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods">Firebird_Result</a></li>
<li><a href="#Firebird" title="Firebird Database class">Firebird</a></li>
<li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li>
<li><a href="#PgSQL_SQL" title="PostgreSQL specifc SQL">PgSQL_SQL</a></li>
<li><a href="#Firebird_Util" title="Firebird-specific backup, import and creation methods">Firebird_Util</a></li>
<li><a href="#PgSQL" title="PostgreSQL specifc class">PgSQL</a></li>
<li><a href="#PgSQL_SQL" title="PostgreSQL specifc SQL">PgSQL_SQL</a></li>
<li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li>
<li><a href="#MySQL" title="MySQL specific class">MySQL</a></li>
<li><a href="#MySQL_SQL" title="MySQL specifc SQL">MySQL_SQL</a></li>
<li><a href="#MySQL_Util" title="MySQL-specific backup, import and creation methods">MySQL_Util</a></li>
<li><a href="#MySQL" title="MySQL specific class">MySQL</a></li>
</ul>
</div>
<div class="span8 package-contents">
@ -185,7 +185,7 @@ data-fetching methods</p>
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

48
docs/packages/Query.Query.html
View File

@ -60,17 +60,19 @@
</li>
<li class="nav-header">
<i title="Interfaces" class="icon-custom icon-interface"></i> Interfaces</li>
<li><a href="#iDB_SQL" title="parent for database manipulation subclasses">iDB_SQL</a></li>
<li><a href="#iQuery_Builder" title="Interface defining the Query Builder class">iQuery_Builder</a></li>
<li><a href="#SQL_Interface" title="parent for database manipulation subclasses">SQL_Interface</a></li>
<li><a href="#Query_Builder_Interface" title="Interface defining the Query Builder class">Query_Builder_Interface</a></li>
<li class="nav-header">
<i title="Classes" class="icon-custom icon-class"></i> Classes</li>
<li><a href="#DB_Util" title="Abstract class defining database / table creation methods">DB_Util</a></li>
<li><a href="#Query_Parser" title="Utility Class to parse sql clauses for properly escaping identifiers">Query_Parser</a></li>
<li><a href="#Abstract_Driver" title="Base Database class">Abstract_Driver</a></li>
<li><a href="#Abstract_SQL" title="parent for database manipulation subclasses">Abstract_SQL</a></li>
<li><a href="#Query_Builder" title="Convienience class for creating sql queries - also the class that
instantiates the specific db driver">Query_Builder</a></li>
<li><a href="#BadDBDriverException" title="Generic exception for bad drivers">BadDBDriverException</a></li>
<li><a href="#BadConnectionException" title="Generic exception for bad connection strings">BadConnectionException</a></li>
<li><a href="#Connection_Manager" title="Connection manager class to manage connections for the
Query method">Connection_Manager</a></li>
<li><a href="#DB_Util" title="Abstract class defining database / table creation methods">DB_Util</a></li>
</ul>
</div>
<div class="span8 package-contents">
@ -83,19 +85,19 @@ instantiates the specific db driver">Query_Builder</a></li>
<div class="package-indent">
<h3>
<i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
<div id="iDB_SQL" class="element ajax clickable interface">
<h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a>
</h1>
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div>
<a href="../classes/iDB_SQL.html" class="more">« More »</a>
</div>
<div id="iQuery_Builder" class="element ajax clickable interface">
<h1>iQuery_Builder<a href="../classes/iQuery_Builder.html"></a>
<div id="Query_Builder_Interface" class="element ajax clickable interface">
<h1>Query_Builder_Interface<a href="../classes/Query_Builder_Interface.html"></a>
</h1>
<p class="short_description">Interface defining the Query Builder class</p>
<div class="details collapse"></div>
<a href="../classes/iQuery_Builder.html" class="more">« More »</a>
<a href="../classes/Query_Builder_Interface.html" class="more">« More »</a>
</div>
<div id="SQL_Interface" class="element ajax clickable interface">
<h1>SQL_Interface<a href="../classes/SQL_Interface.html"></a>
</h1>
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div>
<a href="../classes/SQL_Interface.html" class="more">« More »</a>
</div>
<div id="Abstract_Driver" class="element ajax clickable class">
<h1>Abstract_Driver<a href="../classes/Abstract_Driver.html"></a>
@ -104,12 +106,12 @@ instantiates the specific db driver">Query_Builder</a></li>
<div class="details collapse"></div>
<a href="../classes/Abstract_Driver.html" class="more">« More »</a>
</div>
<div id="BadConnectionException" class="element ajax clickable class">
<h1>BadConnectionException<a href="../classes/BadConnectionException.html"></a>
<div id="Abstract_SQL" class="element ajax clickable class">
<h1>Abstract_SQL<a href="../classes/Abstract_SQL.html"></a>
</h1>
<p class="short_description">Generic exception for bad connection strings</p>
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div>
<a href="../classes/BadConnectionException.html" class="more">« More »</a>
<a href="../classes/Abstract_SQL.html" class="more">« More »</a>
</div>
<div id="BadDBDriverException" class="element ajax clickable class">
<h1>BadDBDriverException<a href="../classes/BadDBDriverException.html"></a>
@ -118,6 +120,14 @@ instantiates the specific db driver">Query_Builder</a></li>
<div class="details collapse"></div>
<a href="../classes/BadDBDriverException.html" class="more">« More »</a>
</div>
<div id="Connection_Manager" class="element ajax clickable class">
<h1>Connection_Manager<a href="../classes/Connection_Manager.html"></a>
</h1>
<p class="short_description">Connection manager class to manage connections for the
Query method</p>
<div class="details collapse"></div>
<a href="../classes/Connection_Manager.html" class="more">« More »</a>
</div>
<div id="DB_Util" class="element ajax clickable class">
<h1>DB_Util<a href="../classes/DB_Util.html"></a>
</h1>
@ -147,7 +157,7 @@ instantiates the specific db driver</p>
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

61
docs/packages/Query.html
View File

@ -76,7 +76,7 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<li class="function "><a href="#function_query_autoload" title="query_autoload() :: Load query classes"><span class="description">Load query classes</span><pre>query_autoload</pre></a></li>
<li class="nav-header">
<i title="Interfaces" class="icon-custom icon-interface"></i> Interfaces</li>
<li><a href="#idriver" title="PDO Interface to implement for database drivers">idriver</a></li>
<li><a href="#Driver_Interface" title="PDO Interface to implement for database drivers">Driver_Interface</a></li>
<li class="nav-header">
<i title="Constants" class="icon-custom icon-constant"></i> Constants</li>
<li class="constant "><a href="#constant_QBASE_PATH" title="QBASE_PATH() :: Reference to root path"><span class="description">Reference to root path</span><pre>QBASE_PATH</pre></a></li>
@ -101,21 +101,6 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<h4>$params</h4>
<code>mixed</code>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered">
<tr>
<th><code><a href="InvalidArgumentException.html">\InvalidArgumentException</a></code></th>
<td></td>
</tr>
<tr>
<th><code><a href="../classes/BadDBDriverException.html">\BadDBDriverException</a></code></th>
<td></td>
</tr>
<tr>
<th><code><a href="../classes/BadConnectionException.html">\BadConnectionException</a></code></th>
<td></td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div>
@ -183,12 +168,12 @@ with array_map and glob</h2>
</div>
<h3>
<i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
<div id="idriver" class="element ajax clickable interface">
<h1>idriver<a href="../classes/idriver.html"></a>
<div id="Driver_Interface" class="element ajax clickable interface">
<h1>Driver_Interface<a href="../classes/Driver_Interface.html"></a>
</h1>
<p class="short_description">PDO Interface to implement for database drivers</p>
<div class="details collapse"></div>
<a href="../classes/idriver.html" class="more">« More »</a>
<a href="../classes/Driver_Interface.html" class="more">« More »</a>
</div>
<h3>
<i title="Constants" class="icon-custom icon-constant"></i> Constants</h3>
@ -315,19 +300,19 @@ data-fetching methods</p>
<div class="package-indent">
<h3>
<i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
<div id="iDB_SQL" class="element ajax clickable interface">
<h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a>
</h1>
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div>
<a href="../classes/iDB_SQL.html" class="more">« More »</a>
</div>
<div id="iQuery_Builder" class="element ajax clickable interface">
<h1>iQuery_Builder<a href="../classes/iQuery_Builder.html"></a>
<div id="Query_Builder_Interface" class="element ajax clickable interface">
<h1>Query_Builder_Interface<a href="../classes/Query_Builder_Interface.html"></a>
</h1>
<p class="short_description">Interface defining the Query Builder class</p>
<div class="details collapse"></div>
<a href="../classes/iQuery_Builder.html" class="more">« More »</a>
<a href="../classes/Query_Builder_Interface.html" class="more">« More »</a>
</div>
<div id="SQL_Interface" class="element ajax clickable interface">
<h1>SQL_Interface<a href="../classes/SQL_Interface.html"></a>
</h1>
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div>
<a href="../classes/SQL_Interface.html" class="more">« More »</a>
</div>
<div id="Abstract_Driver" class="element ajax clickable class">
<h1>Abstract_Driver<a href="../classes/Abstract_Driver.html"></a>
@ -336,12 +321,12 @@ data-fetching methods</p>
<div class="details collapse"></div>
<a href="../classes/Abstract_Driver.html" class="more">« More »</a>
</div>
<div id="BadConnectionException" class="element ajax clickable class">
<h1>BadConnectionException<a href="../classes/BadConnectionException.html"></a>
<div id="Abstract_SQL" class="element ajax clickable class">
<h1>Abstract_SQL<a href="../classes/Abstract_SQL.html"></a>
</h1>
<p class="short_description">Generic exception for bad connection strings</p>
<p class="short_description">parent for database manipulation subclasses</p>
<div class="details collapse"></div>
<a href="../classes/BadConnectionException.html" class="more">« More »</a>
<a href="../classes/Abstract_SQL.html" class="more">« More »</a>
</div>
<div id="BadDBDriverException" class="element ajax clickable class">
<h1>BadDBDriverException<a href="../classes/BadDBDriverException.html"></a>
@ -350,6 +335,14 @@ data-fetching methods</p>
<div class="details collapse"></div>
<a href="../classes/BadDBDriverException.html" class="more">« More »</a>
</div>
<div id="Connection_Manager" class="element ajax clickable class">
<h1>Connection_Manager<a href="../classes/Connection_Manager.html"></a>
</h1>
<p class="short_description">Connection manager class to manage connections for the
Query method</p>
<div class="details collapse"></div>
<a href="../classes/Connection_Manager.html" class="more">« More »</a>
</div>
<div id="DB_Util" class="element ajax clickable class">
<h1>DB_Util<a href="../classes/DB_Util.html"></a>
</h1>
@ -380,7 +373,7 @@ instantiates the specific db driver</p>
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.2.0
</a> and<br>
generated on 2014-03-26T20:50:45-04:00.<br></footer></div>
generated on 2014-03-31T13:31:59-04:00.<br></footer></div>
</div>
</body>
</html>

6762
docs/structure.xml
View File

File diff suppressed because one or more lines are too long