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

Update docs [ci skip]

Browse Source
This commit is contained in:
Timothy Warren 2014-02-18 15:16:34 -05:00
parent f6d50c678b
commit 46e5502278
37 changed files with 2542 additions and 2173 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

186
docs/classes.svg
View File

@ -22,25 +22,25 @@
</g> </g>
<!-- \\DB_PDO --> <!-- \\DB_PDO -->
<g id="node2" class="node"><title>\\DB_PDO</title> <g id="node2" class="node"><title>\\DB_PDO</title>
<polygon fill="none" stroke="black" points="325,-466 249,-466 249,-430 325,-430 325,-466"/> <polygon fill="none" stroke="black" points="325,-736 249,-736 249,-700 325,-700 325,-736"/>
<text text-anchor="start" x="257.5" y="-453.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text> <text text-anchor="start" x="257.5" y="-723.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="264" y="-440.233" font-family="Times Roman,serif" font-size="11.00">DB_PDO</text> <text text-anchor="start" x="264" y="-710.233" font-family="Times Roman,serif" font-size="11.00">DB_PDO</text>
</g> </g>
<!-- \\PDO --> <!-- \\PDO -->
<g id="node27" class="node"><title>\\PDO</title> <g id="node27" class="node"><title>\\PDO</title>
<ellipse fill="none" stroke="black" cx="36" cy="-448" rx="35.0527" ry="18"/> <ellipse fill="none" stroke="black" cx="36" cy="-718" rx="35.0527" ry="18"/>
<text text-anchor="middle" x="36" y="-443.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDO</text> <text text-anchor="middle" x="36" y="-713.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDO</text>
</g> </g>
<!-- \\DB_PDO&#45;&gt;\\PDO --> <!-- \\DB_PDO&#45;&gt;\\PDO -->
<g id="edge3" class="edge"><title>\\DB_PDO&#45;&gt;\\PDO</title> <g id="edge3" class="edge"><title>\\DB_PDO&#45;&gt;\\PDO</title>
<path fill="none" stroke="black" d="M248.879,-448C204.032,-448 129.635,-448 81.7269,-448"/> <path fill="none" stroke="black" d="M248.879,-718C204.032,-718 129.635,-718 81.7269,-718"/>
<polygon fill="none" stroke="black" points="81.6312,-444.5 71.6312,-448 81.6311,-451.5 81.6312,-444.5"/> <polygon fill="none" stroke="black" points="81.6312,-714.5 71.6312,-718 81.6311,-721.5 81.6312,-714.5"/>
</g> </g>
<!-- \\DB_Util --> <!-- \\DB_Util -->
<g id="node3" class="node"><title>\\DB_Util</title> <g id="node3" class="node"><title>\\DB_Util</title>
<polygon fill="none" stroke="black" points="325,-1006 249,-1006 249,-970 325,-970 325,-1006"/> <polygon fill="none" stroke="black" points="325,-466 249,-466 249,-430 325,-430 325,-466"/>
<text text-anchor="start" x="257.5" y="-993.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text> <text text-anchor="start" x="257.5" y="-453.433" font-family="Times Roman,serif" font-size="11.00">«abstract»</text>
<text text-anchor="start" x="266.5" y="-980.233" font-family="Times Roman,serif" font-size="11.00">DB_Util</text> <text text-anchor="start" x="266.5" y="-440.233" font-family="Times Roman,serif" font-size="11.00">DB_Util</text>
</g> </g>
<!-- \\Query_Parser --> <!-- \\Query_Parser -->
<g id="node4" class="node"><title>\\Query_Parser</title> <g id="node4" class="node"><title>\\Query_Parser</title>
@ -64,173 +64,173 @@
</g> </g>
<!-- \\ODBC_SQL --> <!-- \\ODBC_SQL -->
<g id="node6" class="node"><title>\\ODBC_SQL</title> <g id="node6" class="node"><title>\\ODBC_SQL</title>
<polygon fill="none" stroke="black" points="617,-844 541,-844 541,-808 617,-808 617,-844"/> <polygon fill="none" stroke="black" points="617,-1114 541,-1114 541,-1078 617,-1078 617,-1114"/>
<text text-anchor="middle" x="579" y="-822.6" font-family="Times Roman,serif" font-size="11.00">ODBC_SQL</text> <text text-anchor="middle" x="579" y="-1092.6" font-family="Times Roman,serif" font-size="11.00">ODBC_SQL</text>
</g> </g>
<!-- \\iDB_SQL --> <!-- \\iDB_SQL -->
<g id="node24" class="node"><title>\\iDB_SQL</title> <g id="node24" class="node"><title>\\iDB_SQL</title>
<polygon fill="none" stroke="black" points="318,-736 256,-736 256,-700 318,-700 318,-736"/> <polygon fill="none" stroke="black" points="318,-1006 256,-1006 256,-970 318,-970 318,-1006"/>
<text text-anchor="middle" x="287" y="-714.6" font-family="Times Roman,serif" font-size="11.00">iDB_SQL</text> <text text-anchor="middle" x="287" y="-984.6" font-family="Times Roman,serif" font-size="11.00">iDB_SQL</text>
</g> </g>
<!-- \\ODBC_SQL&#45;&gt;\\iDB_SQL --> <!-- \\ODBC_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge7" class="edge"><title>\\ODBC_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge7" class="edge"><title>\\ODBC_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M540.948,-812.852C528.512,-808.503 514.647,-803.599 502,-799 441.314,-776.932 371.402,-750.382 328.201,-733.844"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M540.948,-1082.85C528.512,-1078.5 514.647,-1073.6 502,-1069 441.314,-1046.93 371.402,-1020.38 328.201,-1003.84"/>
<polygon fill="none" stroke="black" points="329.199,-730.479 318.609,-730.169 326.694,-737.015 329.199,-730.479"/> <polygon fill="none" stroke="black" points="329.199,-1000.48 318.609,-1000.17 326.694,-1007.02 329.199,-1000.48"/>
</g> </g>
<!-- \\ODBC --> <!-- \\ODBC -->
<g id="node7" class="node"><title>\\ODBC</title> <g id="node7" class="node"><title>\\ODBC</title>
<polygon fill="none" stroke="black" points="606,-574 552,-574 552,-538 606,-538 606,-574"/> <polygon fill="none" stroke="black" points="606,-844 552,-844 552,-808 606,-808 606,-844"/>
<text text-anchor="middle" x="579" y="-552.6" font-family="Times Roman,serif" font-size="11.00">ODBC</text> <text text-anchor="middle" x="579" y="-822.6" font-family="Times Roman,serif" font-size="11.00">ODBC</text>
</g> </g>
<!-- \\ODBC&#45;&gt;\\DB_PDO --> <!-- \\ODBC&#45;&gt;\\DB_PDO -->
<g id="edge9" class="edge"><title>\\ODBC&#45;&gt;\\DB_PDO</title> <g id="edge9" class="edge"><title>\\ODBC&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M551.863,-546.656C537.09,-541.525 518.508,-535.003 502,-529 444.323,-508.026 378.311,-483.004 334.819,-466.376"/> <path fill="none" stroke="black" d="M551.863,-816.656C537.09,-811.525 518.508,-805.003 502,-799 444.323,-778.026 378.311,-753.004 334.819,-736.376"/>
<polygon fill="none" stroke="black" points="335.941,-463.058 325.351,-462.753 333.439,-469.596 335.941,-463.058"/> <polygon fill="none" stroke="black" points="335.941,-733.058 325.351,-732.753 333.439,-739.596 335.941,-733.058"/>
</g> </g>
<!-- \\ODBC_Util --> <!-- \\ODBC_Util -->
<g id="node8" class="node"><title>\\ODBC_Util</title> <g id="node8" class="node"><title>\\ODBC_Util</title>
<polygon fill="none" stroke="black" points="615,-1114 543,-1114 543,-1078 615,-1078 615,-1114"/> <polygon fill="none" stroke="black" points="615,-574 543,-574 543,-538 615,-538 615,-574"/>
<text text-anchor="middle" x="579" y="-1092.6" font-family="Times Roman,serif" font-size="11.00">ODBC_Util</text> <text text-anchor="middle" x="579" y="-552.6" font-family="Times Roman,serif" font-size="11.00">ODBC_Util</text>
</g> </g>
<!-- \\ODBC_Util&#45;&gt;\\DB_Util --> <!-- \\ODBC_Util&#45;&gt;\\DB_Util -->
<g id="edge11" class="edge"><title>\\ODBC_Util&#45;&gt;\\DB_Util</title> <g id="edge11" class="edge"><title>\\ODBC_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M542.122,-1083.26C529.389,-1078.81 515.047,-1073.74 502,-1069 444.323,-1048.03 378.311,-1023 334.819,-1006.38"/> <path fill="none" stroke="black" d="M542.122,-543.263C529.389,-538.813 515.047,-533.744 502,-529 444.323,-508.026 378.311,-483.004 334.819,-466.376"/>
<polygon fill="none" stroke="black" points="335.941,-1003.06 325.351,-1002.75 333.439,-1009.6 335.941,-1003.06"/> <polygon fill="none" stroke="black" points="335.941,-463.058 325.351,-462.753 333.439,-469.596 335.941,-463.058"/>
</g> </g>
<!-- \\SQLite_SQL --> <!-- \\SQLite_SQL -->
<g id="node9" class="node"><title>\\SQLite_SQL</title> <g id="node9" class="node"><title>\\SQLite_SQL</title>
<polygon fill="none" stroke="black" points="619,-790 539,-790 539,-754 619,-754 619,-790"/> <polygon fill="none" stroke="black" points="619,-1060 539,-1060 539,-1024 619,-1024 619,-1060"/>
<text text-anchor="middle" x="579" y="-768.6" font-family="Times Roman,serif" font-size="11.00">SQLite_SQL</text> <text text-anchor="middle" x="579" y="-1038.6" font-family="Times Roman,serif" font-size="11.00">SQLite_SQL</text>
</g> </g>
<!-- \\SQLite_SQL&#45;&gt;\\iDB_SQL --> <!-- \\SQLite_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge13" class="edge"><title>\\SQLite_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge13" class="edge"><title>\\SQLite_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M538.705,-764.548C483.474,-754.334 384.742,-736.075 328.755,-725.722"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M538.705,-1034.55C483.474,-1024.33 384.742,-1006.08 328.755,-995.722"/>
<polygon fill="none" stroke="black" points="329.288,-722.261 318.819,-723.884 328.015,-729.144 329.288,-722.261"/> <polygon fill="none" stroke="black" points="329.288,-992.261 318.819,-993.884 328.015,-999.144 329.288,-992.261"/>
</g>
<!-- \\SQLite_Util -->
<g id="node10" class="node"><title>\\SQLite_Util</title>
<polygon fill="none" stroke="black" points="617,-1060 541,-1060 541,-1024 617,-1024 617,-1060"/>
<text text-anchor="middle" x="579" y="-1038.6" font-family="Times Roman,serif" font-size="11.00">SQLite_Util</text>
</g>
<!-- \\SQLite_Util&#45;&gt;\\DB_Util -->
<g id="edge15" class="edge"><title>\\SQLite_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M540.225,-1034.83C487.246,-1025.03 392.288,-1007.47 334.918,-996.861"/>
<polygon fill="none" stroke="black" points="335.478,-993.406 325.008,-995.029 334.205,-1000.29 335.478,-993.406"/>
</g> </g>
<!-- \\SQLite --> <!-- \\SQLite -->
<g id="node11" class="node"><title>\\SQLite</title> <g id="node10" class="node"><title>\\SQLite</title>
<polygon fill="none" stroke="black" points="606,-520 552,-520 552,-484 606,-484 606,-520"/> <polygon fill="none" stroke="black" points="606,-790 552,-790 552,-754 606,-754 606,-790"/>
<text text-anchor="middle" x="579" y="-498.6" font-family="Times Roman,serif" font-size="11.00">SQLite</text> <text text-anchor="middle" x="579" y="-768.6" font-family="Times Roman,serif" font-size="11.00">SQLite</text>
</g> </g>
<!-- \\SQLite&#45;&gt;\\DB_PDO --> <!-- \\SQLite&#45;&gt;\\DB_PDO -->
<g id="edge17" class="edge"><title>\\SQLite&#45;&gt;\\DB_PDO</title> <g id="edge15" class="edge"><title>\\SQLite&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M551.792,-496.968C502.303,-487.816 396.973,-468.338 335.113,-456.898"/> <path fill="none" stroke="black" d="M551.792,-766.968C502.303,-757.816 396.973,-738.338 335.113,-726.898"/>
<polygon fill="none" stroke="black" points="335.672,-453.442 325.203,-455.065 334.399,-460.325 335.672,-453.442"/> <polygon fill="none" stroke="black" points="335.672,-723.442 325.203,-725.065 334.399,-730.325 335.672,-723.442"/>
</g> </g>
<!-- \\Firebird_Util --> <!-- \\SQLite_Util -->
<g id="node12" class="node"><title>\\Firebird_Util</title> <g id="node11" class="node"><title>\\SQLite_Util</title>
<polygon fill="none" stroke="black" points="620,-1006 538,-1006 538,-970 620,-970 620,-1006"/> <polygon fill="none" stroke="black" points="617,-520 541,-520 541,-484 617,-484 617,-520"/>
<text text-anchor="middle" x="579" y="-984.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Util</text> <text text-anchor="middle" x="579" y="-498.6" font-family="Times Roman,serif" font-size="11.00">SQLite_Util</text>
</g> </g>
<!-- \\Firebird_Util&#45;&gt;\\DB_Util --> <!-- \\SQLite_Util&#45;&gt;\\DB_Util -->
<g id="edge19" class="edge"><title>\\Firebird_Util&#45;&gt;\\DB_Util</title> <g id="edge17" class="edge"><title>\\SQLite_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M537.783,-988C484.504,-988 391.879,-988 335.34,-988"/> <path fill="none" stroke="black" d="M540.225,-494.829C487.246,-485.032 392.288,-467.471 334.918,-456.861"/>
<polygon fill="none" stroke="black" points="335.221,-984.5 325.221,-988 335.221,-991.5 335.221,-984.5"/> <polygon fill="none" stroke="black" points="335.478,-453.406 325.008,-455.029 334.205,-460.289 335.478,-453.406"/>
</g>
<!-- \\Firebird_SQL -->
<g id="node13" class="node"><title>\\Firebird_SQL</title>
<polygon fill="none" stroke="black" points="621,-736 537,-736 537,-700 621,-700 621,-736"/>
<text text-anchor="middle" x="579" y="-714.6" font-family="Times Roman,serif" font-size="11.00">Firebird_SQL</text>
</g>
<!-- \\Firebird_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge21" class="edge"><title>\\Firebird_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M536.228,-718C480.57,-718 383.933,-718 328.771,-718"/>
<polygon fill="none" stroke="black" points="328.645,-714.5 318.645,-718 328.645,-721.5 328.645,-714.5"/>
</g> </g>
<!-- \\Firebird_Result --> <!-- \\Firebird_Result -->
<g id="node14" class="node"><title>\\Firebird_Result</title> <g id="node12" class="node"><title>\\Firebird_Result</title>
<polygon fill="none" stroke="black" points="627,-304 531,-304 531,-268 627,-268 627,-304"/> <polygon fill="none" stroke="black" points="627,-304 531,-304 531,-268 627,-268 627,-304"/>
<text text-anchor="middle" x="579" y="-282.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Result</text> <text text-anchor="middle" x="579" y="-282.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Result</text>
</g> </g>
<!-- \\PDOStatement --> <!-- \\PDOStatement -->
<g id="node38" class="node"><title>\\PDOStatement</title> <g id="node36" class="node"><title>\\PDOStatement</title>
<ellipse fill="none" stroke="black" cx="287" cy="-126" rx="85.1942" ry="18"/> <ellipse fill="none" stroke="black" cx="287" cy="-126" rx="85.1942" ry="18"/>
<text text-anchor="middle" x="287" y="-121.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDOStatement</text> <text text-anchor="middle" x="287" y="-121.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDOStatement</text>
</g> </g>
<!-- \\Firebird_Result&#45;&gt;\\PDOStatement --> <!-- \\Firebird_Result&#45;&gt;\\PDOStatement -->
<g id="edge23" class="edge"><title>\\Firebird_Result&#45;&gt;\\PDOStatement</title> <g id="edge19" class="edge"><title>\\Firebird_Result&#45;&gt;\\PDOStatement</title>
<path fill="none" stroke="black" d="M530.48,-274.443C520.419,-270.603 510.352,-265.567 502,-259 455.775,-222.654 479.379,-179.93 430,-148 415.718,-138.765 398.987,-132.876 382.102,-129.209"/> <path fill="none" stroke="black" d="M530.48,-274.443C520.419,-270.603 510.352,-265.567 502,-259 455.775,-222.654 479.379,-179.93 430,-148 415.718,-138.765 398.987,-132.876 382.102,-129.209"/>
<polygon fill="none" stroke="black" points="382.64,-125.748 372.159,-127.298 381.319,-132.623 382.64,-125.748"/> <polygon fill="none" stroke="black" points="382.64,-125.748 372.159,-127.298 381.319,-132.623 382.64,-125.748"/>
</g> </g>
<!-- \\Firebird_SQL -->
<g id="node13" class="node"><title>\\Firebird_SQL</title>
<polygon fill="none" stroke="black" points="621,-1006 537,-1006 537,-970 621,-970 621,-1006"/>
<text text-anchor="middle" x="579" y="-984.6" font-family="Times Roman,serif" font-size="11.00">Firebird_SQL</text>
</g>
<!-- \\Firebird_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge21" class="edge"><title>\\Firebird_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M536.228,-988C480.57,-988 383.933,-988 328.771,-988"/>
<polygon fill="none" stroke="black" points="328.645,-984.5 318.645,-988 328.645,-991.5 328.645,-984.5"/>
</g>
<!-- \\Firebird_Util -->
<g id="node14" class="node"><title>\\Firebird_Util</title>
<polygon fill="none" stroke="black" points="620,-466 538,-466 538,-430 620,-430 620,-466"/>
<text text-anchor="middle" x="579" y="-444.6" font-family="Times Roman,serif" font-size="11.00">Firebird_Util</text>
</g>
<!-- \\Firebird_Util&#45;&gt;\\DB_Util -->
<g id="edge23" class="edge"><title>\\Firebird_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M537.783,-448C484.504,-448 391.879,-448 335.34,-448"/>
<polygon fill="none" stroke="black" points="335.221,-444.5 325.221,-448 335.221,-451.5 335.221,-444.5"/>
</g>
<!-- \\Firebird --> <!-- \\Firebird -->
<g id="node15" class="node"><title>\\Firebird</title> <g id="node15" class="node"><title>\\Firebird</title>
<polygon fill="none" stroke="black" points="608,-466 550,-466 550,-430 608,-430 608,-466"/> <polygon fill="none" stroke="black" points="608,-736 550,-736 550,-700 608,-700 608,-736"/>
<text text-anchor="middle" x="579" y="-444.6" font-family="Times Roman,serif" font-size="11.00">Firebird</text> <text text-anchor="middle" x="579" y="-714.6" font-family="Times Roman,serif" font-size="11.00">Firebird</text>
</g> </g>
<!-- \\Firebird&#45;&gt;\\DB_PDO --> <!-- \\Firebird&#45;&gt;\\DB_PDO -->
<g id="edge25" class="edge"><title>\\Firebird&#45;&gt;\\DB_PDO</title> <g id="edge25" class="edge"><title>\\Firebird&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M549.934,-448C499.752,-448 396.38,-448 335.263,-448"/> <path fill="none" stroke="black" d="M549.934,-718C499.752,-718 396.38,-718 335.263,-718"/>
<polygon fill="none" stroke="black" points="335.099,-444.5 325.099,-448 335.099,-451.5 335.099,-444.5"/> <polygon fill="none" stroke="black" points="335.099,-714.5 325.099,-718 335.099,-721.5 335.099,-714.5"/>
</g> </g>
<!-- \\PgSQL --> <!-- \\PgSQL -->
<g id="node16" class="node"><title>\\PgSQL</title> <g id="node16" class="node"><title>\\PgSQL</title>
<polygon fill="none" stroke="black" points="606,-412 552,-412 552,-376 606,-376 606,-412"/> <polygon fill="none" stroke="black" points="606,-682 552,-682 552,-646 606,-646 606,-682"/>
<text text-anchor="middle" x="579" y="-390.6" font-family="Times Roman,serif" font-size="11.00">PgSQL</text> <text text-anchor="middle" x="579" y="-660.6" font-family="Times Roman,serif" font-size="11.00">PgSQL</text>
</g> </g>
<!-- \\PgSQL&#45;&gt;\\DB_PDO --> <!-- \\PgSQL&#45;&gt;\\DB_PDO -->
<g id="edge27" class="edge"><title>\\PgSQL&#45;&gt;\\DB_PDO</title> <g id="edge27" class="edge"><title>\\PgSQL&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M551.907,-400.321C522.121,-407.153 472.804,-418.118 430,-426 398.567,-431.788 363.052,-437.258 335.279,-441.295"/> <path fill="none" stroke="black" d="M551.792,-669.032C502.303,-678.184 396.973,-697.662 335.113,-709.102"/>
<polygon fill="none" stroke="black" points="334.437,-437.88 325.039,-442.77 335.435,-444.809 334.437,-437.88"/> <polygon fill="none" stroke="black" points="334.399,-705.675 325.203,-710.935 335.672,-712.558 334.399,-705.675"/>
</g> </g>
<!-- \\PgSQL_Util --> <!-- \\PgSQL_Util -->
<g id="node17" class="node"><title>\\PgSQL_Util</title> <g id="node17" class="node"><title>\\PgSQL_Util</title>
<polygon fill="none" stroke="black" points="617,-952 541,-952 541,-916 617,-916 617,-952"/> <polygon fill="none" stroke="black" points="617,-412 541,-412 541,-376 617,-376 617,-412"/>
<text text-anchor="middle" x="579" y="-930.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_Util</text> <text text-anchor="middle" x="579" y="-390.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_Util</text>
</g> </g>
<!-- \\PgSQL_Util&#45;&gt;\\DB_Util --> <!-- \\PgSQL_Util&#45;&gt;\\DB_Util -->
<g id="edge29" class="edge"><title>\\PgSQL_Util&#45;&gt;\\DB_Util</title> <g id="edge29" class="edge"><title>\\PgSQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M540.826,-941.06C488.034,-950.822 392.746,-968.444 335.135,-979.098"/> <path fill="none" stroke="black" d="M540.844,-402.843C510.815,-409.645 467.86,-419.028 430,-426 398.567,-431.788 363.052,-437.258 335.279,-441.295"/>
<polygon fill="none" stroke="black" points="334.38,-975.679 325.183,-980.939 335.653,-982.562 334.38,-975.679"/> <polygon fill="none" stroke="black" points="334.437,-437.88 325.039,-442.77 335.435,-444.809 334.437,-437.88"/>
</g> </g>
<!-- \\PgSQL_SQL --> <!-- \\PgSQL_SQL -->
<g id="node18" class="node"><title>\\PgSQL_SQL</title> <g id="node18" class="node"><title>\\PgSQL_SQL</title>
<polygon fill="none" stroke="black" points="619,-682 539,-682 539,-646 619,-646 619,-682"/> <polygon fill="none" stroke="black" points="619,-952 539,-952 539,-916 619,-916 619,-952"/>
<text text-anchor="middle" x="579" y="-660.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_SQL</text> <text text-anchor="middle" x="579" y="-930.6" font-family="Times Roman,serif" font-size="11.00">PgSQL_SQL</text>
</g> </g>
<!-- \\PgSQL_SQL&#45;&gt;\\iDB_SQL --> <!-- \\PgSQL_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge31" class="edge"><title>\\PgSQL_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge31" class="edge"><title>\\PgSQL_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M538.705,-671.452C483.474,-681.666 384.742,-699.925 328.755,-710.278"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M538.705,-941.452C483.474,-951.666 384.742,-969.925 328.755,-980.278"/>
<polygon fill="none" stroke="black" points="328.015,-706.856 318.819,-712.116 329.288,-713.739 328.015,-706.856"/> <polygon fill="none" stroke="black" points="328.015,-976.856 318.819,-982.116 329.288,-983.739 328.015,-976.856"/>
</g> </g>
<!-- \\MySQL --> <!-- \\MySQL -->
<g id="node19" class="node"><title>\\MySQL</title> <g id="node19" class="node"><title>\\MySQL</title>
<polygon fill="none" stroke="black" points="606,-358 552,-358 552,-322 606,-322 606,-358"/> <polygon fill="none" stroke="black" points="606,-628 552,-628 552,-592 606,-592 606,-628"/>
<text text-anchor="middle" x="579" y="-336.6" font-family="Times Roman,serif" font-size="11.00">MySQL</text> <text text-anchor="middle" x="579" y="-606.6" font-family="Times Roman,serif" font-size="11.00">MySQL</text>
</g> </g>
<!-- \\MySQL&#45;&gt;\\DB_PDO --> <!-- \\MySQL&#45;&gt;\\DB_PDO -->
<g id="edge33" class="edge"><title>\\MySQL&#45;&gt;\\DB_PDO</title> <g id="edge33" class="edge"><title>\\MySQL&#45;&gt;\\DB_PDO</title>
<path fill="none" stroke="black" d="M551.274,-347.161C536.158,-351.686 517.438,-358.327 502,-367 465.931,-387.264 467.783,-409.147 430,-426 400.273,-439.26 364,-444.733 335.425,-446.904"/> <path fill="none" stroke="black" d="M551.145,-619.594C536.491,-624.685 518.242,-631.094 502,-637 444.323,-657.974 378.311,-682.996 334.819,-699.624"/>
<polygon fill="none" stroke="black" points="335.024,-443.423 325.272,-447.563 335.478,-450.408 335.024,-443.423"/> <polygon fill="none" stroke="black" points="333.439,-696.404 325.351,-703.247 335.941,-702.942 333.439,-696.404"/>
</g> </g>
<!-- \\MySQL_Util --> <!-- \\MySQL_Util -->
<g id="node20" class="node"><title>\\MySQL_Util</title> <g id="node20" class="node"><title>\\MySQL_Util</title>
<polygon fill="none" stroke="black" points="618,-898 540,-898 540,-862 618,-862 618,-898"/> <polygon fill="none" stroke="black" points="618,-358 540,-358 540,-322 618,-322 618,-358"/>
<text text-anchor="middle" x="579" y="-876.6" font-family="Times Roman,serif" font-size="11.00">MySQL_Util</text> <text text-anchor="middle" x="579" y="-336.6" font-family="Times Roman,serif" font-size="11.00">MySQL_Util</text>
</g> </g>
<!-- \\MySQL_Util&#45;&gt;\\DB_Util --> <!-- \\MySQL_Util&#45;&gt;\\DB_Util -->
<g id="edge35" class="edge"><title>\\MySQL_Util&#45;&gt;\\DB_Util</title> <g id="edge35" class="edge"><title>\\MySQL_Util&#45;&gt;\\DB_Util</title>
<path fill="none" stroke="black" d="M539.37,-893.7C527.347,-897.909 514.115,-902.594 502,-907 444.323,-927.974 378.311,-952.996 334.819,-969.624"/> <path fill="none" stroke="black" d="M539.468,-350.917C527.075,-355.105 513.609,-360.478 502,-367 465.931,-387.264 467.783,-409.147 430,-426 400.273,-439.26 364,-444.733 335.425,-446.904"/>
<polygon fill="none" stroke="black" points="333.439,-966.404 325.351,-973.247 335.941,-972.942 333.439,-966.404"/> <polygon fill="none" stroke="black" points="335.024,-443.423 325.272,-447.563 335.478,-450.408 335.024,-443.423"/>
</g> </g>
<!-- \\MySQL_SQL --> <!-- \\MySQL_SQL -->
<g id="node21" class="node"><title>\\MySQL_SQL</title> <g id="node21" class="node"><title>\\MySQL_SQL</title>
<polygon fill="none" stroke="black" points="620,-628 538,-628 538,-592 620,-592 620,-628"/> <polygon fill="none" stroke="black" points="620,-898 538,-898 538,-862 620,-862 620,-898"/>
<text text-anchor="middle" x="579" y="-606.6" font-family="Times Roman,serif" font-size="11.00">MySQL_SQL</text> <text text-anchor="middle" x="579" y="-876.6" font-family="Times Roman,serif" font-size="11.00">MySQL_SQL</text>
</g> </g>
<!-- \\MySQL_SQL&#45;&gt;\\iDB_SQL --> <!-- \\MySQL_SQL&#45;&gt;\\iDB_SQL -->
<g id="edge37" class="edge"><title>\\MySQL_SQL&#45;&gt;\\iDB_SQL</title> <g id="edge37" class="edge"><title>\\MySQL_SQL&#45;&gt;\\iDB_SQL</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M537.778,-624.258C526.185,-628.321 513.582,-632.788 502,-637 441.314,-659.068 371.402,-685.618 328.201,-702.156"/> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M537.778,-894.258C526.185,-898.321 513.582,-902.788 502,-907 441.314,-929.068 371.402,-955.618 328.201,-972.156"/>
<polygon fill="none" stroke="black" points="326.694,-698.985 318.609,-705.831 329.199,-705.521 326.694,-698.985"/> <polygon fill="none" stroke="black" points="326.694,-968.985 318.609,-975.831 329.199,-975.521 326.694,-968.985"/>
</g> </g>
<!-- \\BadDBDriverException --> <!-- \\BadDBDriverException -->
<g id="node22" class="node"><title>\\BadDBDriverException</title> <g id="node22" class="node"><title>\\BadDBDriverException</title>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

13
docs/classes/BadConnectionException.html
View File

@ -49,15 +49,20 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"></ul> <ul class="side-nav nav nav-list"></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a id="\BadConnectionException"></a><ul class="breadcrumb"> <a id="\BadConnectionException"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/BadConnectionException.html">BadConnectionException</a> <span class="divider">\</span><a href="../classes/BadConnectionException.html">BadConnectionException</a>
@ -83,9 +88,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

13
docs/classes/BadDBDriverException.html
View File

@ -49,15 +49,20 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"></ul> <ul class="side-nav nav nav-list"></ul>
</div> </div>
<div class="span8"> <div class="span8">
<a id="\BadDBDriverException"></a><ul class="breadcrumb"> <a id="\BadDBDriverException"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/BadDBDriverException.html">BadDBDriverException</a> <span class="divider">\</span><a href="../classes/BadDBDriverException.html">BadDBDriverException</a>
@ -83,9 +88,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

146
docs/classes/DB_PDO.html
View File

@ -49,14 +49,20 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: PDO constructor wrapper"><span class="description">PDO constructor wrapper</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: PDO constructor wrapper"><span class="description">PDO constructor wrapper</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method__quote" title="_quote() :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
<li class="method public "><a href="#method_affected_rows" title="affected_rows() :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li> <li class="method public "><a href="#method_affected_rows" title="affected_rows() :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
<li class="method public "><a href="#method_driver_query" title="driver_query() :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li> <li class="method public "><a href="#method_driver_query" title="driver_query() :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
<li class="method public "><a href="#method_get_columns" title="get_columns() :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li> <li class="method public "><a href="#method_get_columns" title="get_columns() :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
@ -82,13 +88,10 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</ul> </ul>
</li> </li>
<li class="nav-header protected">» Protected <li class="nav-header protected">» Protected
<ul> <ul><li class="method protected "><a href="#method__prefix" title="_prefix() :: Sets the table prefix on the passed string"><span class="description">Sets the table prefix on the passed string</span><pre>_prefix()</pre></a></li></ul>
<li class="method protected "><a href="#method__prefix" title="_prefix() :: Sets the table prefix on the passed string"><span class="description">Sets the table prefix on the passed string</span><pre>_prefix()</pre></a></li>
<li class="method protected "><a href="#method__quote" title="_quote() :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
</ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul> <ul>
<li class="property public "><a href="#property_last_query" title="$last_query() :: "><span class="description"></span><pre>$last_query</pre></a></li> <li class="property public "><a href="#property_last_query" title="$last_query() :: "><span class="description"></span><pre>$last_query</pre></a></li>
<li class="property public "><a href="#property_sql" title="$sql() :: "><span class="description"></span><pre>$sql</pre></a></li> <li class="property public "><a href="#property_sql" title="$sql() :: "><span class="description"></span><pre>$sql</pre></a></li>
@ -107,7 +110,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="span8"> <div class="span8">
<a id="\DB_PDO"></a><ul class="breadcrumb"> <a id="\DB_PDO"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/DB_PDO.html">DB_PDO</a> <span class="divider">\</span><a href="../classes/DB_PDO.html">DB_PDO</a>
@ -128,10 +131,10 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>PDO constructor wrapper</h2> <h2>PDO constructor wrapper</h2>
<pre>__construct(string $dsn, string $username, string $password, array $driver_options) </pre> <pre>__construct(string $dsn, string $username<code> = NULL</code>, string $password<code> = NULL</code>, array $driver_options<code> = array()</code>) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -154,24 +157,34 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="method_affected_rows"></a><div class="element clickable method public method_affected_rows" data-toggle="collapse" data-target=".method_affected_rows .collapse"> <a id="method__quote"></a><div class="element clickable method public method__quote" data-toggle="collapse" data-target=".method__quote .collapse" title="public">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2> <h2>Helper method for quote_ident</h2>
<pre>affected_rows(\PDOStatement $statement) : int</pre> <pre>_quote(mixed $str) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$statement</h4> <h4>$str</h4>
<code><a href="PDOStatement.html">\PDOStatement</a></code> <code>mixed</code>
</div> </div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a id="method_affected_rows"></a><div class="element clickable method public method_affected_rows" data-toggle="collapse" data-target=".method_affected_rows .collapse" title="public">
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
<pre>affected_rows() : int</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>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_driver_query"></a><div class="element clickable method public method_driver_query" data-toggle="collapse" data-target=".method_driver_query .collapse"> <a id="method_driver_query"></a><div class="element clickable method public method_driver_query" data-toggle="collapse" data-target=".method_driver_query .collapse" title="public">
<h2>Method to simplify retreiving db results for meta-data queries</h2> <h2>Method to simplify retreiving db results for meta-data queries</h2>
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre> <pre>driver_query(string $sql, bool $filtered_index<code> = TRUE</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -188,7 +201,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_columns"></a><div class="element clickable method public method_get_columns" data-toggle="collapse" data-target=".method_get_columns .collapse"> <a id="method_get_columns"></a><div class="element clickable method public method_get_columns" data-toggle="collapse" data-target=".method_get_columns .collapse" title="public">
<h2>Retrieve column information for the current database table</h2> <h2>Retrieve column information for the current database table</h2>
<pre>get_columns(string $table) : array</pre> <pre>get_columns(string $table) : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -203,7 +216,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_dbs"></a><div class="element clickable method public method_get_dbs" data-toggle="collapse" data-target=".method_get_dbs .collapse"> <a id="method_get_dbs"></a><div class="element clickable method public method_get_dbs" data-toggle="collapse" data-target=".method_get_dbs .collapse" title="public">
<h2>Return list of dbs for the current connection, if possible</h2> <h2>Return list of dbs for the current connection, if possible</h2>
<pre>get_dbs() : array</pre> <pre>get_dbs() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -213,7 +226,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_functions"></a><div class="element clickable method public method_get_functions" data-toggle="collapse" data-target=".method_get_functions .collapse"> <a id="method_get_functions"></a><div class="element clickable method public method_get_functions" data-toggle="collapse" data-target=".method_get_functions .collapse" title="public">
<h2>Return list of function for the current database</h2> <h2>Return list of function for the current database</h2>
<pre>get_functions() : array</pre> <pre>get_functions() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -223,7 +236,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_procedures"></a><div class="element clickable method public method_get_procedures" data-toggle="collapse" data-target=".method_get_procedures .collapse"> <a id="method_get_procedures"></a><div class="element clickable method public method_get_procedures" data-toggle="collapse" data-target=".method_get_procedures .collapse" title="public">
<h2>Return list of stored procedures for the current database</h2> <h2>Return list of stored procedures for the current database</h2>
<pre>get_procedures() : array</pre> <pre>get_procedures() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -233,7 +246,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_schemas"></a><div class="element clickable method public method_get_schemas" data-toggle="collapse" data-target=".method_get_schemas .collapse"> <a id="method_get_schemas"></a><div class="element clickable method public method_get_schemas" data-toggle="collapse" data-target=".method_get_schemas .collapse" title="public">
<h2>Return schemas for databases that list them</h2> <h2>Return schemas for databases that list them</h2>
<pre>get_schemas() : array</pre> <pre>get_schemas() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -243,7 +256,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_sequences"></a><div class="element clickable method public method_get_sequences" data-toggle="collapse" data-target=".method_get_sequences .collapse"> <a id="method_get_sequences"></a><div class="element clickable method public method_get_sequences" data-toggle="collapse" data-target=".method_get_sequences .collapse" title="public">
<h2>Return list of sequences for the current database, if they exist</h2> <h2>Return list of sequences for the current database, if they exist</h2>
<pre>get_sequences() : array</pre> <pre>get_sequences() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -253,7 +266,7 @@ the connection/database</span><pre>get_system_tables()</pre></a></li>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_system_tables"></a><div class="element clickable method public method_get_system_tables" data-toggle="collapse" data-target=".method_get_system_tables .collapse"> <a id="method_get_system_tables"></a><div class="element clickable method public method_get_system_tables" data-toggle="collapse" data-target=".method_get_system_tables .collapse" title="public">
<h2>Retreives an array of non-user-created tables for <h2>Retreives an array of non-user-created tables for
the connection/database</h2> the connection/database</h2>
<pre>get_system_tables() : array</pre> <pre>get_system_tables() : array</pre>
@ -264,7 +277,7 @@ the connection/database</h2>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_tables"></a><div class="element clickable method public method_get_tables" data-toggle="collapse" data-target=".method_get_tables .collapse"> <a id="method_get_tables"></a><div class="element clickable method public method_get_tables" data-toggle="collapse" data-target=".method_get_tables .collapse" title="public">
<h2>Return list of tables for the current database</h2> <h2>Return list of tables for the current database</h2>
<pre>get_tables() : array</pre> <pre>get_tables() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -274,7 +287,7 @@ the connection/database</h2>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_triggers"></a><div class="element clickable method public method_get_triggers" data-toggle="collapse" data-target=".method_get_triggers .collapse"> <a id="method_get_triggers"></a><div class="element clickable method public method_get_triggers" data-toggle="collapse" data-target=".method_get_triggers .collapse" title="public">
<h2>Return list of triggers for the current database</h2> <h2>Return list of triggers for the current database</h2>
<pre>get_triggers() : array</pre> <pre>get_triggers() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -284,7 +297,7 @@ the connection/database</h2>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_types"></a><div class="element clickable method public method_get_types" data-toggle="collapse" data-target=".method_get_types .collapse"> <a id="method_get_types"></a><div class="element clickable method public method_get_types" data-toggle="collapse" data-target=".method_get_types .collapse" title="public">
<h2>Retrieve list of data types for the database</h2> <h2>Retrieve list of data types for the database</h2>
<pre>get_types() : array</pre> <pre>get_types() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -294,7 +307,7 @@ the connection/database</h2>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_views"></a><div class="element clickable method public method_get_views" data-toggle="collapse" data-target=".method_get_views .collapse"> <a id="method_get_views"></a><div class="element clickable method public method_get_views" data-toggle="collapse" data-target=".method_get_views .collapse" title="public">
<h2>Return list of views for the current database</h2> <h2>Return list of views for the current database</h2>
<pre>get_views() : array</pre> <pre>get_views() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -304,9 +317,9 @@ the connection/database</h2>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </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"> <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> <h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : string</pre> <pre>insert_batch(string $table, array $data<code> = array()</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -323,7 +336,7 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_num_rows"></a><div class="element clickable method public method_num_rows" data-toggle="collapse" data-target=".method_num_rows .collapse"> <a id="method_num_rows"></a><div class="element clickable method public method_num_rows" data-toggle="collapse" data-target=".method_num_rows .collapse" title="public">
<h2>Return the number of rows returned for a SELECT query</h2> <h2>Return the number of rows returned for a SELECT query</h2>
<pre>num_rows() : int</pre> <pre>num_rows() : int</pre>
<div class="labels"></div> <div class="labels"></div>
@ -337,7 +350,7 @@ the connection/database</h2>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_prepare_execute"></a><div class="element clickable method public method_prepare_execute" data-toggle="collapse" data-target=".method_prepare_execute .collapse"> <a id="method_prepare_execute"></a><div class="element clickable method public method_prepare_execute" data-toggle="collapse" data-target=".method_prepare_execute .collapse" title="public">
<h2>Create and execute a prepared statement with the provided parameters</h2> <h2>Create and execute a prepared statement with the provided parameters</h2>
<pre>prepare_execute(string $sql, array $params) : <a href="PDOStatement.html">\PDOStatement</a></pre> <pre>prepare_execute(string $sql, array $params) : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="labels"></div> <div class="labels"></div>
@ -356,7 +369,7 @@ the connection/database</h2>
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div> <div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
</div></div> </div></div>
</div> </div>
<a id="method_prepare_query"></a><div class="element clickable method public method_prepare_query" data-toggle="collapse" data-target=".method_prepare_query .collapse"> <a id="method_prepare_query"></a><div class="element clickable method public method_prepare_query" data-toggle="collapse" data-target=".method_prepare_query .collapse" title="public">
<h2>Simplifies prepared statements for database queries</h2> <h2>Simplifies prepared statements for database queries</h2>
<pre>prepare_query(string $sql, array $data) : mixed</pre> <pre>prepare_query(string $sql, array $data) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
@ -381,7 +394,7 @@ the connection/database</h2>
<code>mixed</code>PDOStatement / FALSE</div> <code>mixed</code>PDOStatement / FALSE</div>
</div></div> </div></div>
</div> </div>
<a id="method_quote_ident"></a><div class="element clickable method public method_quote_ident" data-toggle="collapse" data-target=".method_quote_ident .collapse"> <a id="method_quote_ident"></a><div class="element clickable method public method_quote_ident" data-toggle="collapse" data-target=".method_quote_ident .collapse" title="public">
<h2>Surrounds the string with the databases identifier escape characters</h2> <h2>Surrounds the string with the databases identifier escape characters</h2>
<pre>quote_ident(mixed $ident) : string</pre> <pre>quote_ident(mixed $ident) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -396,7 +409,7 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_quote_table"></a><div class="element clickable method public method_quote_table" data-toggle="collapse" data-target=".method_quote_table .collapse"> <a id="method_quote_table"></a><div class="element clickable method public method_quote_table" data-toggle="collapse" data-target=".method_quote_table .collapse" title="public">
<h2>Quote database table name, and set prefix</h2> <h2>Quote database table name, and set prefix</h2>
<pre>quote_table(string $table) : string</pre> <pre>quote_table(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -411,7 +424,7 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse" title="public">
<h2>Empty the passed table</h2> <h2>Empty the passed table</h2>
<pre>truncate(string $table) : void</pre> <pre>truncate(string $table) : void</pre>
<div class="labels"></div> <div class="labels"></div>
@ -424,7 +437,7 @@ the connection/database</h2>
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="method__prefix"></a><div class="element clickable method protected method__prefix" data-toggle="collapse" data-target=".method__prefix .collapse"> <a id="method__prefix"></a><div class="element clickable method protected method__prefix" data-toggle="collapse" data-target=".method__prefix .collapse" title="protected">
<h2>Sets the table prefix on the passed string</h2> <h2>Sets the table prefix on the passed string</h2>
<pre>_prefix(string $str) : string</pre> <pre>_prefix(string $str) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -439,56 +452,65 @@ the connection/database</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method__quote"></a><div class="element clickable method protected method__quote" data-toggle="collapse" data-target=".method__quote .collapse">
<h2>Helper method for quote_ident</h2>
<pre>_quote(mixed $str) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$str</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_last_query"> </a><div class="element clickable property public property_last_query" data-toggle="collapse" data-target=".property_last_query .collapse"> <a id="property_last_query"> </a><div class="element clickable property public property_last_query" data-toggle="collapse" data-target=".property_last_query .collapse" title="public">
<h2>$last_query</h2> <h2>$last_query</h2>
<pre>$last_query </pre> <pre>$last_query </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_sql"> </a><div class="element clickable property public property_sql" data-toggle="collapse" data-target=".property_sql .collapse"> <a id="property_sql"> </a><div class="element clickable property public property_sql" data-toggle="collapse" data-target=".property_sql .collapse" title="public">
<h2>$sql</h2> <h2>$sql</h2>
<pre>$sql </pre> <pre>$sql </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_table_prefix"> </a><div class="element clickable property public property_table_prefix" data-toggle="collapse" data-target=".property_table_prefix .collapse"> <a id="property_table_prefix"> </a><div class="element clickable property public property_table_prefix" data-toggle="collapse" data-target=".property_table_prefix .collapse" title="public">
<h2>$table_prefix</h2> <h2>$table_prefix</h2>
<pre>$table_prefix </pre> <pre>$table_prefix </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>''</code></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_util"> </a><div class="element clickable property public property_util" data-toggle="collapse" data-target=".property_util .collapse"> <a id="property_util"> </a><div class="element clickable property public property_util" data-toggle="collapse" data-target=".property_util .collapse" title="public">
<h2>$util</h2> <h2>$util</h2>
<pre>$util </pre> <pre>$util </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse"> <a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse" title="protected">
<h2>$escape_char</h2> <h2>$escape_char</h2>
<pre>$escape_char </pre> <pre>$escape_char </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>'"'</code></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse"> <a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse" title="protected">
<h2>$statement</h2> <h2>$statement</h2>
<pre>$statement </pre> <pre>$statement </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -498,9 +520,9 @@ the connection/database</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

41
docs/classes/DB_Util.html
View File

@ -49,12 +49,17 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___call" title="__call() :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li> <li class="method public "><a href="#method___call" title="__call() :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
<li class="method public "><a href="#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___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>
@ -65,7 +70,7 @@
</ul> </ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul> <ul></ul>
</li> </li>
<li class="nav-header private">» Private <li class="nav-header private">» Private
@ -76,7 +81,7 @@
<div class="span8"> <div class="span8">
<a id="\DB_Util"></a><ul class="breadcrumb"> <a id="\DB_Util"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/DB_Util.html">DB_Util</a> <span class="divider">\</span><a href="../classes/DB_Util.html">DB_Util</a>
@ -97,8 +102,8 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method___call"></a><div class="element clickable method public method___call" data-toggle="collapse" data-target=".method___call .collapse"> <a id="method___call"></a><div class="element clickable method public method___call" data-toggle="collapse" data-target=".method___call .collapse" title="public">
<h2>Enable calling driver methods</h2> <h2>Enable calling driver methods</h2>
<pre>__call(string $method, array $args) : mixed</pre> <pre>__call(string $method, array $args) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
@ -117,7 +122,7 @@
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Save a reference to the connection object for later use</h2> <h2>Save a reference to the connection object for later use</h2>
<pre>__construct(object $conn) </pre> <pre>__construct(object $conn) </pre>
<div class="labels"></div> <div class="labels"></div>
@ -130,7 +135,7 @@
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse" title="public">
<h2>Return an SQL file with the database data as insert statements</h2> <h2>Return an SQL file with the database data as insert statements</h2>
<pre>backup_data() : string</pre> <pre>backup_data() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -144,7 +149,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse" title="public">
<h2>Return an SQL file with the database table structure</h2> <h2>Return an SQL file with the database table structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -158,9 +163,9 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Get database-specific sql to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <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="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -189,7 +194,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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>Get database-specific sql to drop a table</h2> <h2>Get database-specific sql to drop a table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -209,10 +214,14 @@
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_conn"> </a><div class="element clickable property private property_conn" data-toggle="collapse" data-target=".property_conn .collapse"> <a id="property_conn"> </a><div class="element clickable property private property_conn" data-toggle="collapse" data-target=".property_conn .collapse" title="private">
<h2>Reference to the current connection object</h2> <h2>Reference to the current connection object</h2>
<pre>$conn </pre> <pre>$conn </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -222,9 +231,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

83
docs/classes/Firebird.html
View File

@ -49,12 +49,17 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Open the link to the database"><span class="description">Open the link to the database</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Open the link to the database"><span class="description">Open the link to the database</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_beginTransaction" title="beginTransaction() :: Start a database transaction"><span class="description">Start a database transaction</span><pre>beginTransaction()</pre></a></li> <li class="method public "><a href="#method_beginTransaction" title="beginTransaction() :: Start a database transaction"><span class="description">Start a database transaction</span><pre>beginTransaction()</pre></a></li>
@ -72,7 +77,7 @@
</ul> </ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul> <ul></ul>
</li> </li>
<li class="nav-header protected">» Protected <li class="nav-header protected">» Protected
@ -89,7 +94,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="span8"> <div class="span8">
<a id="\Firebird"></a><ul class="breadcrumb"> <a id="\Firebird"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/Firebird.html">Firebird</a> <span class="divider">\</span><a href="../classes/Firebird.html">Firebird</a>
@ -110,10 +115,10 @@ the last query executed"><span class="description"></span><pre>$statement_link</
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Open the link to the database</h2> <h2>Open the link to the database</h2>
<pre>__construct(string $dbpath, string $user, string $pass) </pre> <pre>__construct(string $dbpath, string $user<code> = 'SYSDBA'</code>, string $pass<code> = 'masterkey'</code>, array $options<code> = array()</code>) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -130,9 +135,13 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<h4>$pass</h4> <h4>$pass</h4>
<code>string</code> <code>string</code>
</div> </div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code>
</div>
</div></div> </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"> <a id="method_beginTransaction"></a><div class="element clickable method public method_beginTransaction" data-toggle="collapse" data-target=".method_beginTransaction .collapse" title="public">
<h2>Start a database transaction</h2> <h2>Start a database transaction</h2>
<pre>beginTransaction() : bool</pre> <pre>beginTransaction() : bool</pre>
<div class="labels"></div> <div class="labels"></div>
@ -142,7 +151,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>bool</code></div> <div class="subelement response"><code>bool</code></div>
</div></div> </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"> <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 database transaction</h2> <h2>Commit a database transaction</h2>
<pre>commit() : bool</pre> <pre>commit() : bool</pre>
<div class="labels"></div> <div class="labels"></div>
@ -152,7 +161,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>bool</code></div> <div class="subelement response"><code>bool</code></div>
</div></div> </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"> <a id="method_errorCode"></a><div class="element clickable method public method_errorCode" data-toggle="collapse" data-target=".method_errorCode .collapse" title="public">
<h2>Method to emulate PDO-&gt;errorCode</h2> <h2>Method to emulate PDO-&gt;errorCode</h2>
<pre>errorCode() : array</pre> <pre>errorCode() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -162,7 +171,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </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"> <a id="method_errorInfo"></a><div class="element clickable method public method_errorInfo" data-toggle="collapse" data-target=".method_errorInfo .collapse" title="public">
<h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2> <h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2>
<pre>errorInfo() : array</pre> <pre>errorInfo() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -172,9 +181,9 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </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"> <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> <h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : string</pre> <pre>insert_batch(string $table, array $data<code> = array()</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -191,9 +200,9 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_prepare"></a><div class="element clickable method public method_prepare" data-toggle="collapse" data-target=".method_prepare .collapse"> <a id="method_prepare"></a><div class="element clickable method public method_prepare" data-toggle="collapse" data-target=".method_prepare .collapse" title="public">
<h2>Emulate PDO prepare</h2> <h2>Emulate PDO prepare</h2>
<pre>prepare(string $query, array $options) : \Firebird</pre> <pre>prepare(string $query, array $options<code> = NULL</code>) : \Firebird</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -219,7 +228,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>\Firebird</code></div> <div class="subelement response"><code>\Firebird</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_prepare_execute"></a><div class="element clickable method public method_prepare_execute" data-toggle="collapse" data-target=".method_prepare_execute .collapse"> <a id="method_prepare_execute"></a><div class="element clickable method public method_prepare_execute" data-toggle="collapse" data-target=".method_prepare_execute .collapse" title="public">
<h2>Prepare and execute a query</h2> <h2>Prepare and execute a query</h2>
<pre>prepare_execute(string $sql, array $args) : resource</pre> <pre>prepare_execute(string $sql, array $args) : resource</pre>
<div class="labels"></div> <div class="labels"></div>
@ -238,7 +247,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>resource</code></div> <div class="subelement response"><code>resource</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_prepare_query"></a><div class="element clickable method public method_prepare_query" data-toggle="collapse" data-target=".method_prepare_query .collapse"> <a id="method_prepare_query"></a><div class="element clickable method public method_prepare_query" data-toggle="collapse" data-target=".method_prepare_query .collapse" title="public">
<h2>Bind a prepared query with arguments for executing</h2> <h2>Bind a prepared query with arguments for executing</h2>
<pre>prepare_query(string $sql, array $params) : NULL</pre> <pre>prepare_query(string $sql, array $params) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -257,7 +266,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_query"></a><div class="element clickable method public method_query" data-toggle="collapse" data-target=".method_query .collapse"> <a id="method_query"></a><div class="element clickable method public method_query" data-toggle="collapse" data-target=".method_query .collapse" title="public">
<h2>Wrapper public function to better match PDO</h2> <h2>Wrapper public function to better match PDO</h2>
<pre>query(string $sql) : \Firebird</pre> <pre>query(string $sql) : \Firebird</pre>
<div class="labels"></div> <div class="labels"></div>
@ -281,9 +290,9 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>\Firebird</code></div> <div class="subelement response"><code>\Firebird</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_quote"></a><div class="element clickable method public method_quote" data-toggle="collapse" data-target=".method_quote .collapse"> <a id="method_quote"></a><div class="element clickable method public method_quote" data-toggle="collapse" data-target=".method_quote .collapse" title="public">
<h2>Method to emulate PDO-&gt;quote</h2> <h2>Method to emulate PDO-&gt;quote</h2>
<pre>quote(string $str, int $param_type) : string</pre> <pre>quote(string $str, int $param_type<code> = NULL</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -300,7 +309,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Rollback a transaction</h2>
<pre>rollBack() : bool</pre> <pre>rollBack() : bool</pre>
<div class="labels"></div> <div class="labels"></div>
@ -310,7 +319,7 @@ the last query executed"><span class="description"></span><pre>$statement_link</
<div class="subelement response"><code>bool</code></div> <div class="subelement response"><code>bool</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse" title="public">
<h2>Empty a database table</h2> <h2>Empty a database table</h2>
<pre>truncate(string $table) </pre> <pre>truncate(string $table) </pre>
<div class="labels"></div> <div class="labels"></div>
@ -324,29 +333,45 @@ the last query executed"><span class="description"></span><pre>$statement_link</
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_conn"> </a><div class="element clickable property protected property_conn" data-toggle="collapse" data-target=".property_conn .collapse"> <a id="property_conn"> </a><div class="element clickable property protected property_conn" data-toggle="collapse" data-target=".property_conn .collapse" title="protected">
<h2>Reference to the connection resource</h2> <h2>Reference to the connection resource</h2>
<pre>$conn : resource</pre> <pre>$conn : resource</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse"> <a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse" title="protected">
<h2>Reference to the last query executed</h2> <h2>Reference to the last query executed</h2>
<pre>$statement : object</pre> <pre>$statement : object</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_statement_link"> </a><div class="element clickable property protected property_statement_link" data-toggle="collapse" data-target=".property_statement_link .collapse"> <a id="property_statement_link"> </a><div class="element clickable property protected property_statement_link" data-toggle="collapse" data-target=".property_statement_link .collapse" title="protected">
<h2>Reference to the resource returned by <h2>Reference to the resource returned by
the last query executed</h2> the last query executed</h2>
<pre>$statement_link : resource</pre> <pre>$statement_link : resource</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_trans"> </a><div class="element clickable property protected property_trans" data-toggle="collapse" data-target=".property_trans .collapse"> <a id="property_trans"> </a><div class="element clickable property protected property_trans" data-toggle="collapse" data-target=".property_trans .collapse" title="protected">
<h2>Reference to the current transaction</h2> <h2>Reference to the current transaction</h2>
<pre>$trans : resource</pre> <pre>$trans : resource</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -356,9 +381,9 @@ the last query executed</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

104
docs/classes/Firebird_Result.html
View File

@ -49,12 +49,17 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Create the object by passing the resource for <li class="method public "><a href="#method___construct" title="__construct() :: Create the object by passing the resource for
the query"><span class="description">Create the object by passing the resource for the query"><span class="description">Create the object by passing the resource for
@ -73,7 +78,7 @@ the query</span><pre>__construct()</pre></a></li>
</ul> </ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul> <ul></ul>
</li> </li>
<li class="nav-header private">» Private <li class="nav-header private">» Private
@ -88,7 +93,7 @@ the query</span><pre>__construct()</pre></a></li>
<div class="span8"> <div class="span8">
<a id="\Firebird_Result"></a><ul class="breadcrumb"> <a id="\Firebird_Result"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/Firebird_Result.html">Firebird_Result</a> <span class="divider">\</span><a href="../classes/Firebird_Result.html">Firebird_Result</a>
@ -110,8 +115,8 @@ data-fetching methods</p>
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Create the object by passing the resource for <h2>Create the object by passing the resource for
the query</h2> the query</h2>
<pre>__construct(resource $link) </pre> <pre>__construct(resource $link) </pre>
@ -125,9 +130,9 @@ the query</h2>
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="method_bindColumn"></a><div class="element clickable method public method_bindColumn" data-toggle="collapse" data-target=".method_bindColumn .collapse"> <a id="method_bindColumn"></a><div class="element clickable method public method_bindColumn" data-toggle="collapse" data-target=".method_bindColumn .collapse" title="public">
<h2>Invalidate method for data consistency</h2> <h2>Invalidate method for data consistency</h2>
<pre>bindColumn(mixed $column, $param, int $type, mixed $maxlen, array $driverdata) : NULL</pre> <pre>bindColumn(mixed $column, mixed $param, int $type<code> = NULL</code>, mixed $maxlen<code> = NULL</code>, array $driverdata<code> = NULL</code>) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -136,7 +141,10 @@ the query</h2>
<h4>$column</h4> <h4>$column</h4>
<code>mixed</code> <code>mixed</code>
</div> </div>
<div class="subelement argument"><h4>$param</h4></div> <div class="subelement argument">
<h4>$param</h4>
<code>mixed</code>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$type</h4> <h4>$type</h4>
<code>int</code> <code>int</code>
@ -153,9 +161,9 @@ the query</h2>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_bindParam"></a><div class="element clickable method public method_bindParam" data-toggle="collapse" data-target=".method_bindParam .collapse"> <a id="method_bindParam"></a><div class="element clickable method public method_bindParam" data-toggle="collapse" data-target=".method_bindParam .collapse" title="public">
<h2>Invalidate method for data consistency</h2> <h2>Invalidate method for data consistency</h2>
<pre>bindParam(mixed $parameter, $variable, int $data_type, mixed $maxlen, array $driverdata) : NULL</pre> <pre>bindParam(mixed $parameter, mixed $variable, int $data_type<code> = NULL</code>, mixed $maxlen<code> = NULL</code>, array $driverdata<code> = NULL</code>) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -164,7 +172,10 @@ the query</h2>
<h4>$parameter</h4> <h4>$parameter</h4>
<code>mixed</code> <code>mixed</code>
</div> </div>
<div class="subelement argument"><h4>$variable</h4></div> <div class="subelement argument">
<h4>$variable</h4>
<code>mixed</code>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$data_type</h4> <h4>$data_type</h4>
<code>int</code> <code>int</code>
@ -181,9 +192,9 @@ the query</h2>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_bindValue"></a><div class="element clickable method public method_bindValue" data-toggle="collapse" data-target=".method_bindValue .collapse"> <a id="method_bindValue"></a><div class="element clickable method public method_bindValue" data-toggle="collapse" data-target=".method_bindValue .collapse" title="public">
<h2>Invalidate method for data consistency</h2> <h2>Invalidate method for data consistency</h2>
<pre>bindValue(mixed $parameter, $variable, int $data_type) : NULL</pre> <pre>bindValue(mixed $parameter, mixed $variable, int $data_type<code> = NULL</code>) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -192,7 +203,10 @@ the query</h2>
<h4>$parameter</h4> <h4>$parameter</h4>
<code>mixed</code> <code>mixed</code>
</div> </div>
<div class="subelement argument"><h4>$variable</h4></div> <div class="subelement argument">
<h4>$variable</h4>
<code>mixed</code>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$data_type</h4> <h4>$data_type</h4>
<code>int</code> <code>int</code>
@ -201,7 +215,7 @@ the query</h2>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_errorCode"></a><div class="element clickable method public method_errorCode" data-toggle="collapse" data-target=".method_errorCode .collapse" title="public">
<h2>Method to emulate PDOStatement-&gt;errorCode</h2> <h2>Method to emulate PDOStatement-&gt;errorCode</h2>
<pre>errorCode() : string</pre> <pre>errorCode() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -211,7 +225,7 @@ the query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_errorInfo"></a><div class="element clickable method public method_errorInfo" data-toggle="collapse" data-target=".method_errorInfo .collapse" title="public">
<h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2> <h2>Method to emulate PDO-&gt;errorInfo / PDOStatement-&gt;errorInfo</h2>
<pre>errorInfo() : array</pre> <pre>errorInfo() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -221,9 +235,9 @@ the query</h2>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_execute"></a><div class="element clickable method public method_execute" data-toggle="collapse" data-target=".method_execute .collapse"> <a id="method_execute"></a><div class="element clickable method public method_execute" data-toggle="collapse" data-target=".method_execute .collapse" title="public">
<h2>Run a prepared statement query</h2> <h2>Run a prepared statement query</h2>
<pre>execute(array $args) : bool</pre> <pre>execute(array $args<code> = NULL</code>) : bool</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -236,9 +250,9 @@ the query</h2>
<div class="subelement response"><code>bool</code></div> <div class="subelement response"><code>bool</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_fetch"></a><div class="element clickable method public method_fetch" data-toggle="collapse" data-target=".method_fetch .collapse"> <a id="method_fetch"></a><div class="element clickable method public method_fetch" data-toggle="collapse" data-target=".method_fetch .collapse" title="public">
<h2>Emulate PDO fetch public function</h2> <h2>Emulate PDO fetch public function</h2>
<pre>fetch(int $fetch_style, $cursor_orientation, $cursor_offset) : mixed</pre> <pre>fetch(int $fetch_style<code> = \PDO::FETCH_ASSOC</code>, mixed $cursor_orientation<code> = \PDO::FETCH_ORI_NEXT</code>, mixed $cursor_offset<code> = NULL</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -247,15 +261,21 @@ the query</h2>
<h4>$fetch_style</h4> <h4>$fetch_style</h4>
<code>int</code> <code>int</code>
</div> </div>
<div class="subelement argument"><h4>$cursor_orientation</h4></div> <div class="subelement argument">
<div class="subelement argument"><h4>$cursor_offset</h4></div> <h4>$cursor_orientation</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$cursor_offset</h4>
<code>mixed</code>
</div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_fetchAll"></a><div class="element clickable method public method_fetchAll" data-toggle="collapse" data-target=".method_fetchAll .collapse"> <a id="method_fetchAll"></a><div class="element clickable method public method_fetchAll" data-toggle="collapse" data-target=".method_fetchAll .collapse" title="public">
<h2>Emulate PDO fetchAll public function</h2> <h2>Emulate PDO fetchAll public function</h2>
<pre>fetchAll(int $fetch_style, mixed $statement, mixed $ctor_args) : mixed</pre> <pre>fetchAll(int $fetch_style<code> = \PDO::FETCH_ASSOC</code>, mixed $statement<code> = NULL</code>, mixed $ctor_args<code> = NULL</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -276,9 +296,9 @@ the query</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_fetchColumn"></a><div class="element clickable method public method_fetchColumn" data-toggle="collapse" data-target=".method_fetchColumn .collapse"> <a id="method_fetchColumn"></a><div class="element clickable method public method_fetchColumn" data-toggle="collapse" data-target=".method_fetchColumn .collapse" title="public">
<h2>Emulate PDOStatement::fetchColumn</h2> <h2>Emulate PDOStatement::fetchColumn</h2>
<pre>fetchColumn(int $column_num) : mixed</pre> <pre>fetchColumn(int $column_num<code> = 0</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -291,9 +311,9 @@ the query</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_fetchObject"></a><div class="element clickable method public method_fetchObject" data-toggle="collapse" data-target=".method_fetchObject .collapse"> <a id="method_fetchObject"></a><div class="element clickable method public method_fetchObject" data-toggle="collapse" data-target=".method_fetchObject .collapse" title="public">
<h2>Emulate PDOStatement::fetchObject, but only for the default use</h2> <h2>Emulate PDOStatement::fetchObject, but only for the default use</h2>
<pre>fetchObject(string $class_name, array $ctor_args) : <a href="stdClass.html">\stdClass</a></pre> <pre>fetchObject(string $class_name<code> = 'stdClass'</code>, array $ctor_args<code> = array()</code>) : <a href="stdClass.html">\stdClass</a></pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -310,7 +330,7 @@ the query</h2>
<div class="subelement response"><code><a href="stdClass.html">\stdClass</a></code></div> <div class="subelement response"><code><a href="stdClass.html">\stdClass</a></code></div>
</div></div> </div></div>
</div> </div>
<a id="method_rowCount"></a><div class="element clickable method public method_rowCount" data-toggle="collapse" data-target=".method_rowCount .collapse"> <a id="method_rowCount"></a><div class="element clickable method public method_rowCount" data-toggle="collapse" data-target=".method_rowCount .collapse" title="public">
<h2>Return the number of rows affected by the previous query</h2> <h2>Return the number of rows affected by the previous query</h2>
<pre>rowCount() : int</pre> <pre>rowCount() : int</pre>
<div class="labels"></div> <div class="labels"></div>
@ -321,10 +341,14 @@ the query</h2>
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_result"> </a><div class="element clickable property private property_result" data-toggle="collapse" data-target=".property_result .collapse"> <a id="property_result"> </a><div class="element clickable property private property_result" data-toggle="collapse" data-target=".property_result .collapse" title="private">
<h2>Data pulled from query</h2> <h2>Data pulled from query</h2>
<pre>$result </pre> <pre>$result </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="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -334,15 +358,23 @@ the query</h2>
</tr></table> </tr></table>
</div></div> </div></div>
</div> </div>
<a id="property_row"> </a><div class="element clickable property private property_row" data-toggle="collapse" data-target=".property_row .collapse"> <a id="property_row"> </a><div class="element clickable property private property_row" data-toggle="collapse" data-target=".property_row .collapse" title="private">
<h2>Current row in result array</h2> <h2>Current row in result array</h2>
<pre>$row : int</pre> <pre>$row : int</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_statement"> </a><div class="element clickable property private property_statement" data-toggle="collapse" data-target=".property_statement .collapse"> <a id="property_statement"> </a><div class="element clickable property private property_statement" data-toggle="collapse" data-target=".property_statement .collapse" title="private">
<h2>Reference to fbird resource</h2> <h2>Reference to fbird resource</h2>
<pre>$statement : resource</pre> <pre>$statement : resource</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -352,9 +384,9 @@ the query</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

45
docs/classes/Firebird_SQL.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method_column_list" title="column_list() :: Return sql to list columns of the specified table"><span class="description">Return sql to list columns of the specified table</span><pre>column_list()</pre></a></li> <li class="method public "><a href="#method_column_list" title="column_list() :: Return sql to list columns of the specified table"><span class="description">Return sql to list columns of 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_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>
@ -74,7 +79,7 @@
<div class="span8"> <div class="span8">
<a id="\Firebird_SQL"></a><ul class="breadcrumb"> <a id="\Firebird_SQL"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/Firebird_SQL.html">Firebird_SQL</a> <span class="divider">\</span><a href="../classes/Firebird_SQL.html">Firebird_SQL</a>
@ -95,8 +100,8 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <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>Return sql to list columns of the specified table</h2> <h2>Return sql to list columns of the specified table</h2>
<pre>column_list(string $table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -111,7 +116,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list other databases</h2>
<pre>db_list() : NULL</pre> <pre>db_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -121,7 +126,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
<h2>Get the query plan for the sql query</h2> <h2>Get the query plan for the sql query</h2>
<pre>explain(string $sql) : string</pre> <pre>explain(string $sql) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -136,7 +141,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list functions</h2>
<pre>function_list() : string</pre> <pre>function_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -146,9 +151,9 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -169,7 +174,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre> <pre>procedure_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -179,7 +184,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse" title="public">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -189,7 +194,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : string</pre> <pre>sequence_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -199,7 +204,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -209,7 +214,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre> <pre>table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -219,7 +224,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre> <pre>trigger_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -229,7 +234,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : string</pre> <pre>type_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -239,7 +244,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -255,9 +260,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

38
docs/classes/Firebird_Util.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<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_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>
@ -66,7 +71,7 @@
<div class="span8"> <div class="span8">
<a id="\Firebird_Util"></a><ul class="breadcrumb"> <a id="\Firebird_Util"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/Firebird_Util.html">Firebird_Util</a> <span class="divider">\</span><a href="../classes/Firebird_Util.html">Firebird_Util</a>
@ -87,20 +92,23 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct($conn) : void</pre> <pre>__construct(object $conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$conn</h4></div> <div class="subelement argument">
<h4>$conn</h4>
<code>object</code>
</div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse" title="public">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $exclude, bool $system_tables) : string</pre> <pre>backup_data(array $exclude<code> = array()</code>, bool $system_tables<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -117,7 +125,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse" title="public">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -127,9 +135,9 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Convienience public function to generate sql for creating a db table</h2>
<pre>create_table(string $name, array $fields, array $constraints, array $indexes) : string</pre> <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="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -154,7 +162,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Drop the selected table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -175,9 +183,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

33
docs/classes/MySQL.html
View File

@ -49,19 +49,24 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Connect to MySQL Database"><span class="description">Connect to MySQL Database</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Connect to MySQL Database"><span class="description">Connect to MySQL Database</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_truncate" title="truncate() :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li> <li class="method public "><a href="#method_truncate" title="truncate() :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
</ul> </ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul> <ul></ul>
</li> </li>
<li class="nav-header protected">» Protected <li class="nav-header protected">» Protected
@ -72,7 +77,7 @@
<div class="span8"> <div class="span8">
<a id="\MySQL"></a><ul class="breadcrumb"> <a id="\MySQL"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/MySQL.html">MySQL</a> <span class="divider">\</span><a href="../classes/MySQL.html">MySQL</a>
@ -93,10 +98,10 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Connect to MySQL Database</h2> <h2>Connect to MySQL Database</h2>
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre> <pre>__construct(string $dsn, string $username<code> = null</code>, string $password<code> = null</code>, array $options<code> = array()</code>) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -119,7 +124,7 @@
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse" title="public">
<h2>Empty a table</h2> <h2>Empty a table</h2>
<pre>truncate(string $table) </pre> <pre>truncate(string $table) </pre>
<div class="labels"></div> <div class="labels"></div>
@ -133,10 +138,14 @@
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse"> <a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse" title="protected">
<h2>Set the backtick as the MySQL escape character</h2> <h2>Set the backtick as the MySQL escape character</h2>
<pre>$escape_char : string</pre> <pre>$escape_char : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>'`'</code></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -146,9 +155,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

47
docs/classes/MySQL_SQL.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method_column_list" title="column_list() :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a table</span><pre>column_list()</pre></a></li> <li class="method public "><a href="#method_column_list" title="column_list() :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a 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_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>
@ -74,7 +79,7 @@
<div class="span8"> <div class="span8">
<a id="\MySQL_SQL"></a><ul class="breadcrumb"> <a id="\MySQL_SQL"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/MySQL_SQL.html">MySQL_SQL</a> <span class="divider">\</span><a href="../classes/MySQL_SQL.html">MySQL_SQL</a>
@ -95,8 +100,8 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <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>SQL to show infromation about columns in a table</h2> <h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -111,7 +116,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list other databases</h2>
<pre>db_list() : string</pre> <pre>db_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -121,7 +126,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
<h2>Get the query plan for the sql query</h2> <h2>Get the query plan for the sql query</h2>
<pre>explain(string $sql) : string</pre> <pre>explain(string $sql) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -136,7 +141,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list functions</h2>
<pre>function_list() : string</pre> <pre>function_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -146,9 +151,9 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -169,7 +174,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre> <pre>procedure_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -179,7 +184,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse" title="public">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -189,7 +194,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : NULL</pre> <pre>sequence_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -199,7 +204,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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>Overridden in MySQL class</h2> <h2>Overridden in MySQL class</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -209,9 +214,9 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list tables</h2>
<pre>table_list(string $database) : string</pre> <pre>table_list(string $database<code> = ''</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -224,7 +229,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre> <pre>trigger_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -234,7 +239,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : string</pre> <pre>type_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -244,7 +249,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -260,9 +265,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

38
docs/classes/MySQL_Util.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<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_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>
@ -66,7 +71,7 @@
<div class="span8"> <div class="span8">
<a id="\MySQL_Util"></a><ul class="breadcrumb"> <a id="\MySQL_Util"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/MySQL_Util.html">MySQL_Util</a> <span class="divider">\</span><a href="../classes/MySQL_Util.html">MySQL_Util</a>
@ -87,20 +92,23 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct($conn) : void</pre> <pre>__construct(object $conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$conn</h4></div> <div class="subelement argument">
<h4>$conn</h4>
<code>object</code>
</div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse" title="public">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $exclude) : string</pre> <pre>backup_data(array $exclude<code> = array()</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -113,7 +121,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse" title="public">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -123,9 +131,9 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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 for creating a new MySQL table</h2> <h2>Convienience public function for creating a new MySQL table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <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="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -150,7 +158,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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>Convience public function for droping a table</h2> <h2>Convience public function for droping a table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -171,9 +179,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

37
docs/classes/ODBC.html
View File

@ -49,12 +49,17 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Use ODBC to connect to a database"><span class="description">Use ODBC to connect to a database</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Use ODBC to connect to a database"><span class="description">Use ODBC to connect to a database</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_insert_batch" title="insert_batch() :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li> <li class="method public "><a href="#method_insert_batch" title="insert_batch() :: Create sql for batch insert"><span class="description">Create sql for batch insert</span><pre>insert_batch()</pre></a></li>
@ -62,7 +67,7 @@
</ul> </ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul> <ul></ul>
</li> </li>
<li class="nav-header protected">» Protected <li class="nav-header protected">» Protected
@ -73,7 +78,7 @@
<div class="span8"> <div class="span8">
<a id="\ODBC"></a><ul class="breadcrumb"> <a id="\ODBC"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/ODBC.html">ODBC</a> <span class="divider">\</span><a href="../classes/ODBC.html">ODBC</a>
@ -94,10 +99,10 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Use ODBC to connect to a database</h2> <h2>Use ODBC to connect to a database</h2>
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre> <pre>__construct(string $dsn, string $username<code> = null</code>, string $password<code> = null</code>, array $options<code> = array()</code>) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -120,9 +125,9 @@
</div> </div>
</div></div> </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"> <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> <h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : string</pre> <pre>insert_batch(string $table, array $data<code> = array()</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -139,7 +144,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse" title="public">
<h2>Empty the current database</h2> <h2>Empty the current database</h2>
<pre>truncate(string $table) : void</pre> <pre>truncate(string $table) : void</pre>
<div class="labels"></div> <div class="labels"></div>
@ -153,10 +158,14 @@
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse"> <a id="property_escape_char"> </a><div class="element clickable property protected property_escape_char" data-toggle="collapse" data-target=".property_escape_char .collapse" title="protected">
<h2>Don't define the escape char - or define it in sub-drivers in a refactor</h2> <h2>Don't define the escape char - or define it in sub-drivers in a refactor</h2>
<pre>$escape_char </pre> <pre>$escape_char </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>''</code></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -166,9 +175,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

45
docs/classes/ODBC_SQL.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method_column_list" title="column_list() :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a table</span><pre>column_list()</pre></a></li> <li class="method public "><a href="#method_column_list" title="column_list() :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a 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_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>
@ -74,7 +79,7 @@
<div class="span8"> <div class="span8">
<a id="\ODBC_SQL"></a><ul class="breadcrumb"> <a id="\ODBC_SQL"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/ODBC_SQL.html">ODBC_SQL</a> <span class="divider">\</span><a href="../classes/ODBC_SQL.html">ODBC_SQL</a>
@ -95,8 +100,8 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <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>SQL to show infromation about columns in a table</h2> <h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : NULL</pre> <pre>column_list(string $table) : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -111,7 +116,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Returns sql to list other databases</h2>
<pre>db_list() : NULL</pre> <pre>db_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -121,7 +126,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
<h2>Get the query plan for the sql query</h2> <h2>Get the query plan for the sql query</h2>
<pre>explain(string $sql) : string</pre> <pre>explain(string $sql) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -136,7 +141,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre> <pre>function_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -146,9 +151,9 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -169,7 +174,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : NULL</pre> <pre>procedure_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -179,7 +184,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse" title="public">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -189,7 +194,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : NULL</pre> <pre>sequence_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -199,7 +204,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Returns sql to list system tables</h2>
<pre>system_table_list() : NULL</pre> <pre>system_table_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -209,7 +214,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Returns sql to list tables</h2>
<pre>table_list() : NULL</pre> <pre>table_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -219,7 +224,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : NULL</pre> <pre>trigger_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -229,7 +234,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : NULL</pre> <pre>type_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -239,7 +244,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Returns sql to list views</h2>
<pre>view_list() : NULL</pre> <pre>view_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -255,9 +260,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

36
docs/classes/ODBC_Util.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<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_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>
@ -66,7 +71,7 @@
<div class="span8"> <div class="span8">
<a id="\ODBC_Util"></a><ul class="breadcrumb"> <a id="\ODBC_Util"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/ODBC_Util.html">ODBC_Util</a> <span class="divider">\</span><a href="../classes/ODBC_Util.html">ODBC_Util</a>
@ -87,18 +92,21 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct($conn) : void</pre> <pre>__construct(object $conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$conn</h4></div> <div class="subelement argument">
<h4>$conn</h4>
<code>object</code>
</div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse" title="public">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data() : string</pre> <pre>backup_data() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -108,7 +116,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse" title="public">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -118,9 +126,9 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Database-specific method to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <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="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -145,7 +153,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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>Remove a table from the database</h2> <h2>Remove a table from the database</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -166,9 +174,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

25
docs/classes/PgSQL.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Connect to a PosgreSQL database"><span class="description">Connect to a PosgreSQL database</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Connect to a PosgreSQL database"><span class="description">Connect to a PosgreSQL database</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_get_schemas" title="get_schemas() :: Get a list of schemas for the current connection"><span class="description">Get a list of schemas for the current connection</span><pre>get_schemas()</pre></a></li> <li class="method public "><a href="#method_get_schemas" title="get_schemas() :: Get a list of schemas for the current connection"><span class="description">Get a list of schemas for the current connection</span><pre>get_schemas()</pre></a></li>
@ -64,7 +69,7 @@
<div class="span8"> <div class="span8">
<a id="\PgSQL"></a><ul class="breadcrumb"> <a id="\PgSQL"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/PgSQL.html">PgSQL</a> <span class="divider">\</span><a href="../classes/PgSQL.html">PgSQL</a>
@ -85,10 +90,10 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Connect to a PosgreSQL database</h2> <h2>Connect to a PosgreSQL database</h2>
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre> <pre>__construct(string $dsn, string $username<code> = null</code>, string $password<code> = null</code>, array $options<code> = array()</code>) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -111,7 +116,7 @@
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="method_get_schemas"></a><div class="element clickable method public method_get_schemas" data-toggle="collapse" data-target=".method_get_schemas .collapse"> <a id="method_get_schemas"></a><div class="element clickable method public method_get_schemas" data-toggle="collapse" data-target=".method_get_schemas .collapse" title="public">
<h2>Get a list of schemas for the current connection</h2> <h2>Get a list of schemas for the current connection</h2>
<pre>get_schemas() : array</pre> <pre>get_schemas() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -121,7 +126,7 @@
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse" title="public">
<h2>Empty a table</h2> <h2>Empty a table</h2>
<pre>truncate(string $table) </pre> <pre>truncate(string $table) </pre>
<div class="labels"></div> <div class="labels"></div>
@ -140,9 +145,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

45
docs/classes/PgSQL_SQL.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method_column_list" title="column_list() :: Return sql to list columns of the specified table"><span class="description">Return sql to list columns of the specified table</span><pre>column_list()</pre></a></li> <li class="method public "><a href="#method_column_list" title="column_list() :: Return sql to list columns of the specified table"><span class="description">Return sql to list columns of 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_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>
@ -74,7 +79,7 @@
<div class="span8"> <div class="span8">
<a id="\PgSQL_SQL"></a><ul class="breadcrumb"> <a id="\PgSQL_SQL"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/PgSQL_SQL.html">PgSQL_SQL</a> <span class="divider">\</span><a href="../classes/PgSQL_SQL.html">PgSQL_SQL</a>
@ -95,8 +100,8 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <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>Return sql to list columns of the specified table</h2> <h2>Return sql to list columns of the specified table</h2>
<pre>column_list(string $table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -111,7 +116,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list other databases</h2>
<pre>db_list() : string</pre> <pre>db_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -121,7 +126,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
<h2>Get the query plan for the sql query</h2> <h2>Get the query plan for the sql query</h2>
<pre>explain(string $sql) : string</pre> <pre>explain(string $sql) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -136,7 +141,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre> <pre>function_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -146,9 +151,9 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -169,7 +174,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre> <pre>procedure_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -179,7 +184,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse" title="public">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -189,7 +194,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : string</pre> <pre>sequence_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -199,7 +204,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -209,7 +214,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre> <pre>table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -219,7 +224,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre> <pre>trigger_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -229,7 +234,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : string</pre> <pre>type_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -239,7 +244,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -255,9 +260,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

38
docs/classes/PgSQL_Util.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<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_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>
@ -66,7 +71,7 @@
<div class="span8"> <div class="span8">
<a id="\PgSQL_Util"></a><ul class="breadcrumb"> <a id="\PgSQL_Util"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/PgSQL_Util.html">PgSQL_Util</a> <span class="divider">\</span><a href="../classes/PgSQL_Util.html">PgSQL_Util</a>
@ -87,20 +92,23 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct($conn) : void</pre> <pre>__construct(object $conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$conn</h4></div> <div class="subelement argument">
<h4>$conn</h4>
<code>object</code>
</div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse" title="public">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $exclude) : string</pre> <pre>backup_data(array $exclude<code> = array()</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -113,7 +121,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse" title="public">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -123,9 +131,9 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Database-specific method to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <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="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -150,7 +158,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Database-specific SQL for dropping a table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -171,9 +179,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

334
docs/classes/Query_Builder.html
View File

@ -49,15 +49,21 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___call" title="__call() :: Calls a function further down the inheritence chain"><span class="description">Calls a function further down the inheritence chain</span><pre>__call()</pre></a></li> <li class="method public "><a href="#method___call" title="__call() :: Calls a function further down the inheritence chain"><span class="description">Calls a function further down the inheritence chain</span><pre>__call()</pre></a></li>
<li class="method public "><a href="#method___construct" title="__construct() :: Constructor"><span class="description">Constructor</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Constructor"><span class="description">Constructor</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method___destruct" title="__destruct() :: Destructor"><span class="description">Destructor</span><pre>__destruct()</pre></a></li>
<li class="method public "><a href="#method_count_all" title="count_all() :: Retreive the number of rows in the selected table"><span class="description">Retreive the number of rows in the selected table</span><pre>count_all()</pre></a></li> <li class="method public "><a href="#method_count_all" title="count_all() :: Retreive the number of rows in the selected table"><span class="description">Retreive the number of rows in the selected table</span><pre>count_all()</pre></a></li>
<li class="method public "><a href="#method_count_all_results" title="count_all_results() :: Retrieve the number of results for the generated query - used <li class="method public "><a href="#method_count_all_results" title="count_all_results() :: Retrieve the number of results for the generated query - used
in place of the get() method"><span class="description">Retrieve the number of results for the generated query - used in place of the get() method"><span class="description">Retrieve the number of results for the generated query - used
@ -128,7 +134,7 @@ passed array with key / value pairs</span><pre>where()</pre></a></li>
</ul> </ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul> <ul>
<li class="property public "><a href="#property_conn_name" title="$conn_name() :: "><span class="description"></span><pre>$conn_name</pre></a></li> <li class="property public "><a href="#property_conn_name" title="$conn_name() :: "><span class="description"></span><pre>$conn_name</pre></a></li>
<li class="property public "><a href="#property_queries" title="$queries() :: "><span class="description"></span><pre>$queries</pre></a></li> <li class="property public "><a href="#property_queries" title="$queries() :: "><span class="description"></span><pre>$queries</pre></a></li>
@ -159,7 +165,7 @@ passed array with key / value pairs</span><pre>where()</pre></a></li>
<div class="span8"> <div class="span8">
<a id="\Query_Builder"></a><ul class="breadcrumb"> <a id="\Query_Builder"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/Query_Builder.html">Query_Builder</a> <span class="divider">\</span><a href="../classes/Query_Builder.html">Query_Builder</a>
@ -181,8 +187,8 @@ instantiates the specific db driver</p>
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method___call"></a><div class="element clickable method public method___call" data-toggle="collapse" data-target=".method___call .collapse"> <a id="method___call"></a><div class="element clickable method public method___call" data-toggle="collapse" data-target=".method___call .collapse" title="public">
<h2>Calls a function further down the inheritence chain</h2> <h2>Calls a function further down the inheritence chain</h2>
<pre>__call(string $name, array $params) : mixed</pre> <pre>__call(string $name, array $params) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
@ -197,11 +203,16 @@ instantiates the specific db driver</p>
<h4>$params</h4> <h4>$params</h4>
<code>array</code> <code>array</code>
</div> </div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="BadMethodCallException.html">\BadMethodCallException</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </div></div>
</div> </div>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse"> <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> <h2>Constructor</h2>
<pre>__construct(\DB_PDO $db, object $params) </pre> <pre>__construct(\DB_PDO $db, object $params) </pre>
<div class="labels"></div> <div class="labels"></div>
@ -216,11 +227,16 @@ instantiates the specific db driver</p>
<h4>$params</h4> <h4>$params</h4>
<code>object</code><ul> <code>object</code><ul>
<li>the connection parameters</li> <li>the connection parameters</li>
</ul> </ul></div>
</div>
</div></div> </div></div>
</div> </div>
<a id="method_count_all"></a><div class="element clickable method public method_count_all" data-toggle="collapse" data-target=".method_count_all .collapse"> <a id="method___destruct"></a><div class="element clickable method public method___destruct" data-toggle="collapse" data-target=".method___destruct .collapse" title="public">
<h2>Destructor</h2>
<pre>__destruct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_count_all"></a><div class="element clickable method public method_count_all" data-toggle="collapse" data-target=".method_count_all .collapse" title="public">
<h2>Retreive the number of rows in the selected table</h2> <h2>Retreive the number of rows in the selected table</h2>
<pre>count_all(string $table) : int</pre> <pre>count_all(string $table) : int</pre>
<div class="labels"></div> <div class="labels"></div>
@ -235,10 +251,10 @@ instantiates the specific db driver</p>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_count_all_results"></a><div class="element clickable method public method_count_all_results" data-toggle="collapse" data-target=".method_count_all_results .collapse"> <a id="method_count_all_results"></a><div class="element clickable method public method_count_all_results" data-toggle="collapse" data-target=".method_count_all_results .collapse" title="public">
<h2>Retrieve the number of results for the generated query - used <h2>Retrieve the number of results for the generated query - used
in place of the get() method</h2> in place of the get() method</h2>
<pre>count_all_results(string $table) : int</pre> <pre>count_all_results(string $table<code> = ''</code>) : int</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -251,9 +267,9 @@ in place of the get() method</h2>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_delete"></a><div class="element clickable method public method_delete" data-toggle="collapse" data-target=".method_delete .collapse"> <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> <h2>Deletes data from a table</h2>
<pre>delete(string $table, mixed $where) : mixed</pre> <pre>delete(string $table, mixed $where<code> = ''</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -270,7 +286,7 @@ in place of the get() method</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <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> <h2>Adds the 'distinct' keyword to a query</h2>
<pre>distinct() : \Query_Builder</pre> <pre>distinct() : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -284,7 +300,7 @@ in place of the get() method</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Tell the database to give you the query plan instead of result set</h2>
<pre>explain() : \Query_Builder</pre> <pre>explain() : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -298,7 +314,7 @@ in place of the get() method</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Specify the database table to select from</h2>
<pre>from(string $tblname) : \Query_Builder</pre> <pre>from(string $tblname) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -317,10 +333,10 @@ in place of the get() method</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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 <h2>Select and retrieve all records from the current table, and/or
execute current compiled query</h2> execute current compiled query</h2>
<pre>get(mixed $table, int $limit, int $offset) : object</pre> <pre>get(mixed $table<code> = ''</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : object</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -338,9 +354,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>object</code></div> <div class="subelement response"><code>object</code></div>
</div></div> </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"> <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">
<h2>Returns the generated 'delete' sql query</h2> <h2>Returns the generated 'delete' sql query</h2>
<pre>get_compiled_delete(string $table, bool $reset) : string</pre> <pre>get_compiled_delete(string $table<code> = ""</code>, bool $reset<code> = TRUE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -357,9 +373,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_compiled_insert"></a><div class="element clickable method public method_get_compiled_insert" data-toggle="collapse" data-target=".method_get_compiled_insert .collapse"> <a id="method_get_compiled_insert"></a><div class="element clickable method public method_get_compiled_insert" data-toggle="collapse" data-target=".method_get_compiled_insert .collapse" title="public">
<h2>Returns the generated 'insert' sql query</h2> <h2>Returns the generated 'insert' sql query</h2>
<pre>get_compiled_insert(string $table, bool $reset) : string</pre> <pre>get_compiled_insert(string $table, bool $reset<code> = TRUE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -376,9 +392,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_compiled_select"></a><div class="element clickable method public method_get_compiled_select" data-toggle="collapse" data-target=".method_get_compiled_select .collapse"> <a id="method_get_compiled_select"></a><div class="element clickable method public method_get_compiled_select" data-toggle="collapse" data-target=".method_get_compiled_select .collapse" title="public">
<h2>Returns the generated 'select' sql query</h2> <h2>Returns the generated 'select' sql query</h2>
<pre>get_compiled_select(string $table, bool $reset) : string</pre> <pre>get_compiled_select(string $table<code> = ''</code>, bool $reset<code> = TRUE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -395,9 +411,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_compiled_update"></a><div class="element clickable method public method_get_compiled_update" data-toggle="collapse" data-target=".method_get_compiled_update .collapse"> <a id="method_get_compiled_update"></a><div class="element clickable method public method_get_compiled_update" data-toggle="collapse" data-target=".method_get_compiled_update .collapse" title="public">
<h2>Returns the generated 'update' sql query</h2> <h2>Returns the generated 'update' sql query</h2>
<pre>get_compiled_update(string $table, bool $reset) : string</pre> <pre>get_compiled_update(string $table<code> = ''</code>, bool $reset<code> = TRUE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -414,9 +430,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </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"> <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> <h2>Convience method for get() with a where clause</h2>
<pre>get_where(string $table, array $where, int $limit, int $offset) : object</pre> <pre>get_where(string $table, array $where<code> = array()</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : object</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -441,7 +457,7 @@ execute current compiled query</h2>
<div class="subelement response"><code>object</code></div> <div class="subelement response"><code>object</code></div>
</div></div> </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"> <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> <h2>Group the results by the selected field(s)</h2>
<pre>group_by(mixed $field) : \Query_Builder</pre> <pre>group_by(mixed $field) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -460,7 +476,7 @@ execute current compiled query</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Ends a query group</h2>
<pre>group_end() : \Query_Builder</pre> <pre>group_end() : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -474,7 +490,7 @@ execute current compiled query</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Adds a paren to the current query for query grouping</h2>
<pre>group_start() : \Query_Builder</pre> <pre>group_start() : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -488,9 +504,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Generates a 'Having' clause</h2>
<pre>having(mixed $key, mixed $val) : \Query_Builder</pre> <pre>having(mixed $key, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -511,9 +527,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Creates an insert clause, and executes it</h2>
<pre>insert(string $table, mixed $data) : mixed</pre> <pre>insert(string $table, mixed $data<code> = array()</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -530,9 +546,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <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> <h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : string</pre> <pre>insert_batch(string $table, array $data<code> = array()</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -549,9 +565,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Creates a join phrase in a compiled query</h2>
<pre>join(string $table, string $condition, string $type) : \Query_Builder</pre> <pre>join(string $table, string $condition, string $type<code> = ''</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -576,9 +592,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Creates a Like clause in the sql statement</h2>
<pre>like(string $field, mixed $val, string $pos) : \Query_Builder</pre> <pre>like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -603,9 +619,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse" title="public">
<h2>Set a limit on the current sql statement</h2> <h2>Set a limit on the current sql statement</h2>
<pre>limit(int $limit, int $offset) : string</pre> <pre>limit(int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -622,9 +638,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </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"> <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> <h2>Generates a NOT LIKE clause</h2>
<pre>not_like(string $field, mixed $val, string $pos) : \Query_Builder</pre> <pre>not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -649,7 +665,7 @@ execute current compiled query</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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, <h2>Adds a paren to the current query for query grouping,
prefixed with 'OR'</h2> prefixed with 'OR'</h2>
<pre>or_group_start() : \Query_Builder</pre> <pre>or_group_start() : \Query_Builder</pre>
@ -664,9 +680,9 @@ prefixed with 'OR'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Generates a 'Having' clause prefixed with 'OR'</h2>
<pre>or_having(mixed $key, mixed $val) : \Query_Builder</pre> <pre>or_having(mixed $key, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -687,9 +703,9 @@ prefixed with 'OR'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Generates an OR Like clause</h2>
<pre>or_like(string $field, mixed $val, string $pos) : \Query_Builder</pre> <pre>or_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -714,7 +730,7 @@ prefixed with 'OR'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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, <h2>Adds a paren to the current query for query grouping,
prefixed with 'OR NOT'</h2> prefixed with 'OR NOT'</h2>
<pre>or_not_group_start() : \Query_Builder</pre> <pre>or_not_group_start() : \Query_Builder</pre>
@ -729,9 +745,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Generates a OR NOT LIKE clause</h2>
<pre>or_not_like(string $field, mixed $val, string $pos) : \Query_Builder</pre> <pre>or_not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -756,9 +772,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Where clause prefixed with "OR"</h2>
<pre>or_where(string $key, mixed $val) : \Query_Builder</pre> <pre>or_where(string $key, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -779,9 +795,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Where in statement prefixed with "or"</h2>
<pre>or_where_in(string $field, mixed $val) : \Query_Builder</pre> <pre>or_where_in(string $field, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -802,9 +818,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>OR WHERE NOT IN (FOO) clause</h2>
<pre>or_where_not_in(string $field, mixed $val) : \Query_Builder</pre> <pre>or_where_not_in(string $field, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -825,9 +841,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Order the results by the selected field(s)</h2>
<pre>order_by(string $field, string $type) : \Query_Builder</pre> <pre>order_by(string $field, string $type<code> = ""</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -848,13 +864,13 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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">
<h2>Clear out the class variables, so the next query can be run</h2> <h2>Clear out the class variables, so the next query can be run</h2>
<pre>reset_query() : void</pre> <pre>reset_query() : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="method_select"></a><div class="element clickable method public method_select" data-toggle="collapse" data-target=".method_select .collapse"> <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> <h2>Specifies rows to select in a query</h2>
<pre>select(string $fields) : \Query_Builder</pre> <pre>select(string $fields) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -873,9 +889,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Selects the average value of a field from a query</h2>
<pre>select_avg(string $field, string $as) : \Query_Builder</pre> <pre>select_avg(string $field, string $as<code> = FALSE</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -896,9 +912,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Selects the maximum value of a field from a query</h2>
<pre>select_max(string $field, string $as) : \Query_Builder</pre> <pre>select_max(string $field, string $as<code> = FALSE</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -919,9 +935,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Selects the minimum value of a field from a query</h2>
<pre>select_min(string $field, string $as) : \Query_Builder</pre> <pre>select_min(string $field, string $as<code> = FALSE</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -942,9 +958,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Selects the sum of a field from a query</h2>
<pre>select_sum(string $field, string $as) : \Query_Builder</pre> <pre>select_sum(string $field, string $as<code> = FALSE</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -965,9 +981,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Sets values for inserts / updates / deletes</h2>
<pre>set(mixed $key, mixed $val) : \Query_Builder</pre> <pre>set(mixed $key, mixed $val<code> = NULL</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -988,9 +1004,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Creates an update clause, and executes it</h2>
<pre>update(string $table, mixed $data) : mixed</pre> <pre>update(string $table, mixed $data<code> = array()</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1007,11 +1023,11 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <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 <h2>Specify condition(s) in the where clause of a query
Note: this function works with key / value, or a Note: this function works with key / value, or a
passed array with key / value pairs</h2> passed array with key / value pairs</h2>
<pre>where(mixed $key, mixed $val, mixed $escape) : \Query_Builder</pre> <pre>where(mixed $key, mixed $val<code> = array()</code>, mixed $escape<code> = NULL</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1036,9 +1052,9 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>Where clause with 'IN' statement</h2>
<pre>where_in(mixed $field, mixed $val) : \Query_Builder</pre> <pre>where_in(mixed $field, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1059,9 +1075,9 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <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> <h2>WHERE NOT IN (FOO) clause</h2>
<pre>where_not_in(string $field, mixed $val) : \Query_Builder</pre> <pre>where_not_in(string $field, mixed $val<code> = array()</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1082,9 +1098,9 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </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"> <a id="method__compile"></a><div class="element clickable method protected method__compile" data-toggle="collapse" data-target=".method__compile .collapse" title="protected">
<h2>String together the sql statements for sending to the db</h2> <h2>String together the sql statements for sending to the db</h2>
<pre>_compile(string $type, string $table) : <a href="%24string.html">\$string</a></pre> <pre>_compile(string $type<code> = ''</code>, string $table<code> = ''</code>) : <a href="%24string.html">\$string</a></pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1101,7 +1117,7 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code><a href="%24string.html">\$string</a></code></div> <div class="subelement response"><code><a href="%24string.html">\$string</a></code></div>
</div></div> </div></div>
</div> </div>
<a id="method__get_compile"></a><div class="element clickable method protected method__get_compile" data-toggle="collapse" data-target=".method__get_compile .collapse"> <a id="method__get_compile"></a><div class="element clickable method protected method__get_compile" data-toggle="collapse" data-target=".method__get_compile .collapse" title="protected">
<h2>Helper function for returning sql strings</h2> <h2>Helper function for returning sql strings</h2>
<pre>_get_compile(string $type, string $table, bool $reset) </pre> <pre>_get_compile(string $type, string $table, bool $reset) </pre>
<div class="labels"></div> <div class="labels"></div>
@ -1126,9 +1142,9 @@ passed array with key / value pairs</h2>
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="method__having"></a><div class="element clickable method protected method__having" data-toggle="collapse" data-target=".method__having .collapse"> <a id="method__having"></a><div class="element clickable method protected method__having" data-toggle="collapse" data-target=".method__having .collapse" title="protected">
<h2>Simplify building having clauses</h2> <h2>Simplify building having clauses</h2>
<pre>_having(mixed $key, mixed $val, string $conj) : \Query_Builder</pre> <pre>_having(mixed $key, mixed $val<code> = array()</code>, string $conj<code> = 'AND'</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1153,9 +1169,9 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a id="method__like"></a><div class="element clickable method protected method__like" data-toggle="collapse" data-target=".method__like .collapse"> <a id="method__like"></a><div class="element clickable method protected method__like" data-toggle="collapse" data-target=".method__like .collapse" title="protected">
<h2>Simplify 'like' methods</h2> <h2>Simplify 'like' methods</h2>
<pre>_like(string $field, mixed $val, string $pos, string $like, string $conj) : \Query_Builder</pre> <pre>_like(string $field, mixed $val, string $pos, string $like<code> = 'LIKE'</code>, string $conj<code> = 'AND'</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1188,9 +1204,9 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a id="method__run"></a><div class="element clickable method protected method__run" data-toggle="collapse" data-target=".method__run .collapse"> <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> <h2>Executes the compiled query</h2>
<pre>_run(string $type, string $table, bool $simple, string $sql, mixed $vals) : mixed</pre> <pre>_run(string $type, string $table, bool $simple<code> = FALSE</code>, string $sql<code> = NULL</code>, mixed $vals<code> = NULL</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1219,9 +1235,9 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <a id="method__select"></a><div class="element clickable method protected method__select" data-toggle="collapse" data-target=".method__select .collapse" title="protected">
<h2>Method to simplify select_ methods</h2> <h2>Method to simplify select_ methods</h2>
<pre>_select(string $field, string $as) : string</pre> <pre>_select(string $field, string $as<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1238,9 +1254,9 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method__where"></a><div class="element clickable method protected method__where" data-toggle="collapse" data-target=".method__where .collapse"> <a id="method__where"></a><div class="element clickable method protected method__where" data-toggle="collapse" data-target=".method__where .collapse" title="protected">
<h2>Do all the repeditive stuff for where/having type methods</h2> <h2>Do all the repeditive stuff for where/having type methods</h2>
<pre>_where(mixed $key, mixed $val) : array</pre> <pre>_where(mixed $key, mixed $val<code> = array()</code>) : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1257,9 +1273,9 @@ passed array with key / value pairs</h2>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method__where_in"></a><div class="element clickable method protected method__where_in" data-toggle="collapse" data-target=".method__where_in .collapse"> <a id="method__where_in"></a><div class="element clickable method protected method__where_in" data-toggle="collapse" data-target=".method__where_in .collapse" title="protected">
<h2>Simplify where_in methods</h2> <h2>Simplify where_in methods</h2>
<pre>_where_in(mixed $key, mixed $val, string $in, string $conj) : \Query_Builder</pre> <pre>_where_in(mixed $key, mixed $val<code> = array()</code>, string $in<code> = 'IN'</code>, string $conj<code> = 'AND'</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1280,21 +1296,19 @@ passed array with key / value pairs</h2>
<h4>$in</h4> <h4>$in</h4>
<code>string</code><ul> <code>string</code><ul>
<li>The (not) in fragment</li> <li>The (not) in fragment</li>
</ul> </ul></div>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$conj</h4> <h4>$conj</h4>
<code>string</code><ul> <code>string</code><ul>
<li>The where in conjunction</li> <li>The where in conjunction</li>
</ul> </ul></div>
</div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>\Query_Builder</code></div> <div class="subelement response"><code>\Query_Builder</code></div>
</div></div> </div></div>
</div> </div>
<a id="method__where_string"></a><div class="element clickable method protected method__where_string" data-toggle="collapse" data-target=".method__where_string .collapse"> <a id="method__where_string"></a><div class="element clickable method protected method__where_string" data-toggle="collapse" data-target=".method__where_string .collapse" title="protected">
<h2>Simplify generating where string</h2> <h2>Simplify generating where string</h2>
<pre>_where_string(mixed $key, mixed $val, string $conj) : \Query_Builder</pre> <pre>_where_string(mixed $key, mixed $val<code> = array()</code>, string $conj<code> = 'AND'</code>) : \Query_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -1320,112 +1334,184 @@ passed array with key / value pairs</h2>
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_conn_name"> </a><div class="element clickable property public property_conn_name" data-toggle="collapse" data-target=".property_conn_name .collapse"> <a id="property_conn_name"> </a><div class="element clickable property public property_conn_name" data-toggle="collapse" data-target=".property_conn_name .collapse" title="public">
<h2>$conn_name</h2> <h2>$conn_name</h2>
<pre>$conn_name </pre> <pre>$conn_name </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>""</code></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_queries"> </a><div class="element clickable property public property_queries" data-toggle="collapse" data-target=".property_queries .collapse"> <a id="property_queries"> </a><div class="element clickable property public property_queries" data-toggle="collapse" data-target=".property_queries .collapse" title="public">
<h2>$queries</h2> <h2>$queries</h2>
<pre>$queries </pre> <pre>$queries </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_sql"> </a><div class="element clickable property public property_sql" data-toggle="collapse" data-target=".property_sql .collapse"> <a id="property_sql"> </a><div class="element clickable property public property_sql" data-toggle="collapse" data-target=".property_sql .collapse" title="public">
<h2>$sql</h2> <h2>$sql</h2>
<pre>$sql </pre> <pre>$sql </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_explain"> </a><div class="element clickable property protected property_explain" data-toggle="collapse" data-target=".property_explain .collapse"> <a id="property_explain"> </a><div class="element clickable property protected property_explain" data-toggle="collapse" data-target=".property_explain .collapse" title="protected">
<h2>$explain</h2> <h2>$explain</h2>
<pre>$explain </pre> <pre>$explain </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>FALSE</code></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_from_string"> </a><div class="element clickable property protected property_from_string" data-toggle="collapse" data-target=".property_from_string .collapse"> <a id="property_from_string"> </a><div class="element clickable property protected property_from_string" data-toggle="collapse" data-target=".property_from_string .collapse" title="protected">
<h2>$from_string</h2> <h2>$from_string</h2>
<pre>$from_string </pre> <pre>$from_string </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_group_array"> </a><div class="element clickable property protected property_group_array" data-toggle="collapse" data-target=".property_group_array .collapse"> <a id="property_group_array"> </a><div class="element clickable property protected property_group_array" data-toggle="collapse" data-target=".property_group_array .collapse" title="protected">
<h2>$group_array</h2> <h2>$group_array</h2>
<pre>$group_array </pre> <pre>$group_array </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_group_string"> </a><div class="element clickable property protected property_group_string" data-toggle="collapse" data-target=".property_group_string .collapse"> <a id="property_group_string"> </a><div class="element clickable property protected property_group_string" data-toggle="collapse" data-target=".property_group_string .collapse" title="protected">
<h2>$group_string</h2> <h2>$group_string</h2>
<pre>$group_string </pre> <pre>$group_string </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_having_map"> </a><div class="element clickable property protected property_having_map" data-toggle="collapse" data-target=".property_having_map .collapse"> <a id="property_having_map"> </a><div class="element clickable property protected property_having_map" data-toggle="collapse" data-target=".property_having_map .collapse" title="protected">
<h2>$having_map</h2> <h2>$having_map</h2>
<pre>$having_map </pre> <pre>$having_map </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_limit"> </a><div class="element clickable property protected property_limit" data-toggle="collapse" data-target=".property_limit .collapse"> <a id="property_limit"> </a><div class="element clickable property protected property_limit" data-toggle="collapse" data-target=".property_limit .collapse" title="protected">
<h2>$limit</h2> <h2>$limit</h2>
<pre>$limit </pre> <pre>$limit </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_offset"> </a><div class="element clickable property protected property_offset" data-toggle="collapse" data-target=".property_offset .collapse"> <a id="property_offset"> </a><div class="element clickable property protected property_offset" data-toggle="collapse" data-target=".property_offset .collapse" title="protected">
<h2>$offset</h2> <h2>$offset</h2>
<pre>$offset </pre> <pre>$offset </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_order_array"> </a><div class="element clickable property protected property_order_array" data-toggle="collapse" data-target=".property_order_array .collapse"> <a id="property_order_array"> </a><div class="element clickable property protected property_order_array" data-toggle="collapse" data-target=".property_order_array .collapse" title="protected">
<h2>$order_array</h2> <h2>$order_array</h2>
<pre>$order_array </pre> <pre>$order_array </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_order_string"> </a><div class="element clickable property protected property_order_string" data-toggle="collapse" data-target=".property_order_string .collapse"> <a id="property_order_string"> </a><div class="element clickable property protected property_order_string" data-toggle="collapse" data-target=".property_order_string .collapse" title="protected">
<h2>$order_string</h2> <h2>$order_string</h2>
<pre>$order_string </pre> <pre>$order_string </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_query_map"> </a><div class="element clickable property protected property_query_map" data-toggle="collapse" data-target=".property_query_map .collapse"> <a id="property_query_map"> </a><div class="element clickable property protected property_query_map" data-toggle="collapse" data-target=".property_query_map .collapse" title="protected">
<h2>$query_map</h2> <h2>$query_map</h2>
<pre>$query_map </pre> <pre>$query_map </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="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_select_string"> </a><div class="element clickable property protected property_select_string" data-toggle="collapse" data-target=".property_select_string .collapse"> <a id="property_select_string"> </a><div class="element clickable property protected property_select_string" data-toggle="collapse" data-target=".property_select_string .collapse" title="protected">
<h2>$select_string</h2> <h2>$select_string</h2>
<pre>$select_string </pre> <pre>$select_string </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_set_array_keys"> </a><div class="element clickable property protected property_set_array_keys" data-toggle="collapse" data-target=".property_set_array_keys .collapse"> <a id="property_set_array_keys"> </a><div class="element clickable property protected property_set_array_keys" data-toggle="collapse" data-target=".property_set_array_keys .collapse" title="protected">
<h2>$set_array_keys</h2> <h2>$set_array_keys</h2>
<pre>$set_array_keys </pre> <pre>$set_array_keys </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_set_string"> </a><div class="element clickable property protected property_set_string" data-toggle="collapse" data-target=".property_set_string .collapse"> <a id="property_set_string"> </a><div class="element clickable property protected property_set_string" data-toggle="collapse" data-target=".property_set_string .collapse" title="protected">
<h2>$set_string</h2> <h2>$set_string</h2>
<pre>$set_string </pre> <pre>$set_string </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_values"> </a><div class="element clickable property protected property_values" data-toggle="collapse" data-target=".property_values .collapse"> <a id="property_values"> </a><div class="element clickable property protected property_values" data-toggle="collapse" data-target=".property_values .collapse" title="protected">
<h2>$values</h2> <h2>$values</h2>
<pre>$values </pre> <pre>$values </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="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_where_values"> </a><div class="element clickable property protected property_where_values" data-toggle="collapse" data-target=".property_where_values .collapse"> <a id="property_where_values"> </a><div class="element clickable property protected property_where_values" data-toggle="collapse" data-target=".property_where_values .collapse" title="protected">
<h2>$where_values</h2> <h2>$where_values</h2>
<pre>$where_values </pre> <pre>$where_values </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="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -1435,9 +1521,9 @@ passed array with key / value pairs</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

60
docs/classes/Query_Parser.html
View File

@ -49,12 +49,17 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Constructor/entry point into parser"><span class="description">Constructor/entry point into parser</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Constructor/entry point into parser"><span class="description">Constructor/entry point into parser</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_parse_join" title="parse_join() :: Public parser method for seting the parse string"><span class="description">Public parser method for seting the parse string</span><pre>parse_join()</pre></a></li> <li class="method public "><a href="#method_parse_join" title="parse_join() :: Public parser method for seting the parse string"><span class="description">Public parser method for seting the parse string</span><pre>parse_join()</pre></a></li>
@ -64,7 +69,7 @@
<ul><li class="method private "><a href="#method_filter_array" title="filter_array() :: Returns a more useful match array"><span class="description">Returns a more useful match array</span><pre>filter_array()</pre></a></li></ul> <ul><li class="method private "><a href="#method_filter_array" title="filter_array() :: Returns a more useful match array"><span class="description">Returns a more useful match array</span><pre>filter_array()</pre></a></li></ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul><li class="property public "><a href="#property_matches" title="$matches() :: Regex matches"><span class="description"></span><pre>$matches</pre></a></li></ul> <ul><li class="property public "><a href="#property_matches" title="$matches() :: Regex matches"><span class="description"></span><pre>$matches</pre></a></li></ul>
</li> </li>
<li class="nav-header private">» Private <li class="nav-header private">» Private
@ -75,7 +80,7 @@
<div class="span8"> <div class="span8">
<a id="\Query_Parser"></a><ul class="breadcrumb"> <a id="\Query_Parser"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/Query_Parser.html">Query_Parser</a> <span class="divider">\</span><a href="../classes/Query_Parser.html">Query_Parser</a>
@ -96,50 +101,67 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <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/entry point into parser</h2> <h2>Constructor/entry point into parser</h2>
<pre>__construct($sql) </pre> <pre>__construct(string $sql<code> = ''</code>) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$sql</h4></div> <div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
</div></div> </div></div>
</div> </div>
<a id="method_parse_join"></a><div class="element clickable method public method_parse_join" data-toggle="collapse" data-target=".method_parse_join .collapse"> <a id="method_parse_join"></a><div class="element clickable method public method_parse_join" data-toggle="collapse" data-target=".method_parse_join .collapse" title="public">
<h2>Public parser method for seting the parse string</h2> <h2>Public parser method for seting the parse string</h2>
<pre>parse_join($sql) </pre> <pre>parse_join(string $sql) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$sql</h4></div> <div class="subelement argument">
<h4>$sql</h4>
<code>string</code>
</div>
</div></div> </div></div>
</div> </div>
<a id="method_filter_array"></a><div class="element clickable method private method_filter_array" data-toggle="collapse" data-target=".method_filter_array .collapse"> <a id="method_filter_array"></a><div class="element clickable method private method_filter_array" data-toggle="collapse" data-target=".method_filter_array .collapse" title="private">
<h2>Returns a more useful match array</h2> <h2>Returns a more useful match array</h2>
<pre>filter_array($array) : array</pre> <pre>filter_array(array $array) : array</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$array</h4></div> <div class="subelement argument">
<h4>$array</h4>
<code>array</code>
</div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_matches"> </a><div class="element clickable property public property_matches" data-toggle="collapse" data-target=".property_matches .collapse"> <a id="property_matches"> </a><div class="element clickable property public property_matches" data-toggle="collapse" data-target=".property_matches .collapse" title="public">
<h2>Regex matches</h2> <h2>Regex matches</h2>
<pre>$matches : array</pre> <pre>$matches : array</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>array('functions' => array(), 'identifiers' => array(), 'operators' => array(), 'combined' => array())</code></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="property_match_patterns"> </a><div class="element clickable property private property_match_patterns" data-toggle="collapse" data-target=".property_match_patterns .collapse"> <a id="property_match_patterns"> </a><div class="element clickable property private property_match_patterns" data-toggle="collapse" data-target=".property_match_patterns .collapse" title="private">
<h2>Regex patterns for various syntax components</h2> <h2>Regex patterns for various syntax components</h2>
<pre>$match_patterns : array</pre> <pre>$match_patterns : array</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>array('function' => '([a-zA-Z0-9_]+\((.*?)\))', 'identifier' => '([a-zA-Z0-9_-]+\.?)+', 'operator' => '=|AND|&&?|~|\|\|?|\^|/|>=?|<=?|-|%|OR|\+|NOT|\!=?|<>|XOR')</code></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -149,9 +171,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

41
docs/classes/SQLite.html
View File

@ -49,12 +49,17 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"> <ul class="side-nav nav nav-list">
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Open SQLite Database"><span class="description">Open SQLite Database</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Open SQLite Database"><span class="description">Open SQLite Database</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_get_system_tables" title="get_system_tables() :: List system tables for the current database"><span class="description">List system tables for the current database</span><pre>get_system_tables()</pre></a></li> <li class="method public "><a href="#method_get_system_tables" title="get_system_tables() :: List system tables for the current database"><span class="description">List system tables for the current database</span><pre>get_system_tables()</pre></a></li>
@ -64,7 +69,7 @@
</ul> </ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-property"></i> Properties <i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul> <ul></ul>
</li> </li>
<li class="nav-header protected">» Protected <li class="nav-header protected">» Protected
@ -75,7 +80,7 @@
<div class="span8"> <div class="span8">
<a id="\SQLite"></a><ul class="breadcrumb"> <a id="\SQLite"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/SQLite.html">SQLite</a> <span class="divider">\</span><a href="../classes/SQLite.html">SQLite</a>
@ -96,10 +101,10 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Open SQLite Database</h2> <h2>Open SQLite Database</h2>
<pre>__construct(string $dsn, string $user, string $pass) </pre> <pre>__construct(string $dsn, string $user<code> = NULL</code>, string $pass<code> = NULL</code>) </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -118,7 +123,7 @@
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="method_get_system_tables"></a><div class="element clickable method public method_get_system_tables" data-toggle="collapse" data-target=".method_get_system_tables .collapse"> <a id="method_get_system_tables"></a><div class="element clickable method public method_get_system_tables" data-toggle="collapse" data-target=".method_get_system_tables .collapse" title="public">
<h2>List system tables for the current database</h2> <h2>List system tables for the current database</h2>
<pre>get_system_tables() : array</pre> <pre>get_system_tables() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -128,7 +133,7 @@
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_tables"></a><div class="element clickable method public method_get_tables" data-toggle="collapse" data-target=".method_get_tables .collapse"> <a id="method_get_tables"></a><div class="element clickable method public method_get_tables" data-toggle="collapse" data-target=".method_get_tables .collapse" title="public">
<h2>List tables for the current database</h2> <h2>List tables for the current database</h2>
<pre>get_tables() : mixed</pre> <pre>get_tables() : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
@ -138,9 +143,9 @@
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <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> <h2>Create sql for batch insert</h2>
<pre>insert_batch(string $table, array $data) : string</pre> <pre>insert_batch(string $table, array $data<code> = array()</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -157,7 +162,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse"> <a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse" title="public">
<h2>Empty a table</h2> <h2>Empty a table</h2>
<pre>truncate(string $table) </pre> <pre>truncate(string $table) </pre>
<div class="labels"></div> <div class="labels"></div>
@ -171,10 +176,14 @@
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-property"></i> Properties</h3> <i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse"> <a id="property_statement"> </a><div class="element clickable property protected property_statement" data-toggle="collapse" data-target=".property_statement .collapse" title="protected">
<h2>Reference to the last executed sql query</h2> <h2>Reference to the last executed sql query</h2>
<pre>$statement : <a href="PDOStatement.html">\PDOStatement</a></pre> <pre>$statement : <a href="PDOStatement.html">\PDOStatement</a></pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -184,9 +193,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

45
docs/classes/SQLite_SQL.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method_column_list" title="column_list() :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a table</span><pre>column_list()</pre></a></li> <li class="method public "><a href="#method_column_list" title="column_list() :: SQL to show infromation about columns in a table"><span class="description">SQL to show infromation about columns in a 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_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>
@ -74,7 +79,7 @@
<div class="span8"> <div class="span8">
<a id="\SQLite_SQL"></a><ul class="breadcrumb"> <a id="\SQLite_SQL"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/SQLite_SQL.html">SQLite_SQL</a> <span class="divider">\</span><a href="../classes/SQLite_SQL.html">SQLite_SQL</a>
@ -95,8 +100,8 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <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>SQL to show infromation about columns in a table</h2> <h2>SQL to show infromation about columns in a table</h2>
<pre>column_list(string $table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -111,7 +116,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list other databases</h2>
<pre>db_list() : NULL</pre> <pre>db_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -121,7 +126,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
<h2>Get the query plan for the sql query</h2> <h2>Get the query plan for the sql query</h2>
<pre>explain(string $sql) : string</pre> <pre>explain(string $sql) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -136,7 +141,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre> <pre>function_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -146,9 +151,9 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -169,7 +174,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : NULL</pre> <pre>procedure_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -179,7 +184,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <a id="method_random"></a><div class="element clickable method public method_random" data-toggle="collapse" data-target=".method_random .collapse" title="public">
<h2>Random ordering keyword</h2> <h2>Random ordering keyword</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -189,7 +194,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : NULL</pre> <pre>sequence_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -199,7 +204,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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>Overridden in SQLite class</h2> <h2>Overridden in SQLite class</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -209,7 +214,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre> <pre>table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -219,7 +224,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : NULL</pre> <pre>trigger_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -229,7 +234,7 @@
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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>SQL to show list of field types</h2> <h2>SQL to show list of field types</h2>
<pre>type_list() : array</pre> <pre>type_list() : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -239,7 +244,7 @@
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </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"> <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> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -255,9 +260,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

50
docs/classes/SQLite_Util.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li> <li class="method public "><a href="#method___construct" title="__construct() :: Save a reference to the current connection object"><span class="description">Save a reference to the current connection object</span><pre>__construct()</pre></a></li>
<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_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>
@ -66,7 +71,7 @@
<div class="span8"> <div class="span8">
<a id="\SQLite_Util"></a><ul class="breadcrumb"> <a id="\SQLite_Util"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/SQLite_Util.html">SQLite_Util</a> <span class="divider">\</span><a href="../classes/SQLite_Util.html">SQLite_Util</a>
@ -87,20 +92,23 @@
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Save a reference to the current connection object</h2> <h2>Save a reference to the current connection object</h2>
<pre>__construct($conn) : void</pre> <pre>__construct(object $conn) : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$conn</h4></div> <div class="subelement argument">
<h4>$conn</h4>
<code>object</code>
</div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse"> <a id="method_backup_data"></a><div class="element clickable method public method_backup_data" data-toggle="collapse" data-target=".method_backup_data .collapse" title="public">
<h2>Create an SQL backup file for the current database's data</h2> <h2>Create an SQL backup file for the current database's data</h2>
<pre>backup_data(array $excluded) : string</pre> <pre>backup_data(array $excluded<code> = array()</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -113,7 +121,7 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse"> <a id="method_backup_structure"></a><div class="element clickable method public method_backup_structure" data-toggle="collapse" data-target=".method_backup_structure .collapse" title="public">
<h2>Create an SQL backup file for the current database's structure</h2> <h2>Create an SQL backup file for the current database's structure</h2>
<pre>backup_structure() : string</pre> <pre>backup_structure() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -123,34 +131,30 @@
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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>Convenience public function to create a new table</h2> <h2>Convenience public function to create a new table</h2>
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre> <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="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"> <div class="subelement argument">
<h4>$name</h4> <h4>$name</h4>
<code>string</code><p>//Name of the table</p> <code>string</code><p>//Name of the table</p></div>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$columns</h4> <h4>$columns</h4>
<code>array</code><p>//columns as straight array and/or column => type pairs</p> <code>array</code><p>//columns as straight array and/or column => type pairs</p></div>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$constraints</h4> <h4>$constraints</h4>
<code>array</code><p>// column => constraint pairs</p> <code>array</code><p>// column => constraint pairs</p></div>
</div>
<div class="subelement argument"> <div class="subelement argument">
<h4>$indexes</h4> <h4>$indexes</h4>
<code>array</code><p>// column => index pairs</p> <code>array</code><p>// column => index pairs</p></div>
</div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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>SQL to drop the specified table</h2> <h2>SQL to drop the specified table</h2>
<pre>delete_table(string $name) : string</pre> <pre>delete_table(string $name) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -171,9 +175,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

52
docs/classes/iDB_SQL.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method_column_list" title="column_list() :: Get information about the columns in the <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 class="description">Get information about the columns in the
@ -76,7 +81,7 @@ specified table</span><pre>column_list()</pre></a></li>
<div class="span8"> <div class="span8">
<a id="\iDB_SQL"></a><ul class="breadcrumb"> <a id="\iDB_SQL"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/iDB_SQL.html">iDB_SQL</a> <span class="divider">\</span><a href="../classes/iDB_SQL.html">iDB_SQL</a>
@ -97,21 +102,24 @@ specified table</span><pre>column_list()</pre></a></li>
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</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"> <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 <h2>Get information about the columns in the
specified table</h2> specified table</h2>
<pre>column_list($table) : string</pre> <pre>column_list(string $table) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
<h3>Parameters</h3> <h3>Parameters</h3>
<div class="subelement argument"><h4>$table</h4></div> <div class="subelement argument">
<h4>$table</h4>
<code>string</code>
</div>
<h3>Returns</h3> <h3>Returns</h3>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list other databases</h2>
<pre>db_list() : string</pre> <pre>db_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -121,7 +129,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Modify the query to get the query plan</h2>
<pre>explain(string $sql) : string</pre> <pre>explain(string $sql) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -136,7 +144,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list functions</h2>
<pre>function_list() : NULL</pre> <pre>function_list() : NULL</pre>
<div class="labels"></div> <div class="labels"></div>
@ -146,9 +154,9 @@ specified table</h2>
<div class="subelement response"><code>NULL</code></div> <div class="subelement response"><code>NULL</code></div>
</div></div> </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"> <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> <h2>Get database specific sql for limit clause</h2>
<pre>limit(string $sql, int $limit, int $offset) : string</pre> <pre>limit(string $sql, int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -173,7 +181,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list stored procedures</h2>
<pre>procedure_list() : string</pre> <pre>procedure_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -183,7 +191,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Get the sql for random ordering</h2>
<pre>random() : string</pre> <pre>random() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -197,7 +205,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list sequences</h2>
<pre>sequence_list() : string</pre> <pre>sequence_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -207,7 +215,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list system tables</h2>
<pre>system_table_list() : string</pre> <pre>system_table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -217,7 +225,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list tables</h2>
<pre>table_list() : string</pre> <pre>table_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -227,7 +235,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Returns sql to list triggers</h2>
<pre>trigger_list() : string</pre> <pre>trigger_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -237,7 +245,7 @@ specified table</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </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"> <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> <h2>Return sql to list database field types</h2>
<pre>type_list() : mixed</pre> <pre>type_list() : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
@ -247,7 +255,7 @@ specified table</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <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> <h2>Returns sql to list views</h2>
<pre>view_list() : string</pre> <pre>view_list() : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -263,9 +271,9 @@ specified table</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

192
docs/classes/iQuery_Builder.html
View File

@ -49,11 +49,16 @@
</div></noscript> </div></noscript>
<div class="row"> <div class="row">
<div class="span4"> <div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> <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> <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>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header"> <ul class="side-nav nav nav-list"><li class="nav-header">
<i class="icon-custom icon-method"></i> Methods <i title="Methods" class="icon-custom icon-method"></i> Methods
<ul> <ul>
<li class="method public "><a href="#method_count_all" title="count_all() :: Retreive the number of rows in the selected table"><span class="description">Retreive the number of rows in the selected table</span><pre>count_all()</pre></a></li> <li class="method public "><a href="#method_count_all" title="count_all() :: Retreive the number of rows in the selected table"><span class="description">Retreive the number of rows in the selected table</span><pre>count_all()</pre></a></li>
<li class="method public "><a href="#method_count_all_results" title="count_all_results() :: Retrieve the number of results for the generated query - used <li class="method public "><a href="#method_count_all_results" title="count_all_results() :: Retrieve the number of results for the generated query - used
@ -101,8 +106,11 @@ prefixed with 'OR NOT'</span><pre>or_not_group_start()</pre></a></li>
<li class="method public "><a href="#method_select_sum" title="select_sum() :: Selects the sum of a field from a query"><span class="description">Selects the sum of a field from a query</span><pre>select_sum()</pre></a></li> <li class="method public "><a href="#method_select_sum" title="select_sum() :: Selects the sum of a field from a query"><span class="description">Selects the sum of a field from a query</span><pre>select_sum()</pre></a></li>
<li class="method public "><a href="#method_set" title="set() :: Sets values for inserts / updates / deletes"><span class="description">Sets values for inserts / updates / deletes</span><pre>set()</pre></a></li> <li class="method public "><a href="#method_set" title="set() :: Sets values for inserts / updates / deletes"><span class="description">Sets values for inserts / updates / deletes</span><pre>set()</pre></a></li>
<li class="method public "><a href="#method_update" title="update() :: Creates an update clause, and executes it"><span class="description">Creates an update clause, and executes it</span><pre>update()</pre></a></li> <li class="method public "><a href="#method_update" title="update() :: Creates an update clause, and executes it"><span class="description">Creates an update clause, and executes it</span><pre>update()</pre></a></li>
<li class="method public "><a href="#method_where" title="where() :: "><span class="description">where() <li class="method public "><a href="#method_where" title="where() :: Specify condition(s) in the where clause of a query
</span><pre>where()</pre></a></li> Note: this function works with key / value, or a
passed array with key / value pairs"><span class="description">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</span><pre>where()</pre></a></li>
<li class="method public "><a href="#method_where_in" title="where_in() :: Where clause with 'IN' statement"><span class="description">Where clause with 'IN' statement</span><pre>where_in()</pre></a></li> <li class="method public "><a href="#method_where_in" title="where_in() :: Where clause with 'IN' statement"><span class="description">Where clause with 'IN' statement</span><pre>where_in()</pre></a></li>
<li class="method public "><a href="#method_where_not_in" title="where_not_in() :: WHERE NOT IN (FOO) clause"><span class="description">WHERE NOT IN (FOO) clause</span><pre>where_not_in()</pre></a></li> <li class="method public "><a href="#method_where_not_in" title="where_not_in() :: WHERE NOT IN (FOO) clause"><span class="description">WHERE NOT IN (FOO) clause</span><pre>where_not_in()</pre></a></li>
</ul> </ul>
@ -111,7 +119,7 @@ prefixed with 'OR NOT'</span><pre>or_not_group_start()</pre></a></li>
<div class="span8"> <div class="span8">
<a id="\iQuery_Builder"></a><ul class="breadcrumb"> <a id="\iQuery_Builder"></a><ul class="breadcrumb">
<li> <li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> <a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li> </li>
<li class="active"> <li class="active">
<span class="divider">\</span><a href="../classes/iQuery_Builder.html">iQuery_Builder</a> <span class="divider">\</span><a href="../classes/iQuery_Builder.html">iQuery_Builder</a>
@ -132,8 +140,8 @@ prefixed with 'OR NOT'</span><pre>or_not_group_start()</pre></a></li>
</tr> </tr>
</table> </table>
<h3> <h3>
<i class="icon-custom icon-method"></i> Methods</h3> <i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method_count_all"></a><div class="element clickable method public method_count_all" data-toggle="collapse" data-target=".method_count_all .collapse"> <a id="method_count_all"></a><div class="element clickable method public method_count_all" data-toggle="collapse" data-target=".method_count_all .collapse" title="public">
<h2>Retreive the number of rows in the selected table</h2> <h2>Retreive the number of rows in the selected table</h2>
<pre>count_all(string $table) : int</pre> <pre>count_all(string $table) : int</pre>
<div class="labels"></div> <div class="labels"></div>
@ -148,10 +156,10 @@ prefixed with 'OR NOT'</span><pre>or_not_group_start()</pre></a></li>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_count_all_results"></a><div class="element clickable method public method_count_all_results" data-toggle="collapse" data-target=".method_count_all_results .collapse"> <a id="method_count_all_results"></a><div class="element clickable method public method_count_all_results" data-toggle="collapse" data-target=".method_count_all_results .collapse" title="public">
<h2>Retrieve the number of results for the generated query - used <h2>Retrieve the number of results for the generated query - used
in place of the get() method</h2> in place of the get() method</h2>
<pre>count_all_results(string $table) : int</pre> <pre>count_all_results(string $table<code> = ''</code>) : int</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -164,9 +172,9 @@ in place of the get() method</h2>
<div class="subelement response"><code>int</code></div> <div class="subelement response"><code>int</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_delete"></a><div class="element clickable method public method_delete" data-toggle="collapse" data-target=".method_delete .collapse"> <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> <h2>Deletes data from a table</h2>
<pre>delete(string $table, mixed $where) : mixed</pre> <pre>delete(string $table, mixed $where<code> = ''</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -183,7 +191,7 @@ in place of the get() method</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <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> <h2>Adds the 'distinct' keyword to a query</h2>
<pre>distinct() : \iQuery_Builder</pre> <pre>distinct() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -197,7 +205,7 @@ in place of the get() method</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
<h2>Shows the query plan for the query</h2> <h2>Shows the query plan for the query</h2>
<pre>explain() : \iQuery_Builder</pre> <pre>explain() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -211,7 +219,7 @@ in place of the get() method</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Specify the database table to select from</h2>
<pre>from(string $tblname) : \iQuery_Builder</pre> <pre>from(string $tblname) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -230,10 +238,10 @@ in place of the get() method</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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 <h2>Select and retrieve all records from the current table, and/or
execute current compiled query</h2> execute current compiled query</h2>
<pre>get(mixed $table, int $limit, int $offset) : object</pre> <pre>get(mixed $table<code> = ''</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : object</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -251,9 +259,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>object</code></div> <div class="subelement response"><code>object</code></div>
</div></div> </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"> <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">
<h2>Returns the generated 'delete' sql query</h2> <h2>Returns the generated 'delete' sql query</h2>
<pre>get_compiled_delete(string $table, bool $reset) : string</pre> <pre>get_compiled_delete(string $table<code> = ""</code>, bool $reset<code> = TRUE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -270,9 +278,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_compiled_insert"></a><div class="element clickable method public method_get_compiled_insert" data-toggle="collapse" data-target=".method_get_compiled_insert .collapse"> <a id="method_get_compiled_insert"></a><div class="element clickable method public method_get_compiled_insert" data-toggle="collapse" data-target=".method_get_compiled_insert .collapse" title="public">
<h2>Returns the generated 'insert' sql query</h2> <h2>Returns the generated 'insert' sql query</h2>
<pre>get_compiled_insert(string $table, bool $reset) : string</pre> <pre>get_compiled_insert(string $table, bool $reset<code> = TRUE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -289,9 +297,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_compiled_select"></a><div class="element clickable method public method_get_compiled_select" data-toggle="collapse" data-target=".method_get_compiled_select .collapse"> <a id="method_get_compiled_select"></a><div class="element clickable method public method_get_compiled_select" data-toggle="collapse" data-target=".method_get_compiled_select .collapse" title="public">
<h2>Returns the generated 'select' sql query</h2> <h2>Returns the generated 'select' sql query</h2>
<pre>get_compiled_select(string $table, bool $reset) : string</pre> <pre>get_compiled_select(string $table<code> = ''</code>, bool $reset<code> = TRUE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -308,9 +316,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="method_get_compiled_update"></a><div class="element clickable method public method_get_compiled_update" data-toggle="collapse" data-target=".method_get_compiled_update .collapse"> <a id="method_get_compiled_update"></a><div class="element clickable method public method_get_compiled_update" data-toggle="collapse" data-target=".method_get_compiled_update .collapse" title="public">
<h2>Returns the generated 'update' sql query</h2> <h2>Returns the generated 'update' sql query</h2>
<pre>get_compiled_update(string $table, bool $reset) : string</pre> <pre>get_compiled_update(string $table<code> = ''</code>, bool $reset<code> = TRUE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -327,9 +335,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </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"> <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> <h2>Convience method for get() with a where clause</h2>
<pre>get_where(string $table, array $where, int $limit, int $offset) : object</pre> <pre>get_where(string $table, array $where<code> = array()</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : object</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -354,7 +362,7 @@ execute current compiled query</h2>
<div class="subelement response"><code>object</code></div> <div class="subelement response"><code>object</code></div>
</div></div> </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"> <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> <h2>Group the results by the selected field(s)</h2>
<pre>group_by(mixed $field) : \iQuery_Builder</pre> <pre>group_by(mixed $field) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -373,7 +381,7 @@ execute current compiled query</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Ends a query group</h2>
<pre>group_end() : \iQuery_Builder</pre> <pre>group_end() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -387,7 +395,7 @@ execute current compiled query</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Adds a paren to the current query for query grouping</h2>
<pre>group_start() : \iQuery_Builder</pre> <pre>group_start() : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -401,9 +409,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Generates a 'Having' clause</h2>
<pre>having(mixed $key, mixed $val) : \iQuery_Builder</pre> <pre>having(mixed $key, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -424,9 +432,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Creates an insert clause, and executes it</h2>
<pre>insert(string $table, mixed $data) : mixed</pre> <pre>insert(string $table, mixed $data<code> = array()</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -443,9 +451,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <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> <h2>Creates a join phrase in a compiled query</h2>
<pre>join(string $table, string $condition, string $type) : \iQuery_Builder</pre> <pre>join(string $table, string $condition, string $type<code> = ''</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -470,9 +478,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Creates a Like clause in the sql statement</h2>
<pre>like(string $field, mixed $val, string $pos) : \iQuery_Builder</pre> <pre>like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -497,9 +505,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse" title="public">
<h2>Set a limit on the current sql statement</h2> <h2>Set a limit on the current sql statement</h2>
<pre>limit(int $limit, int $offset) : string</pre> <pre>limit(int $limit, int $offset<code> = FALSE</code>) : string</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -516,9 +524,9 @@ execute current compiled query</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </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"> <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> <h2>Generates a NOT LIKE clause</h2>
<pre>not_like(string $field, mixed $val, string $pos) : \iQuery_Builder</pre> <pre>not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -543,7 +551,7 @@ execute current compiled query</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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, <h2>Adds a paren to the current query for query grouping,
prefixed with 'OR'</h2> prefixed with 'OR'</h2>
<pre>or_group_start() : \iQuery_Builder</pre> <pre>or_group_start() : \iQuery_Builder</pre>
@ -558,9 +566,9 @@ prefixed with 'OR'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Generates a 'Having' clause prefixed with 'OR'</h2>
<pre>or_having(mixed $key, mixed $val) : \iQuery_Builder</pre> <pre>or_having(mixed $key, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -581,9 +589,9 @@ prefixed with 'OR'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Generates an OR Like clause</h2>
<pre>or_like(string $field, mixed $val, string $pos) : \iQuery_Builder</pre> <pre>or_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -608,7 +616,7 @@ prefixed with 'OR'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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, <h2>Adds a paren to the current query for query grouping,
prefixed with 'OR NOT'</h2> prefixed with 'OR NOT'</h2>
<pre>or_not_group_start() : \iQuery_Builder</pre> <pre>or_not_group_start() : \iQuery_Builder</pre>
@ -623,9 +631,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Generates a OR NOT LIKE clause</h2>
<pre>or_not_like(string $field, mixed $val, string $pos) : \iQuery_Builder</pre> <pre>or_not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -650,9 +658,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Where clause prefixed with "OR"</h2>
<pre>or_where(string $key, mixed $val) : \iQuery_Builder</pre> <pre>or_where(string $key, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -673,9 +681,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Where in statement prefixed with "or"</h2>
<pre>or_where_in(string $field, mixed $val) : \iQuery_Builder</pre> <pre>or_where_in(string $field, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -696,9 +704,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>OR WHERE NOT IN (FOO) clause</h2>
<pre>or_where_not_in(string $field, mixed $val) : \iQuery_Builder</pre> <pre>or_where_not_in(string $field, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -719,9 +727,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Order the results by the selected field(s)</h2>
<pre>order_by(string $field, string $type) : \iQuery_Builder</pre> <pre>order_by(string $field, string $type<code> = ""</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -742,13 +750,13 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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">
<h2>Clear out the class variables, so the next query can be run</h2> <h2>Clear out the class variables, so the next query can be run</h2>
<pre>reset_query() : void</pre> <pre>reset_query() : void</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="method_select"></a><div class="element clickable method public method_select" data-toggle="collapse" data-target=".method_select .collapse"> <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> <h2>Specifies rows to select in a query</h2>
<pre>select(string $fields) : \iQuery_Builder</pre> <pre>select(string $fields) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
@ -767,9 +775,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Selects the average value of a field from a query</h2>
<pre>select_avg(string $field, string $as) : \iQuery_Builder</pre> <pre>select_avg(string $field, string $as<code> = FALSE</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -790,9 +798,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Selects the maximum value of a field from a query</h2>
<pre>select_max(string $field, string $as) : \iQuery_Builder</pre> <pre>select_max(string $field, string $as<code> = FALSE</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -813,9 +821,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Selects the minimum value of a field from a query</h2>
<pre>select_min(string $field, string $as) : \iQuery_Builder</pre> <pre>select_min(string $field, string $as<code> = FALSE</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -836,9 +844,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Selects the sum of a field from a query</h2>
<pre>select_sum(string $field, string $as) : \iQuery_Builder</pre> <pre>select_sum(string $field, string $as<code> = FALSE</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -859,9 +867,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Sets values for inserts / updates / deletes</h2>
<pre>set(mixed $key, mixed $val) : \iQuery_Builder</pre> <pre>set(mixed $key, mixed $val<code> = NULL</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -882,9 +890,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Creates an update clause, and executes it</h2>
<pre>update(string $table, mixed $data) : mixed</pre> <pre>update(string $table, mixed $data<code> = array()</code>) : mixed</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -901,22 +909,38 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>mixed</code></div> <div class="subelement response"><code>mixed</code></div>
</div></div> </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"> <a id="method_where"></a><div class="element clickable method public method_where" data-toggle="collapse" data-target=".method_where .collapse" title="public">
<h2>where() <h2>Specify condition(s) in the where clause of a query
</h2> Note: this function works with key / value, or a
<pre>where($key, $val, $escape) </pre> passed array with key / value pairs</h2>
<pre>where(mixed $key, mixed $val<code> = array()</code>, bool $escape<code> = NULL</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <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> <h3>Parameters</h3>
<div class="subelement argument"><h4>$key</h4></div> <div class="subelement argument">
<div class="subelement argument"><h4>$val</h4></div> <h4>$key</h4>
<div class="subelement argument"><h4>$escape</h4></div> <code>mixed</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code>mixed</code>
</div>
<div class="subelement argument">
<h4>$escape</h4>
<code>bool</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>Where clause with 'IN' statement</h2>
<pre>where_in(mixed $field, mixed $val) : \iQuery_Builder</pre> <pre>where_in(mixed $field, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -937,9 +961,9 @@ prefixed with 'OR NOT'</h2>
<div class="subelement response"><code>\iQuery_Builder</code></div> <div class="subelement response"><code>\iQuery_Builder</code></div>
</div></div> </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"> <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> <h2>WHERE NOT IN (FOO) clause</h2>
<pre>where_not_in(string $field, mixed $val) : \iQuery_Builder</pre> <pre>where_not_in(string $field, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -966,9 +990,9 @@ prefixed with 'OR NOT'</h2>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

16
docs/css/template.css
View File

@ -340,12 +340,6 @@ i.icon-custom
display: none; display: none;
} }
.btn-group.view
{
margin-left: 20px;
margin-bottom: 20px;
}
.visibility button .visibility button
{ {
height: 24px; height: 24px;
@ -437,6 +431,14 @@ div.labels
font-size: 13px; font-size: 13px;
} }
.nav-list .nav-header .side-nav-header
{
font-weight: bold;
line-height: 18px;
color: #999999;
text-transform: uppercase;
}
.detail-description code { .detail-description code {
white-space: pre; white-space: pre;
display: inline-block; display: inline-block;
@ -501,7 +503,7 @@ div.labels
{ {
font-size: 0.80em; font-size: 0.80em;
margin-bottom: 7px; margin-bottom: 7px;
display: block; display: inline-block;
float: right; float: right;
} }
} }

4
docs/deprecated.html
View File

@ -64,9 +64,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

4
docs/errors.html
View File

@ -91,9 +91,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

4
docs/graph_class.html
View File

@ -61,9 +61,9 @@
}); });
</script><div class="row"><footer class="span12"> </script><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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

20
docs/js/template.js
View File

@ -17,7 +17,7 @@ function initializeContents()
// do a background color change on hover to emphasize the clickability eveb more // do a background color change on hover to emphasize the clickability eveb more
// we do not use CSS for this because when JS is disabled this behaviour does not // we do not use CSS for this because when JS is disabled this behaviour does not
// apply and we do not want the hover // apply and we do not want the hover
$(".element.method,.element.function,.element.class.clickable,.element.interface.clickable") $(".element.method,.element.function,.element.class.clickable,.element.interface.clickable,.element.property.clickable")
.css("cursor", "pointer") .css("cursor", "pointer")
.hover(function() { .hover(function() {
$(this).css('backgroundColor', '#F8FDF6') $(this).css('backgroundColor', '#F8FDF6')
@ -25,14 +25,23 @@ function initializeContents()
$(this).css('backgroundColor', 'white')} $(this).css('backgroundColor', 'white')}
); );
$("ul.side-nav.nav.nav-list li.nav-header").contents()
.filter(function(){return this.nodeType == 3 && $.trim($(this).text()).length > 0})
.wrap('<span class="side-nav-header" />');
$("ul.side-nav.nav.nav-list li.nav-header span.side-nav-header")
.css("cursor", "pointer");
// do not show tooltips on iPad; it will cause the user having to click twice // do not show tooltips on iPad; it will cause the user having to click twice
if (!$.browser.ipad) { if (!$.browser.ipad) {
$('.btn-group.visibility,.btn-group.view,.btn-group.type-filter') $('.btn-group.visibility,.btn-group.view,.btn-group.type-filter,.icon-custom')
.tooltip({'placement':'bottom'}); .tooltip({'placement':'bottom'});
$('.element').tooltip({'placement':'left'});
} }
$('.btn-group.visibility,.btn-group.view,.btn-group.type-filter') $('.btn-group.visibility,.btn-group.view,.btn-group.type-filter')
.show() .show()
.css('display', 'inline-block')
.find('button') .find('button')
.find('i').click(function(){ $(this).parent().click(); }); .find('i').click(function(){ $(this).parent().click(); });
@ -64,13 +73,14 @@ function initializeContents()
$('.side-nav li.view-simple').removeClass('view-simple'); $('.side-nav li.view-simple').removeClass('view-simple');
}).button('toggle').click(); }).button('toggle').click();
$('.view button.details').click(function(){
$('.side-nav li.view-simple').removeClass('view-simple');
}).button('toggle').click();
$('.view button.simple').click(function(){ $('.view button.simple').click(function(){
$('.side-nav li').addClass('view-simple'); $('.side-nav li').addClass('view-simple');
}); });
$('ul.side-nav.nav.nav-list li.nav-header span.side-nav-header').click(function(){
$(this).siblings('ul').collapse('toggle');
});
// sorting example // sorting example
// $('ol li').sort( // $('ol li').sort(
// function(a, b) { return a.innerHTML.toLowerCase() > b.innerHTML.toLowerCase() ? 1 : -1; } // function(a, b) { return a.innerHTML.toLowerCase() > b.innerHTML.toLowerCase() ? 1 : -1; }

4
docs/markers.html
View File

@ -100,9 +100,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

18
docs/namespaces/global.html
View File

@ -59,7 +59,7 @@
<span class="empty-namespace"><i class="icon-stop"></i>global</span><ul class="nav nav-list nav-namespaces"></ul> <span class="empty-namespace"><i class="icon-stop"></i>global</span><ul class="nav nav-list nav-namespaces"></ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-function"></i> Functions</li> <i title="Functions" class="icon-custom icon-function"></i> Functions</li>
<li class="function "><a href="#function_Query" title="Query() :: Connection function"><span class="description">Connection function</span><pre>Query</pre></a></li> <li class="function "><a href="#function_Query" title="Query() :: Connection function"><span class="description">Connection function</span><pre>Query</pre></a></li>
<li class="function "><a href="#function_db_filter" title="db_filter() :: Filter out db rows into one array"><span class="description">Filter out db rows into one array</span><pre>db_filter</pre></a></li> <li class="function "><a href="#function_db_filter" title="db_filter() :: Filter out db rows into one array"><span class="description">Filter out db rows into one array</span><pre>db_filter</pre></a></li>
<li class="function "><a href="#function_do_include" title="do_include() :: Bulk directory loading workaround for use <li class="function "><a href="#function_do_include" title="do_include() :: Bulk directory loading workaround for use
@ -68,11 +68,11 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<li class="function "><a href="#function_mb_trim" title="mb_trim() :: Multibyte-safe trim function"><span class="description">Multibyte-safe trim function</span><pre>mb_trim</pre></a></li> <li class="function "><a href="#function_mb_trim" title="mb_trim() :: Multibyte-safe trim function"><span class="description">Multibyte-safe trim function</span><pre>mb_trim</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="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"> <li class="nav-header">
<i class="icon-custom icon-interface"></i> Interfaces</li> <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="#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="#iQuery_Builder" title="Interface defining the Query Builder class">iQuery_Builder</a></li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-class"></i> Classes</li> <i title="Classes" class="icon-custom icon-class"></i> Classes</li>
<li><a href="#DB_PDO" title="Base Database class">DB_PDO</a></li> <li><a href="#DB_PDO" title="Base Database class">DB_PDO</a></li>
<li><a href="#DB_Util" title="Abstract class defining database / table creation methods">DB_Util</a></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="#Query_Parser" title="Utility Class to parse sql clauses for properly escaping identifiers">Query_Parser</a></li>
@ -82,12 +82,12 @@ instantiates the specific db driver">Query_Builder</a></li>
<li><a href="#ODBC" title="ODBC Database Driver">ODBC</a></li> <li><a href="#ODBC" title="ODBC Database Driver">ODBC</a></li>
<li><a href="#ODBC_Util" title="ODBC-specific backup, import and creation methods">ODBC_Util</a></li> <li><a href="#ODBC_Util" title="ODBC-specific backup, import and creation methods">ODBC_Util</a></li>
<li><a href="#SQLite_SQL" title="SQLite Specific SQL">SQLite_SQL</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="#SQLite" title="SQLite specific class">SQLite</a></li> <li><a href="#SQLite" title="SQLite specific class">SQLite</a></li>
<li><a href="#Firebird_Util" title="Firebird-specific backup, import and creation methods">Firebird_Util</a></li> <li><a href="#SQLite_Util" title="SQLite-specific backup, import and creation methods">SQLite_Util</a></li>
<li><a href="#Firebird_SQL" title="Firebird Specific SQL">Firebird_SQL</a></li>
<li><a href="#Firebird_Result" title="Firebird result class to emulate PDOStatement Class - only implements <li><a href="#Firebird_Result" title="Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods">Firebird_Result</a></li> data-fetching methods">Firebird_Result</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" title="Firebird Database class">Firebird</a></li> <li><a href="#Firebird" title="Firebird Database class">Firebird</a></li>
<li><a href="#PgSQL" title="PostgreSQL specifc class">PgSQL</a></li> <li><a href="#PgSQL" title="PostgreSQL specifc class">PgSQL</a></li>
<li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li> <li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li>
@ -98,7 +98,7 @@ data-fetching methods">Firebird_Result</a></li>
<li><a href="#BadDBDriverException" title="Generic exception for bad drivers">BadDBDriverException</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="#BadConnectionException" title="Generic exception for bad connection strings">BadConnectionException</a></li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li> <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> <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>
<li class="constant "><a href="#constant_QDRIVER_PATH" title="QDRIVER_PATH() :: Path to driver classes"><span class="description">Path to driver classes</span><pre>QDRIVER_PATH</pre></a></li> <li class="constant "><a href="#constant_QDRIVER_PATH" title="QDRIVER_PATH() :: Path to driver classes"><span class="description">Path to driver classes</span><pre>QDRIVER_PATH</pre></a></li>
</ul> </ul>
@ -107,9 +107,9 @@ data-fetching methods">Firebird_Result</a></li>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

4
docs/packages/Default.html
View File

@ -64,9 +64,9 @@
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

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

@ -59,17 +59,17 @@
<a href="../packages/Query.Drivers.html" title="Drivers"><i class="icon-folder-open"></i>Drivers</a><ul class="nav nav-list nav-packages"></ul> <a href="../packages/Query.Drivers.html" title="Drivers"><i class="icon-folder-open"></i>Drivers</a><ul class="nav nav-list nav-packages"></ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-class"></i> Classes</li> <i title="Classes" class="icon-custom icon-class"></i> Classes</li>
<li><a href="#ODBC_SQL" title="ODBC SQL Class">ODBC_SQL</a></li> <li><a href="#ODBC_SQL" title="ODBC SQL Class">ODBC_SQL</a></li>
<li><a href="#ODBC" title="ODBC Database Driver">ODBC</a></li> <li><a href="#ODBC" title="ODBC Database Driver">ODBC</a></li>
<li><a href="#ODBC_Util" title="ODBC-specific backup, import and creation methods">ODBC_Util</a></li> <li><a href="#ODBC_Util" title="ODBC-specific backup, import and creation methods">ODBC_Util</a></li>
<li><a href="#SQLite_SQL" title="SQLite Specific SQL">SQLite_SQL</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="#SQLite" title="SQLite specific class">SQLite</a></li> <li><a href="#SQLite" title="SQLite specific class">SQLite</a></li>
<li><a href="#Firebird_Util" title="Firebird-specific backup, import and creation methods">Firebird_Util</a></li> <li><a href="#SQLite_Util" title="SQLite-specific backup, import and creation methods">SQLite_Util</a></li>
<li><a href="#Firebird_SQL" title="Firebird Specific SQL">Firebird_SQL</a></li>
<li><a href="#Firebird_Result" title="Firebird result class to emulate PDOStatement Class - only implements <li><a href="#Firebird_Result" title="Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods">Firebird_Result</a></li> data-fetching methods">Firebird_Result</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" title="Firebird Database class">Firebird</a></li> <li><a href="#Firebird" title="Firebird Database class">Firebird</a></li>
<li><a href="#PgSQL" title="PostgreSQL specifc class">PgSQL</a></li> <li><a href="#PgSQL" title="PostgreSQL specifc class">PgSQL</a></li>
<li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li> <li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li>
@ -88,7 +88,7 @@ data-fetching methods">Firebird_Result</a></li>
</li></ul> </li></ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3> <i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
<div id="Firebird" class="element ajax clickable class"> <div id="Firebird" class="element ajax clickable class">
<h1>Firebird<a href="../classes/Firebird.html"></a> <h1>Firebird<a href="../classes/Firebird.html"></a>
</h1> </h1>
@ -207,9 +207,9 @@ data-fetching methods</p>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

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

@ -59,11 +59,11 @@
<a href="../packages/Query.Query.html" title="Query"><i class="icon-folder-open"></i>Query</a><ul class="nav nav-list nav-packages"></ul> <a href="../packages/Query.Query.html" title="Query"><i class="icon-folder-open"></i>Query</a><ul class="nav nav-list nav-packages"></ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-interface"></i> Interfaces</li> <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="#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="#iQuery_Builder" title="Interface defining the Query Builder class">iQuery_Builder</a></li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-class"></i> Classes</li> <i title="Classes" class="icon-custom icon-class"></i> Classes</li>
<li><a href="#DB_PDO" title="Base Database class">DB_PDO</a></li> <li><a href="#DB_PDO" title="Base Database class">DB_PDO</a></li>
<li><a href="#DB_Util" title="Abstract class defining database / table creation methods">DB_Util</a></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="#Query_Parser" title="Utility Class to parse sql clauses for properly escaping identifiers">Query_Parser</a></li>
@ -82,7 +82,7 @@ instantiates the specific db driver">Query_Builder</a></li>
</li></ul> </li></ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3> <i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
<div id="iDB_SQL" class="element ajax clickable interface"> <div id="iDB_SQL" class="element ajax clickable interface">
<h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a> <h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a>
</h1> </h1>
@ -145,9 +145,9 @@ instantiates the specific db driver</p>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

36
docs/packages/Query.html
View File

@ -66,7 +66,7 @@
</ul> </ul>
</li> </li>
<li class="nav-header"> <li class="nav-header">
<i class="icon-custom icon-function"></i> Functions</li> <i title="Functions" class="icon-custom icon-function"></i> Functions</li>
<li class="function "><a href="#function_Query" title="Query() :: Connection function"><span class="description">Connection function</span><pre>Query</pre></a></li> <li class="function "><a href="#function_Query" title="Query() :: Connection function"><span class="description">Connection function</span><pre>Query</pre></a></li>
<li class="function "><a href="#function_db_filter" title="db_filter() :: Filter out db rows into one array"><span class="description">Filter out db rows into one array</span><pre>db_filter</pre></a></li> <li class="function "><a href="#function_db_filter" title="db_filter() :: Filter out db rows into one array"><span class="description">Filter out db rows into one array</span><pre>db_filter</pre></a></li>
<li class="function "><a href="#function_do_include" title="do_include() :: Bulk directory loading workaround for use <li class="function "><a href="#function_do_include" title="do_include() :: Bulk directory loading workaround for use
@ -75,7 +75,7 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<li class="function "><a href="#function_mb_trim" title="mb_trim() :: Multibyte-safe trim function"><span class="description">Multibyte-safe trim function</span><pre>mb_trim</pre></a></li> <li class="function "><a href="#function_mb_trim" title="mb_trim() :: Multibyte-safe trim function"><span class="description">Multibyte-safe trim function</span><pre>mb_trim</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="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"> <li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li> <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> <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>
<li class="constant "><a href="#constant_QDRIVER_PATH" title="QDRIVER_PATH() :: Path to driver classes"><span class="description">Path to driver classes</span><pre>QDRIVER_PATH</pre></a></li> <li class="constant "><a href="#constant_QDRIVER_PATH" title="QDRIVER_PATH() :: Path to driver classes"><span class="description">Path to driver classes</span><pre>QDRIVER_PATH</pre></a></li>
</ul> </ul>
@ -86,10 +86,10 @@ with array_map and glob</span><pre>do_include</pre></a></li>
</li></ul> </li></ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-function"></i> Functions</h3> <i title="Functions" class="icon-custom icon-function"></i> Functions</h3>
<a id="function_Query"></a><div class="element clickable function function_Query" data-toggle="collapse" data-target=".function_Query .collapse"> <a id="function_Query"></a><div class="element clickable function function_Query" data-toggle="collapse" data-target=".function_Query .collapse" title="">
<h2>Connection function</h2> <h2>Connection function</h2>
<pre>Query(mixed $params) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre> <pre>Query(mixed $params<code> = ''</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"> <div class="row collapse"><div class="detail-description">
<div class="long_description"></div> <div class="long_description"></div>
@ -117,7 +117,7 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div> <div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
</div></div> </div></div>
</div> </div>
<a id="function_db_filter"></a><div class="element clickable function function_db_filter" data-toggle="collapse" data-target=".function_db_filter .collapse"> <a id="function_db_filter"></a><div class="element clickable function function_db_filter" data-toggle="collapse" data-target=".function_db_filter .collapse" title="">
<h2>Filter out db rows into one array</h2> <h2>Filter out db rows into one array</h2>
<pre>db_filter(array $array, mixed $index) : array</pre> <pre>db_filter(array $array, mixed $index) : array</pre>
<div class="labels"></div> <div class="labels"></div>
@ -136,7 +136,7 @@ with array_map and glob</span><pre>do_include</pre></a></li>
<div class="subelement response"><code>array</code></div> <div class="subelement response"><code>array</code></div>
</div></div> </div></div>
</div> </div>
<a id="function_do_include"></a><div class="element clickable function function_do_include" data-toggle="collapse" data-target=".function_do_include .collapse"> <a id="function_do_include"></a><div class="element clickable function function_do_include" data-toggle="collapse" data-target=".function_do_include .collapse" title="">
<h2>Bulk directory loading workaround for use <h2>Bulk directory loading workaround for use
with array_map and glob</h2> with array_map and glob</h2>
<pre>do_include(string $path) : void</pre> <pre>do_include(string $path) : void</pre>
@ -150,7 +150,7 @@ with array_map and glob</h2>
</div> </div>
</div></div> </div></div>
</div> </div>
<a id="function_mb_trim"></a><div class="element clickable function function_mb_trim" data-toggle="collapse" data-target=".function_mb_trim .collapse"> <a id="function_mb_trim"></a><div class="element clickable function function_mb_trim" data-toggle="collapse" data-target=".function_mb_trim .collapse" title="">
<h2>Multibyte-safe trim function</h2> <h2>Multibyte-safe trim function</h2>
<pre>mb_trim(string $string) : string</pre> <pre>mb_trim(string $string) : string</pre>
<div class="labels"></div> <div class="labels"></div>
@ -165,7 +165,7 @@ with array_map and glob</h2>
<div class="subelement response"><code>string</code></div> <div class="subelement response"><code>string</code></div>
</div></div> </div></div>
</div> </div>
<a id="function_query_autoload"></a><div class="element clickable function function_query_autoload" data-toggle="collapse" data-target=".function_query_autoload .collapse"> <a id="function_query_autoload"></a><div class="element clickable function function_query_autoload" data-toggle="collapse" data-target=".function_query_autoload .collapse" title="">
<h2>Load query classes</h2> <h2>Load query classes</h2>
<pre>query_autoload(string $class) </pre> <pre>query_autoload(string $class) </pre>
<div class="labels"></div> <div class="labels"></div>
@ -179,16 +179,16 @@ with array_map and glob</h2>
</div></div> </div></div>
</div> </div>
<h3> <h3>
<i class="icon-custom icon-constant"></i> Constants</h3> <i title="Constants" class="icon-custom icon-constant"></i> Constants</h3>
<a id="constant_QBASE_PATH"> </a><div class="element clickable constant constant_QBASE_PATH" data-toggle="collapse" data-target=".constant_QBASE_PATH .collapse"> <a id="constant_QBASE_PATH"> </a><div class="element clickable constant constant_QBASE_PATH" data-toggle="collapse" data-target=".constant_QBASE_PATH .collapse" title="">
<h2>Reference to root path</h2> <h2>Reference to root path</h2>
<pre>QBASE_PATH </pre> <pre>QBASE_PATH = dirname(__FILE__) . '/' </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
<a id="constant_QDRIVER_PATH"> </a><div class="element clickable constant constant_QDRIVER_PATH" data-toggle="collapse" data-target=".constant_QDRIVER_PATH .collapse"> <a id="constant_QDRIVER_PATH"> </a><div class="element clickable constant constant_QDRIVER_PATH" data-toggle="collapse" data-target=".constant_QDRIVER_PATH .collapse" title="">
<h2>Path to driver classes</h2> <h2>Path to driver classes</h2>
<pre>QDRIVER_PATH </pre> <pre>QDRIVER_PATH = QBASE_PATH . 'drivers/' </pre>
<div class="labels"></div> <div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div> <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div> </div>
@ -200,7 +200,7 @@ with array_map and glob</h2>
</li></ul> </li></ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3> <i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
<div id="Firebird" class="element ajax clickable class"> <div id="Firebird" class="element ajax clickable class">
<h1>Firebird<a href="../classes/Firebird.html"></a> <h1>Firebird<a href="../classes/Firebird.html"></a>
</h1> </h1>
@ -323,7 +323,7 @@ data-fetching methods</p>
</li></ul> </li></ul>
<div class="package-indent"> <div class="package-indent">
<h3> <h3>
<i class="icon-custom icon-class"></i> Classes and interfaces</h3> <i title="Classes" class="icon-custom icon-class"></i> Classes and interfaces</h3>
<div id="iDB_SQL" class="element ajax clickable interface"> <div id="iDB_SQL" class="element ajax clickable interface">
<h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a> <h1>iDB_SQL<a href="../classes/iDB_SQL.html"></a>
</h1> </h1>
@ -387,9 +387,9 @@ instantiates the specific db driver</p>
</div> </div>
<div class="row"><footer class="span12"> <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> 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.1.0 Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br> </a> and<br>
generated on 2014-02-12T19:09:30-05:00.<br></footer></div> generated on 2014-02-18T15:15:22-05:00.<br></footer></div>
</div> </div>
</body> </body>
</html> </html>

2794
docs/structure.xml
View File

File diff suppressed because one or more lines are too long