Remove query docs from generated documentation
This commit is contained in:
parent
67fc68c904
commit
7751d1d7aa
405
docs/classes.svg
405
docs/classes.svg
@ -4,399 +4,152 @@
|
||||
<!-- Generated by graphviz version 2.26.3 (20100126.1600)
|
||||
-->
|
||||
<!-- Title: G Pages: 1 -->
|
||||
<svg width="874pt" height="1300pt"
|
||||
viewBox="0.00 0.00 874.00 1300.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<g id="graph1" class="graph" transform="scale(1 1) rotate(0) translate(4 1296)">
|
||||
<svg width="854pt" height="328pt"
|
||||
viewBox="0.00 0.00 854.00 328.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<g id="graph1" class="graph" transform="scale(1 1) rotate(0) translate(4 324)">
|
||||
<title>G</title>
|
||||
<polygon fill="white" stroke="white" points="-4,5 -4,-1296 871,-1296 871,5 -4,5"/>
|
||||
<polygon fill="white" stroke="white" points="-4,5 -4,-324 851,-324 851,5 -4,5"/>
|
||||
<g id="graph2" class="cluster"><title>cluster_default</title>
|
||||
<polyline fill="none" stroke="none" points="218,-44 846,-44 "/>
|
||||
<path fill="none" stroke="none" d="M846,-44C852,-44 858,-50 858,-56"/>
|
||||
<polyline fill="none" stroke="none" points="858,-56 858,-1272 "/>
|
||||
<path fill="none" stroke="none" d="M858,-1272C858,-1278 852,-1284 846,-1284"/>
|
||||
<polyline fill="none" stroke="none" points="846,-1284 218,-1284 "/>
|
||||
<path fill="none" stroke="none" d="M218,-1284C212,-1284 206,-1278 206,-1272"/>
|
||||
<polyline fill="none" stroke="none" points="206,-1272 206,-56 "/>
|
||||
<polyline fill="none" stroke="none" points="218,-44 826,-44 "/>
|
||||
<path fill="none" stroke="none" d="M826,-44C832,-44 838,-50 838,-56"/>
|
||||
<polyline fill="none" stroke="none" points="838,-56 838,-300 "/>
|
||||
<path fill="none" stroke="none" d="M838,-300C838,-306 832,-312 826,-312"/>
|
||||
<polyline fill="none" stroke="none" points="826,-312 218,-312 "/>
|
||||
<path fill="none" stroke="none" d="M218,-312C212,-312 206,-306 206,-300"/>
|
||||
<polyline fill="none" stroke="none" points="206,-300 206,-56 "/>
|
||||
<path fill="none" stroke="none" d="M206,-56C206,-50 212,-44 218,-44"/>
|
||||
</g>
|
||||
<!-- \\DB_Reg -->
|
||||
<g id="node2" class="node"><title>\\DB_Reg</title>
|
||||
<a xlink:href="sys.db.classes.db_reg.html" xlink:title="DB_Reg" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="819,-1276 763,-1276 763,-1240 819,-1240 819,-1276"/>
|
||||
<text text-anchor="middle" x="791" y="-1254.6" font-family="Courier,monospace" font-size="11.00">DB_Reg</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Settings -->
|
||||
<g id="node3" class="node"><title>\\Settings</title>
|
||||
<a xlink:href="sys.db.classes.settings.html" xlink:title="Settings" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="826,-1222 756,-1222 756,-1186 826,-1186 826,-1222"/>
|
||||
<text text-anchor="middle" x="791" y="-1200.6" font-family="Courier,monospace" font-size="11.00">Settings</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\DB_SQL -->
|
||||
<g id="node4" class="node"><title>\\DB_SQL</title>
|
||||
<a xlink:href="sys.db.classes.db_sql.html" xlink:title="«abstract»<br/>DB_SQL" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="617,-790 533,-790 533,-754 617,-754 617,-790"/>
|
||||
<text text-anchor="start" x="541" y="-777.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
|
||||
<text text-anchor="start" x="554.5" y="-764.233" font-family="Courier,monospace" font-size="11.00">DB_SQL</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\DB_PDO -->
|
||||
<g id="node5" class="node"><title>\\DB_PDO</title>
|
||||
<a xlink:href="sys.db.classes.db_pdo.html" xlink:title="«abstract»<br/>DB_PDO" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="617,-331 533,-331 533,-295 617,-295 617,-331"/>
|
||||
<text text-anchor="start" x="541" y="-318.433" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
|
||||
<text text-anchor="start" x="554.5" y="-305.233" font-family="Courier,monospace" font-size="11.00">DB_PDO</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\PDO -->
|
||||
<g id="node36" class="node"><title>\\PDO</title>
|
||||
<ellipse fill="none" stroke="black" cx="379" cy="-18" rx="35.0527" ry="18"/>
|
||||
<text text-anchor="middle" x="379" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDO</text>
|
||||
</g>
|
||||
<!-- \\DB_PDO->\\PDO -->
|
||||
<g id="edge3" class="edge"><title>\\DB_PDO->\\PDO</title>
|
||||
<path fill="none" stroke="black" d="M532.258,-310.559C517.202,-307.657 501.246,-301.956 490,-291 406.874,-210.014 489.911,-131.09 418,-40 416.907,-38.6157 415.702,-37.304 414.412,-36.0628"/>
|
||||
<polygon fill="none" stroke="black" points="416.337,-33.1243 406.306,-29.7123 412.02,-38.6346 416.337,-33.1243"/>
|
||||
</g>
|
||||
<!-- \\Query_Builder -->
|
||||
<g id="node6" class="node"><title>\\Query_Builder</title>
|
||||
<a xlink:href="sys.db.classes.query_builder.html" xlink:title="Query_Builder" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="627,-574 523,-574 523,-538 627,-538 627,-574"/>
|
||||
<text text-anchor="middle" x="575" y="-552.6" font-family="Courier,monospace" font-size="11.00">Query_Builder</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\DB_Util -->
|
||||
<g id="node7" class="node"><title>\\DB_Util</title>
|
||||
<a xlink:href="sys.db.classes.db_util.html" xlink:title="«abstract»<br/>DB_Util" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="617,-1060 533,-1060 533,-1024 617,-1024 617,-1060"/>
|
||||
<text text-anchor="start" x="541" y="-1047.43" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
|
||||
<text text-anchor="start" x="551" y="-1034.23" font-family="Courier,monospace" font-size="11.00">DB_Util</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\PgSQL_SQL -->
|
||||
<g id="node8" class="node"><title>\\PgSQL_SQL</title>
|
||||
<a xlink:href="sys.db.drivers.pgsql.pgsql_sql.html" xlink:title="PgSQL_SQL" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="829,-736 753,-736 753,-700 829,-700 829,-736"/>
|
||||
<text text-anchor="middle" x="791" y="-714.6" font-family="Courier,monospace" font-size="11.00">PgSQL_SQL</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\PgSQL_SQL->\\DB_SQL -->
|
||||
<g id="edge5" class="edge"><title>\\PgSQL_SQL->\\DB_SQL</title>
|
||||
<path fill="none" stroke="black" d="M752.384,-727.654C717.629,-736.343 666.251,-749.187 627.723,-758.819"/>
|
||||
<polygon fill="none" stroke="black" points="626.576,-755.498 617.723,-761.319 628.273,-762.289 626.576,-755.498"/>
|
||||
</g>
|
||||
<!-- \\PgSQL_Util -->
|
||||
<g id="node9" class="node"><title>\\PgSQL_Util</title>
|
||||
<a xlink:href="sys.db.drivers.pgsql.pgsql_util.html" xlink:title="PgSQL_Util" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="833,-1006 749,-1006 749,-970 833,-970 833,-1006"/>
|
||||
<text text-anchor="middle" x="791" y="-984.6" font-family="Courier,monospace" font-size="11.00">PgSQL_Util</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\PgSQL_Util->\\DB_Util -->
|
||||
<g id="edge7" class="edge"><title>\\PgSQL_Util->\\DB_Util</title>
|
||||
<path fill="none" stroke="black" d="M748.84,-998.54C714.276,-1007.18 665.162,-1019.46 627.95,-1028.76"/>
|
||||
<polygon fill="none" stroke="black" points="626.644,-1025.48 617.792,-1031.3 628.342,-1032.27 626.644,-1025.48"/>
|
||||
</g>
|
||||
<!-- \\PgSQL -->
|
||||
<g id="node10" class="node"><title>\\PgSQL</title>
|
||||
<a xlink:href="sys.db.drivers.pgsql.pgsql_driver.html" xlink:title="PgSQL" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="818,-466 764,-466 764,-430 818,-430 818,-466"/>
|
||||
<text text-anchor="middle" x="791" y="-444.6" font-family="Courier,monospace" font-size="11.00">PgSQL</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\PgSQL->\\DB_PDO -->
|
||||
<g id="edge9" class="edge"><title>\\PgSQL->\\DB_PDO</title>
|
||||
<path fill="none" stroke="black" d="M763.782,-436.728C753.615,-432.212 742.093,-426.723 732,-421 686.756,-395.342 637.869,-360.466 606.878,-337.371"/>
|
||||
<polygon fill="none" stroke="black" points="608.731,-334.385 598.63,-331.186 604.531,-339.985 608.731,-334.385"/>
|
||||
</g>
|
||||
<!-- \\ODBC_Util -->
|
||||
<g id="node11" class="node"><title>\\ODBC_Util</title>
|
||||
<a xlink:href="sys.db.drivers.odbc.odbc_util.html" xlink:title="ODBC_Util" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="829,-952 753,-952 753,-916 829,-916 829,-952"/>
|
||||
<text text-anchor="middle" x="791" y="-930.6" font-family="Courier,monospace" font-size="11.00">ODBC_Util</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\ODBC_Util->\\DB_Util -->
|
||||
<g id="edge11" class="edge"><title>\\ODBC_Util->\\DB_Util</title>
|
||||
<path fill="none" stroke="black" d="M752.475,-951.313C745.629,-954.48 738.584,-957.797 732,-961 692.965,-979.988 649.105,-1002.74 617.686,-1019.29"/>
|
||||
<polygon fill="none" stroke="black" points="615.972,-1016.23 608.762,-1024 619.24,-1022.42 615.972,-1016.23"/>
|
||||
</g>
|
||||
<!-- \\ODBC_SQL -->
|
||||
<g id="node12" class="node"><title>\\ODBC_SQL</title>
|
||||
<a xlink:href="sys.db.drivers.odbc.odbc_sql.html" xlink:title="ODBC_SQL" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="826,-682 756,-682 756,-646 826,-646 826,-682"/>
|
||||
<text text-anchor="middle" x="791" y="-660.6" font-family="Courier,monospace" font-size="11.00">ODBC_SQL</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\ODBC_SQL->\\DB_SQL -->
|
||||
<g id="edge13" class="edge"><title>\\ODBC_SQL->\\DB_SQL</title>
|
||||
<path fill="none" stroke="black" d="M755.931,-679.72C748.026,-683.354 739.699,-687.255 732,-691 692.965,-709.988 649.105,-732.738 617.686,-749.287"/>
|
||||
<polygon fill="none" stroke="black" points="615.972,-746.234 608.762,-753.997 619.24,-752.425 615.972,-746.234"/>
|
||||
</g>
|
||||
<!-- \\ODBC -->
|
||||
<g id="node13" class="node"><title>\\ODBC</title>
|
||||
<a xlink:href="sys.db.drivers.odbc.odbc_driver.html" xlink:title="ODBC" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="818,-412 764,-412 764,-376 818,-376 818,-412"/>
|
||||
<text text-anchor="middle" x="791" y="-390.6" font-family="Courier,monospace" font-size="11.00">ODBC</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\ODBC->\\DB_PDO -->
|
||||
<g id="edge15" class="edge"><title>\\ODBC->\\DB_PDO</title>
|
||||
<path fill="none" stroke="black" d="M763.643,-383.741C729.449,-370.918 670.196,-348.699 627.205,-332.577"/>
|
||||
<polygon fill="none" stroke="black" points="628.339,-329.264 617.747,-329.03 625.882,-335.819 628.339,-329.264"/>
|
||||
</g>
|
||||
<!-- \\MySQL_Util -->
|
||||
<g id="node14" class="node"><title>\\MySQL_Util</title>
|
||||
<a xlink:href="sys.db.drivers.mysql.mysql_util.html" xlink:title="MySQL_Util" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="833,-1168 749,-1168 749,-1132 833,-1132 833,-1168"/>
|
||||
<text text-anchor="middle" x="791" y="-1146.6" font-family="Courier,monospace" font-size="11.00">MySQL_Util</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\MySQL_Util->\\DB_Util -->
|
||||
<g id="edge17" class="edge"><title>\\MySQL_Util->\\DB_Util</title>
|
||||
<path fill="none" stroke="black" d="M750.892,-1131.95C744.548,-1129.01 738.078,-1125.96 732,-1123 692.965,-1104.01 649.105,-1081.26 617.686,-1064.71"/>
|
||||
<polygon fill="none" stroke="black" points="619.24,-1061.58 608.762,-1060 615.972,-1067.77 619.24,-1061.58"/>
|
||||
</g>
|
||||
<!-- \\MySQL -->
|
||||
<g id="node15" class="node"><title>\\MySQL</title>
|
||||
<a xlink:href="sys.db.drivers.mysql.mysql_driver.html" xlink:title="MySQL" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="818,-358 764,-358 764,-322 818,-322 818,-358"/>
|
||||
<text text-anchor="middle" x="791" y="-336.6" font-family="Courier,monospace" font-size="11.00">MySQL</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\MySQL->\\DB_PDO -->
|
||||
<g id="edge19" class="edge"><title>\\MySQL->\\DB_PDO</title>
|
||||
<path fill="none" stroke="black" d="M763.643,-336.58C729.593,-332.324 670.693,-324.962 627.747,-319.593"/>
|
||||
<polygon fill="none" stroke="black" points="628.104,-316.111 617.747,-318.343 627.236,-323.057 628.104,-316.111"/>
|
||||
</g>
|
||||
<!-- \\MySQL_SQL -->
|
||||
<g id="node16" class="node"><title>\\MySQL_SQL</title>
|
||||
<a xlink:href="sys.db.drivers.mysql.mysql_sql.html" xlink:title="MySQL_SQL" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="830,-898 752,-898 752,-862 830,-862 830,-898"/>
|
||||
<text text-anchor="middle" x="791" y="-876.6" font-family="Courier,monospace" font-size="11.00">MySQL_SQL</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\MySQL_SQL->\\DB_SQL -->
|
||||
<g id="edge21" class="edge"><title>\\MySQL_SQL->\\DB_SQL</title>
|
||||
<path fill="none" stroke="black" d="M751.843,-862.394C745.196,-859.316 738.382,-856.104 732,-853 692.965,-834.012 649.105,-811.262 617.686,-794.713"/>
|
||||
<polygon fill="none" stroke="black" points="619.24,-791.575 608.762,-790.003 615.972,-797.766 619.24,-791.575"/>
|
||||
</g>
|
||||
<!-- \\SQLite_Util -->
|
||||
<g id="node17" class="node"><title>\\SQLite_Util</title>
|
||||
<a xlink:href="sys.db.drivers.sqlite.sqlite_util.html" xlink:title="SQLite_Util" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="836,-1114 746,-1114 746,-1078 836,-1078 836,-1114"/>
|
||||
<text text-anchor="middle" x="791" y="-1092.6" font-family="Courier,monospace" font-size="11.00">SQLite_Util</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\SQLite_Util->\\DB_Util -->
|
||||
<g id="edge23" class="edge"><title>\\SQLite_Util->\\DB_Util</title>
|
||||
<path fill="none" stroke="black" d="M745.456,-1084.61C710.949,-1075.99 663.482,-1064.12 627.4,-1055.1"/>
|
||||
<polygon fill="none" stroke="black" points="628.096,-1051.67 617.545,-1052.64 626.398,-1058.46 628.096,-1051.67"/>
|
||||
</g>
|
||||
<!-- \\SQLite -->
|
||||
<g id="node18" class="node"><title>\\SQLite</title>
|
||||
<a xlink:href="sys.db.drivers.sqlite.sqlite_driver.html" xlink:title="SQLite" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="819,-304 763,-304 763,-268 819,-268 819,-304"/>
|
||||
<text text-anchor="middle" x="791" y="-282.6" font-family="Courier,monospace" font-size="11.00">SQLite</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\SQLite->\\DB_PDO -->
|
||||
<g id="edge25" class="edge"><title>\\SQLite->\\DB_PDO</title>
|
||||
<path fill="none" stroke="black" d="M762.317,-289.585C728.073,-293.866 670.12,-301.11 627.724,-306.409"/>
|
||||
<polygon fill="none" stroke="black" points="627.066,-302.964 617.577,-307.678 627.934,-309.91 627.066,-302.964"/>
|
||||
</g>
|
||||
<!-- \\SQLite_SQL -->
|
||||
<g id="node19" class="node"><title>\\SQLite_SQL</title>
|
||||
<a xlink:href="sys.db.drivers.sqlite.sqlite_sql.html" xlink:title="SQLite_SQL" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="833,-844 749,-844 749,-808 833,-808 833,-844"/>
|
||||
<text text-anchor="middle" x="791" y="-822.6" font-family="Courier,monospace" font-size="11.00">SQLite_SQL</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\SQLite_SQL->\\DB_SQL -->
|
||||
<g id="edge27" class="edge"><title>\\SQLite_SQL->\\DB_SQL</title>
|
||||
<path fill="none" stroke="black" d="M748.84,-815.46C714.276,-806.819 665.162,-794.54 627.95,-785.237"/>
|
||||
<polygon fill="none" stroke="black" points="628.342,-781.728 617.792,-782.698 626.644,-788.519 628.342,-781.728"/>
|
||||
</g>
|
||||
<!-- \\Firebird_SQL -->
|
||||
<g id="node20" class="node"><title>\\Firebird_SQL</title>
|
||||
<a xlink:href="sys.db.drivers.firebird.firebird_sql.html" xlink:title="Firebird_SQL" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="839,-790 743,-790 743,-754 839,-754 839,-790"/>
|
||||
<text text-anchor="middle" x="791" y="-768.6" font-family="Courier,monospace" font-size="11.00">Firebird_SQL</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Firebird_SQL->\\DB_SQL -->
|
||||
<g id="edge29" class="edge"><title>\\Firebird_SQL->\\DB_SQL</title>
|
||||
<path fill="none" stroke="black" d="M742.256,-772C708.168,-772 662.673,-772 627.738,-772"/>
|
||||
<polygon fill="none" stroke="black" points="627.723,-768.5 617.723,-772 627.722,-775.5 627.723,-768.5"/>
|
||||
</g>
|
||||
<!-- \\Firebird_Result -->
|
||||
<g id="node21" class="node"><title>\\Firebird_Result</title>
|
||||
<a xlink:href="sys.db.drivers.firebird.firebird_result.html" xlink:title="Firebird_Result" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="849,-88 733,-88 733,-52 849,-52 849,-88"/>
|
||||
<text text-anchor="middle" x="791" y="-66.6" font-family="Courier,monospace" font-size="11.00">Firebird_Result</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\PDOStatement -->
|
||||
<g id="node51" class="node"><title>\\PDOStatement</title>
|
||||
<ellipse fill="none" stroke="black" cx="575" cy="-18" rx="85.1942" ry="18"/>
|
||||
<text text-anchor="middle" x="575" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\PDOStatement</text>
|
||||
</g>
|
||||
<!-- \\Firebird_Result->\\PDOStatement -->
|
||||
<g id="edge31" class="edge"><title>\\Firebird_Result->\\PDOStatement</title>
|
||||
<path fill="none" stroke="black" d="M732.262,-55.8595C704.213,-49.1069 670.522,-40.996 641.531,-34.0167"/>
|
||||
<polygon fill="none" stroke="black" points="642.031,-30.5372 631.49,-31.5994 640.393,-37.3428 642.031,-30.5372"/>
|
||||
</g>
|
||||
<!-- \\Firebird -->
|
||||
<g id="node22" class="node"><title>\\Firebird</title>
|
||||
<a xlink:href="sys.db.drivers.firebird.firebird_driver.html" xlink:title="Firebird" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="826,-142 756,-142 756,-106 826,-106 826,-142"/>
|
||||
<text text-anchor="middle" x="791" y="-120.6" font-family="Courier,monospace" font-size="11.00">Firebird</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Firebird->\\DB_PDO -->
|
||||
<g id="edge33" class="edge"><title>\\Firebird->\\DB_PDO</title>
|
||||
<path fill="none" stroke="black" d="M755.847,-135.478C747.34,-139.433 738.761,-144.542 732,-151 681.404,-199.329 714.646,-247.303 660,-291 650.606,-298.512 638.928,-303.483 627.266,-306.766"/>
|
||||
<polygon fill="none" stroke="black" points="626.408,-303.373 617.524,-309.146 628.069,-310.173 626.408,-303.373"/>
|
||||
</g>
|
||||
<!-- \\Firebird_Util -->
|
||||
<g id="node23" class="node"><title>\\Firebird_Util</title>
|
||||
<a xlink:href="sys.db.drivers.firebird.firebird_util.html" xlink:title="Firebird_Util" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="843,-1060 739,-1060 739,-1024 843,-1024 843,-1060"/>
|
||||
<text text-anchor="middle" x="791" y="-1038.6" font-family="Courier,monospace" font-size="11.00">Firebird_Util</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Firebird_Util->\\DB_Util -->
|
||||
<g id="edge35" class="edge"><title>\\Firebird_Util->\\DB_Util</title>
|
||||
<path fill="none" stroke="black" d="M738.988,-1042C705.275,-1042 661.502,-1042 627.662,-1042"/>
|
||||
<polygon fill="none" stroke="black" points="627.5,-1038.5 617.5,-1042 627.5,-1045.5 627.5,-1038.5"/>
|
||||
</g>
|
||||
<!-- \\MM_Model -->
|
||||
<g id="node24" class="node"><title>\\MM_Model</title>
|
||||
<g id="node2" class="node"><title>\\MM_Model</title>
|
||||
<a xlink:href="sys.core.model.html" xlink:title="MM_Model" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="610,-628 540,-628 540,-592 610,-592 610,-628"/>
|
||||
<text text-anchor="middle" x="575" y="-606.6" font-family="Courier,monospace" font-size="11.00">MM_Model</text>
|
||||
<polygon fill="none" stroke="black" points="606,-263 536,-263 536,-227 606,-227 606,-263"/>
|
||||
<text text-anchor="middle" x="571" y="-241.6" font-family="Courier,monospace" font-size="11.00">MM_Model</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\miniMVC -->
|
||||
<g id="node27" class="node"><title>\\miniMVC</title>
|
||||
<g id="node5" class="node"><title>\\miniMVC</title>
|
||||
<a xlink:href="sys.core.miniMVC.html" xlink:title="miniMVC" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="411,-574 347,-574 347,-538 411,-538 411,-574"/>
|
||||
<text text-anchor="middle" x="379" y="-552.6" font-family="Courier,monospace" font-size="11.00">miniMVC</text>
|
||||
<polygon fill="none" stroke="black" points="411,-182 347,-182 347,-146 411,-146 411,-182"/>
|
||||
<text text-anchor="middle" x="379" y="-160.6" font-family="Courier,monospace" font-size="11.00">miniMVC</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\MM_Model->\\miniMVC -->
|
||||
<g id="edge37" class="edge"><title>\\MM_Model->\\miniMVC</title>
|
||||
<path fill="none" stroke="black" d="M539.051,-600.096C505.958,-590.978 456.829,-577.443 421.74,-567.775"/>
|
||||
<polygon fill="none" stroke="black" points="422.359,-564.316 411.789,-565.034 420.5,-571.064 422.359,-564.316"/>
|
||||
<g id="edge3" class="edge"><title>\\MM_Model->\\miniMVC</title>
|
||||
<path fill="none" stroke="black" d="M535.336,-229.954C502.922,-216.279 455.073,-196.093 420.858,-181.659"/>
|
||||
<polygon fill="none" stroke="black" points="422.167,-178.413 411.593,-177.75 419.446,-184.862 422.167,-178.413"/>
|
||||
</g>
|
||||
<!-- \\DB -->
|
||||
<g id="node25" class="node"><title>\\DB</title>
|
||||
<g id="node3" class="node"><title>\\DB</title>
|
||||
<a xlink:href="sys.core.db.html" xlink:title="DB" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="818,-574 764,-574 764,-538 818,-538 818,-574"/>
|
||||
<text text-anchor="middle" x="791" y="-552.6" font-family="Courier,monospace" font-size="11.00">DB</text>
|
||||
<polygon fill="none" stroke="black" points="804,-88 750,-88 750,-52 804,-52 804,-88"/>
|
||||
<text text-anchor="middle" x="777" y="-66.6" font-family="Courier,monospace" font-size="11.00">DB</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Query_Builder -->
|
||||
<g id="node15" class="node"><title>\\Query_Builder</title>
|
||||
<ellipse fill="none" stroke="black" cx="571" cy="-18" rx="81.1693" ry="18"/>
|
||||
<text text-anchor="middle" x="571" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\Query_Builder</text>
|
||||
</g>
|
||||
<!-- \\DB->\\Query_Builder -->
|
||||
<g id="edge39" class="edge"><title>\\DB->\\Query_Builder</title>
|
||||
<path fill="none" stroke="black" d="M763.643,-556C732.077,-556 679.154,-556 637.385,-556"/>
|
||||
<polygon fill="none" stroke="black" points="637.298,-552.5 627.298,-556 637.298,-559.5 637.298,-552.5"/>
|
||||
<g id="edge5" class="edge"><title>\\DB->\\Query_Builder</title>
|
||||
<path fill="none" stroke="black" d="M749.645,-63.0948C720.509,-55.7402 673.376,-43.8426 634.838,-34.1144"/>
|
||||
<polygon fill="none" stroke="black" points="635.284,-30.6172 624.731,-31.5632 633.57,-37.4043 635.284,-30.6172"/>
|
||||
</g>
|
||||
<!-- \\MM -->
|
||||
<g id="node26" class="node"><title>\\MM</title>
|
||||
<g id="node4" class="node"><title>\\MM</title>
|
||||
<a xlink:href="sys.core.miniMVC.html" xlink:title="MM" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="268,-628 214,-628 214,-592 268,-592 268,-628"/>
|
||||
<text text-anchor="middle" x="241" y="-606.6" font-family="Courier,monospace" font-size="11.00">MM</text>
|
||||
<polygon fill="none" stroke="black" points="268,-236 214,-236 214,-200 268,-200 268,-236"/>
|
||||
<text text-anchor="middle" x="241" y="-214.6" font-family="Courier,monospace" font-size="11.00">MM</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\ArrayObject -->
|
||||
<g id="node57" class="node"><title>\\ArrayObject</title>
|
||||
<ellipse fill="none" stroke="black" cx="71" cy="-610" rx="71.107" ry="18"/>
|
||||
<text text-anchor="middle" x="71" y="-605.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\ArrayObject</text>
|
||||
<g id="node17" class="node"><title>\\ArrayObject</title>
|
||||
<ellipse fill="none" stroke="black" cx="71" cy="-218" rx="71.107" ry="18"/>
|
||||
<text text-anchor="middle" x="71" y="-213.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\ArrayObject</text>
|
||||
</g>
|
||||
<!-- \\MM->\\ArrayObject -->
|
||||
<g id="edge41" class="edge"><title>\\MM->\\ArrayObject</title>
|
||||
<path fill="none" stroke="black" d="M213.687,-610C196.92,-610 174.483,-610 152.374,-610"/>
|
||||
<polygon fill="none" stroke="black" points="152.26,-606.5 142.26,-610 152.26,-613.5 152.26,-606.5"/>
|
||||
<g id="edge7" class="edge"><title>\\MM->\\ArrayObject</title>
|
||||
<path fill="none" stroke="black" d="M213.687,-218C196.92,-218 174.483,-218 152.374,-218"/>
|
||||
<polygon fill="none" stroke="black" points="152.26,-214.5 142.26,-218 152.26,-221.5 152.26,-214.5"/>
|
||||
</g>
|
||||
<!-- \\miniMVC->\\MM -->
|
||||
<g id="edge43" class="edge"><title>\\miniMVC->\\MM</title>
|
||||
<path fill="none" stroke="black" d="M346.296,-568.797C325.699,-576.857 299.069,-587.277 277.744,-595.622"/>
|
||||
<polygon fill="none" stroke="black" points="276.397,-592.391 268.36,-599.294 278.948,-598.909 276.397,-592.391"/>
|
||||
<g id="edge9" class="edge"><title>\\miniMVC->\\MM</title>
|
||||
<path fill="none" stroke="black" d="M346.296,-176.797C325.699,-184.857 299.069,-195.277 277.744,-203.622"/>
|
||||
<polygon fill="none" stroke="black" points="276.397,-200.391 268.36,-207.294 278.948,-206.909 276.397,-200.391"/>
|
||||
</g>
|
||||
<!-- \\MM_Page -->
|
||||
<g id="node28" class="node"><title>\\MM_Page</title>
|
||||
<g id="node6" class="node"><title>\\MM_Page</title>
|
||||
<a xlink:href="sys.core.page.html" xlink:title="MM_Page" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="411,-682 347,-682 347,-646 411,-646 411,-682"/>
|
||||
<text text-anchor="middle" x="379" y="-660.6" font-family="Courier,monospace" font-size="11.00">MM_Page</text>
|
||||
<polygon fill="none" stroke="black" points="411,-290 347,-290 347,-254 411,-254 411,-290"/>
|
||||
<text text-anchor="middle" x="379" y="-268.6" font-family="Courier,monospace" font-size="11.00">MM_Page</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\MM_Page->\\MM -->
|
||||
<g id="edge45" class="edge"><title>\\MM_Page->\\MM</title>
|
||||
<path fill="none" stroke="black" d="M346.296,-651.203C325.699,-643.143 299.069,-632.723 277.744,-624.378"/>
|
||||
<polygon fill="none" stroke="black" points="278.948,-621.091 268.36,-620.706 276.397,-627.609 278.948,-621.091"/>
|
||||
<g id="edge11" class="edge"><title>\\MM_Page->\\MM</title>
|
||||
<path fill="none" stroke="black" d="M346.296,-259.203C325.699,-251.143 299.069,-240.723 277.744,-232.378"/>
|
||||
<polygon fill="none" stroke="black" points="278.948,-229.091 268.36,-228.706 276.397,-235.609 278.948,-229.091"/>
|
||||
</g>
|
||||
<!-- \\MM_Controller -->
|
||||
<g id="node29" class="node"><title>\\MM_Controller</title>
|
||||
<g id="node7" class="node"><title>\\MM_Controller</title>
|
||||
<a xlink:href="sys.core.controller.html" xlink:title="MM_Controller" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="627,-520 523,-520 523,-484 627,-484 627,-520"/>
|
||||
<text text-anchor="middle" x="575" y="-498.6" font-family="Courier,monospace" font-size="11.00">MM_Controller</text>
|
||||
<polygon fill="none" stroke="black" points="623,-155 519,-155 519,-119 623,-119 623,-155"/>
|
||||
<text text-anchor="middle" x="571" y="-133.6" font-family="Courier,monospace" font-size="11.00">MM_Controller</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\MM_Controller->\\miniMVC -->
|
||||
<g id="edge47" class="edge"><title>\\MM_Controller->\\miniMVC</title>
|
||||
<path fill="none" stroke="black" d="M522.476,-516.471C490.93,-525.162 451.306,-536.079 421.696,-544.237"/>
|
||||
<polygon fill="none" stroke="black" points="420.381,-540.969 411.67,-546.999 422.24,-547.717 420.381,-540.969"/>
|
||||
<g id="edge13" class="edge"><title>\\MM_Controller->\\miniMVC</title>
|
||||
<path fill="none" stroke="black" d="M518.281,-144.414C487.927,-148.682 450.272,-153.977 421.77,-157.985"/>
|
||||
<polygon fill="none" stroke="black" points="421.129,-154.541 411.714,-159.4 422.104,-161.473 421.129,-154.541"/>
|
||||
</g>
|
||||
<!-- \\MM_Output -->
|
||||
<g id="node30" class="node"><title>\\MM_Output</title>
|
||||
<g id="node8" class="node"><title>\\MM_Output</title>
|
||||
<a xlink:href="sys.core.output.html" xlink:title="MM_Output" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="418,-628 340,-628 340,-592 418,-592 418,-628"/>
|
||||
<text text-anchor="middle" x="379" y="-606.6" font-family="Courier,monospace" font-size="11.00">MM_Output</text>
|
||||
<polygon fill="none" stroke="black" points="418,-236 340,-236 340,-200 418,-200 418,-236"/>
|
||||
<text text-anchor="middle" x="379" y="-214.6" font-family="Courier,monospace" font-size="11.00">MM_Output</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\MM_Output->\\MM -->
|
||||
<g id="edge49" class="edge"><title>\\MM_Output->\\MM</title>
|
||||
<path fill="none" stroke="black" d="M339.824,-610C320.46,-610 297.217,-610 278.137,-610"/>
|
||||
<polygon fill="none" stroke="black" points="278.018,-606.5 268.018,-610 278.017,-613.5 278.018,-606.5"/>
|
||||
<g id="edge15" class="edge"><title>\\MM_Output->\\MM</title>
|
||||
<path fill="none" stroke="black" d="M339.824,-218C320.46,-218 297.217,-218 278.137,-218"/>
|
||||
<polygon fill="none" stroke="black" points="278.018,-214.5 268.018,-218 278.017,-221.5 278.018,-214.5"/>
|
||||
</g>
|
||||
<!-- \\MM_Data_Store -->
|
||||
<g id="node31" class="node"><title>\\MM_Data_Store</title>
|
||||
<g id="node9" class="node"><title>\\MM_Data_Store</title>
|
||||
<a xlink:href="sys.libraries.data_store.html" xlink:title="MM_Data_Store" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="843,-250 739,-250 739,-214 843,-214 843,-250"/>
|
||||
<text text-anchor="middle" x="791" y="-228.6" font-family="Courier,monospace" font-size="11.00">MM_Data_Store</text>
|
||||
<polygon fill="none" stroke="black" points="829,-250 725,-250 725,-214 829,-214 829,-250"/>
|
||||
<text text-anchor="middle" x="777" y="-228.6" font-family="Courier,monospace" font-size="11.00">MM_Data_Store</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\MM_Session -->
|
||||
<g id="node32" class="node"><title>\\MM_Session</title>
|
||||
<g id="node10" class="node"><title>\\MM_Session</title>
|
||||
<a xlink:href="sys.libraries.session.html" xlink:title="MM_Session" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="833,-196 749,-196 749,-160 833,-160 833,-196"/>
|
||||
<text text-anchor="middle" x="791" y="-174.6" font-family="Courier,monospace" font-size="11.00">MM_Session</text>
|
||||
<polygon fill="none" stroke="black" points="819,-196 735,-196 735,-160 819,-160 819,-196"/>
|
||||
<text text-anchor="middle" x="777" y="-174.6" font-family="Courier,monospace" font-size="11.00">MM_Session</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Welcome_Model -->
|
||||
<g id="node33" class="node"><title>\\Welcome_Model</title>
|
||||
<g id="node11" class="node"><title>\\Welcome_Model</title>
|
||||
<a xlink:href="app.modules.welcome.models.welcome_model.html" xlink:title="Welcome_Model" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="843,-628 739,-628 739,-592 843,-592 843,-628"/>
|
||||
<text text-anchor="middle" x="791" y="-606.6" font-family="Courier,monospace" font-size="11.00">Welcome_Model</text>
|
||||
<polygon fill="none" stroke="black" points="829,-304 725,-304 725,-268 829,-268 829,-304"/>
|
||||
<text text-anchor="middle" x="777" y="-282.6" font-family="Courier,monospace" font-size="11.00">Welcome_Model</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Welcome_Model->\\MM_Model -->
|
||||
<g id="edge51" class="edge"><title>\\Welcome_Model->\\MM_Model</title>
|
||||
<path fill="none" stroke="black" d="M738.988,-610C703.013,-610 655.582,-610 620.988,-610"/>
|
||||
<polygon fill="none" stroke="black" points="620.692,-606.5 610.692,-610 620.692,-613.5 620.692,-606.5"/>
|
||||
<g id="edge17" class="edge"><title>\\Welcome_Model->\\MM_Model</title>
|
||||
<path fill="none" stroke="black" d="M724.751,-275.601C691.408,-268.965 648.606,-260.446 616.632,-254.082"/>
|
||||
<polygon fill="none" stroke="black" points="617.148,-250.616 606.657,-252.097 615.782,-257.482 617.148,-250.616"/>
|
||||
</g>
|
||||
<!-- \\Welcome -->
|
||||
<g id="node34" class="node"><title>\\Welcome</title>
|
||||
<g id="node12" class="node"><title>\\Welcome</title>
|
||||
<a xlink:href="app.modules.welcome.controllers.welcome.html" xlink:title="Welcome" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="823,-520 759,-520 759,-484 823,-484 823,-520"/>
|
||||
<text text-anchor="middle" x="791" y="-498.6" font-family="Courier,monospace" font-size="11.00">Welcome</text>
|
||||
<polygon fill="none" stroke="black" points="809,-142 745,-142 745,-106 809,-106 809,-142"/>
|
||||
<text text-anchor="middle" x="777" y="-120.6" font-family="Courier,monospace" font-size="11.00">Welcome</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Welcome->\\MM_Controller -->
|
||||
<g id="edge53" class="edge"><title>\\Welcome->\\MM_Controller</title>
|
||||
<path fill="none" stroke="black" d="M758.663,-502C726.833,-502 677.382,-502 637.808,-502"/>
|
||||
<polygon fill="none" stroke="black" points="637.717,-498.5 627.716,-502 637.716,-505.5 637.717,-498.5"/>
|
||||
<g id="edge19" class="edge"><title>\\Welcome->\\MM_Controller</title>
|
||||
<path fill="none" stroke="black" d="M744.812,-126.031C715.23,-127.898 670.544,-130.718 633.889,-133.031"/>
|
||||
<polygon fill="none" stroke="black" points="633.542,-129.546 623.783,-133.669 633.983,-136.532 633.542,-129.546"/>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 8.6 KiB |
1430
docs/classes/DB.html
1430
docs/classes/DB.html
File diff suppressed because it is too large
Load Diff
@ -1,714 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \DB_PDO</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: PDO constructor wrapper"><span class="description">PDO constructor wrapper</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public "><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
|
||||
</span><pre>__sleep()</pre></a></li>
|
||||
<li class="method public "><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
|
||||
</span><pre>__wakeup()</pre></a></li>
|
||||
<li class="method public "><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
|
||||
<li class="method public "><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
|
||||
</span><pre>beginTransaction()</pre></a></li>
|
||||
<li class="method public "><a href="#commit" title="commit :: "><span class="description">commit()
|
||||
</span><pre>commit()</pre></a></li>
|
||||
<li class="method public "><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
|
||||
<li class="method public "><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
|
||||
</span><pre>errorCode()</pre></a></li>
|
||||
<li class="method public "><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
|
||||
</span><pre>errorInfo()</pre></a></li>
|
||||
<li class="method public "><a href="#exec" title="exec :: "><span class="description">exec()
|
||||
</span><pre>exec()</pre></a></li>
|
||||
<li class="method public "><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
|
||||
</span><pre>getAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
|
||||
</span><pre>getAvailableDrivers()</pre></a></li>
|
||||
<li class="method public "><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
|
||||
<li class="method public "><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
|
||||
<li class="method public "><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
|
||||
<li class="method public "><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
|
||||
<li class="method public "><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
|
||||
<li class="method public "><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
|
||||
<li class="method public "><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
|
||||
<li class="method public "><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
|
||||
<li class="method public "><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
|
||||
the connection/database"><span class="description">Retreives an array of non-user-created tables for
|
||||
the connection/database</span><pre>get_system_tables()</pre></a></li>
|
||||
<li class="method public "><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
|
||||
<li class="method public "><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
|
||||
<li class="method public "><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
|
||||
<li class="method public "><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
|
||||
<li class="method public "><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
|
||||
</span><pre>inTransaction()</pre></a></li>
|
||||
<li class="method public "><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
|
||||
</span><pre>lastInsertId()</pre></a></li>
|
||||
<li class="method public "><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
|
||||
<li class="method public "><a href="#prepare" title="prepare :: "><span class="description">prepare()
|
||||
</span><pre>prepare()</pre></a></li>
|
||||
<li class="method public "><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
|
||||
<li class="method public "><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
|
||||
<li class="method public "><a href="#query" title="query :: "><span class="description">query()
|
||||
</span><pre>query()</pre></a></li>
|
||||
<li class="method public "><a href="#quote" title="quote :: "><span class="description">quote()
|
||||
</span><pre>quote()</pre></a></li>
|
||||
<li class="method public "><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
|
||||
<li class="method public "><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
|
||||
</span><pre>rollBack()</pre></a></li>
|
||||
<li class="method public "><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
|
||||
</span><pre>setAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#switch_db" title="switch_db :: Connect to a different database"><span class="description">Connect to a different database</span><pre>switch_db()</pre></a></li>
|
||||
<li class="method public "><a href="#truncate" title="truncate :: Empty the passed table"><span class="description">Empty the passed table</span><pre>truncate()</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="method protected "><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
|
||||
<li class="method protected "><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="property public "><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
|
||||
<li class="property public "><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="property protected "><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
|
||||
<li class="property protected "><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CDB_PDO" id="\DB_PDO"></a><div href="../classes/DB_PDO.html" class="element class">
|
||||
<p class="short_description">Base Database class</p>
|
||||
<div class="details">
|
||||
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Query.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Query</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>PDO constructor wrapper</h2>
|
||||
<pre>__construct(string $dsn, string $username, string $password, array $driver_options) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$dsn</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$username</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$password</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$driver_options</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
|
||||
<h2>__sleep()
|
||||
</h2>
|
||||
<pre>__sleep() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__sleep()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
|
||||
<h2>__wakeup()
|
||||
</h2>
|
||||
<pre>__wakeup() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__wakeup()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
|
||||
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
|
||||
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
|
||||
<h2>beginTransaction()
|
||||
</h2>
|
||||
<pre>beginTransaction() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::beginTransaction()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
|
||||
<h2>commit()
|
||||
</h2>
|
||||
<pre>commit() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::commit()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
|
||||
<h2>Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</h2>
|
||||
<pre>empty_table(string $table) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
|
||||
<h2>errorCode()
|
||||
</h2>
|
||||
<pre>errorCode() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorCode()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
|
||||
<h2>errorInfo()
|
||||
</h2>
|
||||
<pre>errorInfo() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorInfo()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
|
||||
<h2>exec()
|
||||
</h2>
|
||||
<pre>exec() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::exec()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
|
||||
<h2>getAttribute()
|
||||
</h2>
|
||||
<pre>getAttribute() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAttribute()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
|
||||
<h2>getAvailableDrivers()
|
||||
</h2>
|
||||
<pre>getAvailableDrivers() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAvailableDrivers()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
|
||||
<h2>Retrieve column information for the current database table</h2>
|
||||
<pre>get_columns(string $table) : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
|
||||
<h2>Return list of dbs for the current connection, if possible</h2>
|
||||
<pre>get_dbs() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
|
||||
<h2>Return list of function for the current database</h2>
|
||||
<pre>get_functions() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
|
||||
<h2>Return the last error for the current database connection</h2>
|
||||
<pre>get_last_error() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
|
||||
<h2>Return list of stored procedures for the current database</h2>
|
||||
<pre>get_procedures() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
|
||||
<h2>Retreives the data from a select query</h2>
|
||||
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
|
||||
<h2>Return schemas for databases that list them</h2>
|
||||
<pre>get_schemas() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
|
||||
<h2>Return list of sequences for the current database, if they exist</h2>
|
||||
<pre>get_sequences() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
|
||||
<h2>Retreives an array of non-user-created tables for
|
||||
the connection/database</h2>
|
||||
<pre>get_system_tables() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
|
||||
<h2>Return list of tables for the current database</h2>
|
||||
<pre>get_tables() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
|
||||
<h2>Return list of triggers for the current database</h2>
|
||||
<pre>get_triggers() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
|
||||
<h2>Retrieve list of data types for the database</h2>
|
||||
<pre>get_types() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
|
||||
<h2>Return list of views for the current database</h2>
|
||||
<pre>get_views() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
|
||||
<h2>inTransaction()
|
||||
</h2>
|
||||
<pre>inTransaction() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::inTransaction()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
|
||||
<h2>lastInsertId()
|
||||
</h2>
|
||||
<pre>lastInsertId() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::lastInsertId()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
|
||||
<h2>Return the number of rows returned for a SELECT query</h2>
|
||||
<pre>num_rows() : int</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
|
||||
<h2>prepare()
|
||||
</h2>
|
||||
<pre>prepare() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::prepare()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
|
||||
<h2>Create and execute a prepared statement with the provided parameters</h2>
|
||||
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
|
||||
<h2>Simplifies prepared statements for database queries</h2>
|
||||
<pre>prepare_query(string $sql, array $data) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$data</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response">
|
||||
<code>mixed</code>PDOStatement / FALSE</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
|
||||
<h2>query()
|
||||
</h2>
|
||||
<pre>query() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::query()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
|
||||
<h2>quote()
|
||||
</h2>
|
||||
<pre>quote() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::quote()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
|
||||
<h2>Surrounds the string with the databases identifier escape characters</h2>
|
||||
<pre>quote_ident(mixed $ident) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$ident</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
|
||||
<h2>rollBack()
|
||||
</h2>
|
||||
<pre>rollBack() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::rollBack()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
|
||||
<h2>setAttribute()
|
||||
</h2>
|
||||
<pre>setAttribute() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::setAttribute()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="switch_db" id="switch_db"></a><div class="element clickable method public switch_db" data-toggle="collapse" data-target=".switch_db .collapse">
|
||||
<h2>Connect to a different database</h2>
|
||||
<pre>switch_db(string $name) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
|
||||
<h2>Empty the passed table</h2>
|
||||
<pre>truncate(string $table) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
|
||||
<h2>Helper method for quote_ident</h2>
|
||||
<pre>_quote(mixed $str) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$str</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="driver_query" id="driver_query"></a><div class="element clickable method protected driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
|
||||
<h2>Method to simplify retreiving db results for meta-data queries</h2>
|
||||
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$filtered_index</h4>
|
||||
<code>bool</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
|
||||
<h2>Reference to sql sub class</h2>
|
||||
<pre>$sql : Object</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
|
||||
<h2>Reference to util sub class</h2>
|
||||
<pre>$util : Object</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
|
||||
<h2>Character to escape identifiers</h2>
|
||||
<pre>$escape_char : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
|
||||
<h2>Reference to the last executed query</h2>
|
||||
<pre>$statement : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,160 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \DB_Reg</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#get_connections" title="get_connections :: Return exiting connections"><span class="description">Return exiting connections</span><pre>get_connections()</pre></a></li>
|
||||
<li class="method public "><a href="#get_db" title="get_db :: Registry access method"><span class="description">Registry access method</span><pre>get_db()</pre></a></li>
|
||||
<li class="method public "><a href="#remove_db" title="remove_db :: Remove a database connection"><span class="description">Remove a database connection</span><pre>remove_db()</pre></a></li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="method private "><a href="#__construct" title="__construct :: Private constructor"><span class="description">Private constructor</span><pre>__construct()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private "><a href="#%24instance" title="$instance :: Static array of connections"><span class="description">Static array of connections</span><pre>$instance</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CDB_Reg" id="\DB_Reg"></a><div href="../classes/DB_Reg.html" class="element class">
|
||||
<p class="short_description">Connection registry</p>
|
||||
<div class="details">
|
||||
<p class="long_description"><p>Decouples the Settings class from the query builder
|
||||
and organizes database connections</p></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Helper%20Classes.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Helper Classes</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="get_connections" id="get_connections"></a><div class="element clickable method public get_connections" data-toggle="collapse" data-target=".get_connections .collapse">
|
||||
<h2>Return exiting connections</h2>
|
||||
<pre>get_connections() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_db" id="get_db"></a><div class="element clickable method public get_db" data-toggle="collapse" data-target=".get_db .collapse">
|
||||
<h2>Registry access method</h2>
|
||||
<pre>get_db(string $key) : object</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$key</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>object</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="remove_db" id="remove_db"></a><div class="element clickable method public remove_db" data-toggle="collapse" data-target=".remove_db .collapse">
|
||||
<h2>Remove a database connection</h2>
|
||||
<pre>remove_db(string $key) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$key</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method private __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Private constructor</h2>
|
||||
<pre>__construct(string $key) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$key</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24instance" id="$instance"> </a><div class="element clickable property private $instance" data-toggle="collapse" data-target=".$instance .collapse">
|
||||
<h2>Static array of connections</h2>
|
||||
<pre>$instance </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,306 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \DB_SQL</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
|
||||
<li class="method public "><a href="#column_list" title="column_list :: Get information about the columns in the
|
||||
specified table"><span class="description">Get information about the columns in the
|
||||
specified table</span><pre>column_list()</pre></a></li>
|
||||
<li class="method public "><a href="#db_list" title="db_list :: Returns sql to list other databases"><span class="description">Returns sql to list other databases</span><pre>db_list()</pre></a></li>
|
||||
<li class="method public "><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
|
||||
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
|
||||
<li class="method public "><a href="#limit" title="limit :: Get database specific sql for limit clause"><span class="description">Get database specific sql for limit clause</span><pre>limit()</pre></a></li>
|
||||
<li class="method public "><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
|
||||
<li class="method public "><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
|
||||
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
|
||||
<li class="method public "><a href="#random" title="random :: Get the sql for random ordering"><span class="description">Get the sql for random ordering</span><pre>random()</pre></a></li>
|
||||
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
|
||||
<li class="method public "><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
|
||||
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
|
||||
<li class="method public "><a href="#type_list" title="type_list :: Return sql to list database field types"><span class="description">Return sql to list database field types</span><pre>type_list()</pre></a></li>
|
||||
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CDB_SQL" id="\DB_SQL"></a><div href="../classes/DB_SQL.html" class="element class">
|
||||
<p class="short_description">Abstract parent for database manipulation subclasses</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Query.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Query</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
|
||||
<h2>Get the 'average' keyword</h2>
|
||||
<pre>avg() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
|
||||
<h2>Get information about the columns in the
|
||||
specified table</h2>
|
||||
<pre>column_list($table) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code></code><p>string</p></div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse">
|
||||
<h2>Returns sql to list other databases</h2>
|
||||
<pre>db_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
|
||||
<h2>Get the 'distinct' keyword</h2>
|
||||
<pre>distinct() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
|
||||
<h2>Return sql to list functions</h2>
|
||||
<pre>function_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
|
||||
<h2>Get database specific sql for limit clause</h2>
|
||||
<pre>limit(string $sql, int $limit, int $offset) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>abstract</th>
|
||||
<td></td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$limit</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$offset</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
|
||||
<h2>Get the max keyword sql</h2>
|
||||
<pre>max() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
|
||||
<h2>Get the min keyword sql</h2>
|
||||
<pre>min() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
|
||||
<h2>Return sql to list stored procedures</h2>
|
||||
<pre>procedure_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse">
|
||||
<h2>Get the sql for random ordering</h2>
|
||||
<pre>random() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>abstract</th>
|
||||
<td></td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse">
|
||||
<h2>Return sql to list sequences</h2>
|
||||
<pre>sequence_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
|
||||
<h2>Get the 'sum' keyword</h2>
|
||||
<pre>sum() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
|
||||
<h2>Returns sql to list system tables</h2>
|
||||
<pre>system_table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse">
|
||||
<h2>Returns sql to list tables</h2>
|
||||
<pre>table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse">
|
||||
<h2>Returns sql to list triggers</h2>
|
||||
<pre>trigger_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse">
|
||||
<h2>Return sql to list database field types</h2>
|
||||
<pre>type_list() : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse">
|
||||
<h2>Returns sql to list views</h2>
|
||||
<pre>view_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,217 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \DB_Util</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the connection object for later use"><span class="description">Save a reference to the connection object for later use</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public "><a href="#backup_data" title="backup_data :: Return an SQL file with the database data as insert statements"><span class="description">Return an SQL file with the database data as insert statements</span><pre>backup_data()</pre></a></li>
|
||||
<li class="method public "><a href="#backup_structure" title="backup_structure :: Return an SQL file with the database table structure"><span class="description">Return an SQL file with the database table structure</span><pre>backup_structure()</pre></a></li>
|
||||
<li class="method public "><a href="#create_table" title="create_table :: Get database-specific sql to create a new table"><span class="description">Get database-specific sql to create a new table</span><pre>create_table()</pre></a></li>
|
||||
<li class="method public "><a href="#delete_table" title="delete_table :: Get database-specific sql to drop a table"><span class="description">Get database-specific sql to drop a table</span><pre>delete_table()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private "><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CDB_Util" id="\DB_Util"></a><div href="../classes/DB_Util.html" class="element class">
|
||||
<p class="short_description">Abstract class defining database / table creation methods</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Query.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Query</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
|
||||
<h2>Enable calling driver methods</h2>
|
||||
<pre>__call(string $method, array $args) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$method</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Save a reference to the connection object for later use</h2>
|
||||
<pre>__construct(object $conn) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$conn</h4>
|
||||
<code>object</code><p>&$conn</p>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse">
|
||||
<h2>Return an SQL file with the database data as insert statements</h2>
|
||||
<pre>backup_data() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>abstract</th>
|
||||
<td></td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse">
|
||||
<h2>Return an SQL file with the database table structure</h2>
|
||||
<pre>backup_structure() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>abstract</th>
|
||||
<td></td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse">
|
||||
<h2>Get database-specific sql to create a new table</h2>
|
||||
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>abstract</th>
|
||||
<td></td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$columns</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$constraints</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$indexes</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse">
|
||||
<h2>Get database-specific sql to drop a table</h2>
|
||||
<pre>delete_table(string $name) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>abstract</th>
|
||||
<td></td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
|
||||
<h2>Reference to the current connection object</h2>
|
||||
<pre>$conn </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,876 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \Firebird</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Open the link to the database"><span class="description">Open the link to the database</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
|
||||
</span><pre>__sleep()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
|
||||
</span><pre>__wakeup()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
|
||||
<li class="method public "><a href="#beginTransaction" title="beginTransaction :: Start a database transaction"><span class="description">Start a database transaction</span><pre>beginTransaction()</pre></a></li>
|
||||
<li class="method public "><a href="#commit" title="commit :: Commit a database transaction"><span class="description">Commit a database transaction</span><pre>commit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
|
||||
<li class="method public "><a href="#errorCode" title="errorCode :: Method to emulate PDO->errorCode"><span class="description">Method to emulate PDO->errorCode</span><pre>errorCode()</pre></a></li>
|
||||
<li class="method public "><a href="#errorInfo" title="errorInfo :: Method to emulate PDO->errorInfo / PDOStatement->errorInfo"><span class="description">Method to emulate PDO->errorInfo / PDOStatement->errorInfo</span><pre>errorInfo()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
|
||||
</span><pre>exec()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
|
||||
</span><pre>getAttribute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
|
||||
</span><pre>getAvailableDrivers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
|
||||
the connection/database"><span class="description">Retreives an array of non-user-created tables for
|
||||
the connection/database</span><pre>get_system_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
|
||||
</span><pre>inTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
|
||||
</span><pre>lastInsertId()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
|
||||
<li class="method public "><a href="#prepare" title="prepare :: Emulate PDO prepare"><span class="description">Emulate PDO prepare</span><pre>prepare()</pre></a></li>
|
||||
<li class="method public "><a href="#prepare_execute" title="prepare_execute :: Prepare and execute a query"><span class="description">Prepare and execute a query</span><pre>prepare_execute()</pre></a></li>
|
||||
<li class="method public "><a href="#prepare_query" title="prepare_query :: Bind a prepared query with arguments for executing"><span class="description">Bind a prepared query with arguments for executing</span><pre>prepare_query()</pre></a></li>
|
||||
<li class="method public "><a href="#query" title="query :: Wrapper public function to better match PDO"><span class="description">Wrapper public function to better match PDO</span><pre>query()</pre></a></li>
|
||||
<li class="method public "><a href="#quote" title="quote :: Method to emulate PDO->quote"><span class="description">Method to emulate PDO->quote</span><pre>quote()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
|
||||
<li class="method public "><a href="#rollBack" title="rollBack :: Rollback a transaction"><span class="description">Rollback a transaction</span><pre>rollBack()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
|
||||
</span><pre>setAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#switch_db" title="switch_db :: Doesn't apply to Firebird"><span class="description">Doesn't apply to Firebird</span><pre>switch_db()</pre></a></li>
|
||||
<li class="method public "><a href="#truncate" title="truncate :: Empty a database table"><span class="description">Empty a database table</span><pre>truncate()</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
|
||||
<li class="method protected inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
|
||||
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="property protected "><a href="#%24conn" title="$conn :: Reference to the connection resource"><span class="description">Reference to the connection resource</span><pre>$conn</pre></a></li>
|
||||
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
|
||||
<li class="property protected "><a href="#%24statement" title="$statement :: Reference to the last query executed"><span class="description">Reference to the last query executed</span><pre>$statement</pre></a></li>
|
||||
<li class="property protected "><a href="#%24statement_link" title="$statement_link :: Reference to the resource returned by
|
||||
the last query executed"><span class="description">Reference to the resource returned by
|
||||
the last query executed</span><pre>$statement_link</pre></a></li>
|
||||
<li class="property protected "><a href="#%24trans" title="$trans :: Reference to the current transaction"><span class="description">Reference to the current transaction</span><pre>$trans</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CFirebird" id="\Firebird"></a><div href="../classes/Firebird.html" class="element class">
|
||||
<p class="short_description">Firebird Database class</p>
|
||||
<div class="details">
|
||||
<p class="long_description"><p>PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.</p></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Open the link to the database</h2>
|
||||
<pre>__construct(string $dbpath, string $user, string $pass) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$dbpath</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$user</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$pass</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
|
||||
<h2>__sleep()
|
||||
</h2>
|
||||
<pre>__sleep() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__sleep()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__sleep()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
|
||||
<h2>__wakeup()
|
||||
</h2>
|
||||
<pre>__wakeup() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__wakeup()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__wakeup()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
|
||||
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
|
||||
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::affected_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
|
||||
<h2>Start a database transaction</h2>
|
||||
<pre>beginTransaction() : bool</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>bool</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
|
||||
<h2>Commit a database transaction</h2>
|
||||
<pre>commit() : bool</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>bool</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
|
||||
<h2>Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</h2>
|
||||
<pre>empty_table(string $table) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::empty_table()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
|
||||
<h2>Method to emulate PDO->errorCode</h2>
|
||||
<pre>errorCode() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
|
||||
<h2>Method to emulate PDO->errorInfo / PDOStatement->errorInfo</h2>
|
||||
<pre>errorInfo() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
|
||||
<h2>exec()
|
||||
</h2>
|
||||
<pre>exec() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::exec()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::exec()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
|
||||
<h2>getAttribute()
|
||||
</h2>
|
||||
<pre>getAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
|
||||
<h2>getAvailableDrivers()
|
||||
</h2>
|
||||
<pre>getAvailableDrivers() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
|
||||
<h2>Retrieve column information for the current database table</h2>
|
||||
<pre>get_columns(string $table) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_columns()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
|
||||
<h2>Return list of dbs for the current connection, if possible</h2>
|
||||
<pre>get_dbs() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_dbs()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
|
||||
<h2>Return list of function for the current database</h2>
|
||||
<pre>get_functions() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_functions()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
|
||||
<h2>Return the last error for the current database connection</h2>
|
||||
<pre>get_last_error() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_last_error()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
|
||||
<h2>Return list of stored procedures for the current database</h2>
|
||||
<pre>get_procedures() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_procedures()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
|
||||
<h2>Retreives the data from a select query</h2>
|
||||
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_query_data()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
|
||||
<h2>Return schemas for databases that list them</h2>
|
||||
<pre>get_schemas() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_schemas()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
|
||||
<h2>Return list of sequences for the current database, if they exist</h2>
|
||||
<pre>get_sequences() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_sequences()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
|
||||
<h2>Retreives an array of non-user-created tables for
|
||||
the connection/database</h2>
|
||||
<pre>get_system_tables() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_system_tables()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
|
||||
<h2>Return list of tables for the current database</h2>
|
||||
<pre>get_tables() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_tables()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
|
||||
<h2>Return list of triggers for the current database</h2>
|
||||
<pre>get_triggers() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_triggers()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
|
||||
<h2>Retrieve list of data types for the database</h2>
|
||||
<pre>get_types() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_types()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
|
||||
<h2>Return list of views for the current database</h2>
|
||||
<pre>get_views() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_views()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
|
||||
<h2>inTransaction()
|
||||
</h2>
|
||||
<pre>inTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::inTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::inTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
|
||||
<h2>lastInsertId()
|
||||
</h2>
|
||||
<pre>lastInsertId() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
|
||||
<h2>Return the number of rows returned for a SELECT query</h2>
|
||||
<pre>num_rows() : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::num_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
|
||||
<h2>Emulate PDO prepare</h2>
|
||||
<pre>prepare(string $query, array $options) : <a href="../classes/Firebird.html">\Firebird</a></pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>fluent</th>
|
||||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$query</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$options</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="../classes/Firebird.html">\Firebird</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
|
||||
<h2>Prepare and execute a query</h2>
|
||||
<pre>prepare_execute(string $sql, array $args) : resource</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>resource</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
|
||||
<h2>Bind a prepared query with arguments for executing</h2>
|
||||
<pre>prepare_query(string $sql, array $params) : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
|
||||
<h2>Wrapper public function to better match PDO</h2>
|
||||
<pre>query(string $sql) : <a href="../classes/Firebird.html">\Firebird</a></pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>fluent</th>
|
||||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="../classes/Firebird.html">\Firebird</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
|
||||
<h2>Method to emulate PDO->quote</h2>
|
||||
<pre>quote(string $str, int $param_type) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$str</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$param_type</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
|
||||
<h2>Surrounds the string with the databases identifier escape characters</h2>
|
||||
<pre>quote_ident(mixed $ident) : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote_ident()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$ident</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
|
||||
<h2>Rollback a transaction</h2>
|
||||
<pre>rollBack() : bool</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>bool</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
|
||||
<h2>setAttribute()
|
||||
</h2>
|
||||
<pre>setAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::setAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::setAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="switch_db" id="switch_db"></a><div class="element clickable method public switch_db" data-toggle="collapse" data-target=".switch_db .collapse">
|
||||
<h2>Doesn't apply to Firebird</h2>
|
||||
<pre>switch_db(string $name) : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
|
||||
<h2>Empty a database table</h2>
|
||||
<pre>truncate(string $table) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
|
||||
<h2>Helper method for quote_ident</h2>
|
||||
<pre>_quote(mixed $str) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::_quote()</td>
|
||||
</tr></table>
|
||||
<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>
|
||||
<a name="driver_query" id="driver_query"></a><div class="element clickable method protected driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
|
||||
<h2>Method to simplify retreiving db results for meta-data queries</h2>
|
||||
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::driver_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$filtered_index</h4>
|
||||
<code>bool</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
|
||||
<h2>Reference to sql sub class</h2>
|
||||
<pre>$sql : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$sql</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
|
||||
<h2>Reference to util sub class</h2>
|
||||
<pre>$util : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$util</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24conn" id="$conn"> </a><div class="element clickable property protected $conn" data-toggle="collapse" data-target=".$conn .collapse">
|
||||
<h2>Reference to the connection resource</h2>
|
||||
<pre>$conn : resource</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
|
||||
<h2>Character to escape identifiers</h2>
|
||||
<pre>$escape_char : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$escape_char</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
|
||||
<h2>Reference to the last query executed</h2>
|
||||
<pre>$statement : object</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24statement_link" id="$statement_link"> </a><div class="element clickable property protected $statement_link" data-toggle="collapse" data-target=".$statement_link .collapse">
|
||||
<h2>Reference to the resource returned by
|
||||
the last query executed</h2>
|
||||
<pre>$statement_link : resource</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24trans" id="$trans"> </a><div class="element clickable property protected $trans" data-toggle="collapse" data-target=".$trans .collapse">
|
||||
<h2>Reference to the current transaction</h2>
|
||||
<pre>$trans : resource</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,512 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \Firebird_Result</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Create the object by passing the resource for
|
||||
the query"><span class="description">Create the object by passing the resource for
|
||||
the query</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public "><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
|
||||
</span><pre>__sleep()</pre></a></li>
|
||||
<li class="method public "><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
|
||||
</span><pre>__wakeup()</pre></a></li>
|
||||
<li class="method public "><a href="#bindColumn" title="bindColumn :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindColumn()</pre></a></li>
|
||||
<li class="method public "><a href="#bindParam" title="bindParam :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindParam()</pre></a></li>
|
||||
<li class="method public "><a href="#bindValue" title="bindValue :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindValue()</pre></a></li>
|
||||
<li class="method public "><a href="#closeCursor" title="closeCursor :: "><span class="description">closeCursor()
|
||||
</span><pre>closeCursor()</pre></a></li>
|
||||
<li class="method public "><a href="#columnCount" title="columnCount :: "><span class="description">columnCount()
|
||||
</span><pre>columnCount()</pre></a></li>
|
||||
<li class="method public "><a href="#debugDumpParams" title="debugDumpParams :: "><span class="description">debugDumpParams()
|
||||
</span><pre>debugDumpParams()</pre></a></li>
|
||||
<li class="method public "><a href="#errorCode" title="errorCode :: Method to emulate PDOStatement->errorCode"><span class="description">Method to emulate PDOStatement->errorCode</span><pre>errorCode()</pre></a></li>
|
||||
<li class="method public "><a href="#errorInfo" title="errorInfo :: Method to emulate PDO->errorInfo / PDOStatement->errorInfo"><span class="description">Method to emulate PDO->errorInfo / PDOStatement->errorInfo</span><pre>errorInfo()</pre></a></li>
|
||||
<li class="method public "><a href="#execute" title="execute :: Run a prepared statement query"><span class="description">Run a prepared statement query</span><pre>execute()</pre></a></li>
|
||||
<li class="method public "><a href="#fetch" title="fetch :: Emulate PDO fetch public function"><span class="description">Emulate PDO fetch public function</span><pre>fetch()</pre></a></li>
|
||||
<li class="method public "><a href="#fetchAll" title="fetchAll :: Emulate PDO fetchAll public function"><span class="description">Emulate PDO fetchAll public function</span><pre>fetchAll()</pre></a></li>
|
||||
<li class="method public "><a href="#fetchColumn" title="fetchColumn :: Emulate PDOStatement::fetchColumn"><span class="description">Emulate PDOStatement::fetchColumn</span><pre>fetchColumn()</pre></a></li>
|
||||
<li class="method public "><a href="#fetchObject" title="fetchObject :: Emulate PDOStatement::fetchObject, but only for the default use"><span class="description">Emulate PDOStatement::fetchObject, but only for the default use</span><pre>fetchObject()</pre></a></li>
|
||||
<li class="method public "><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
|
||||
</span><pre>getAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#getColumnMeta" title="getColumnMeta :: "><span class="description">getColumnMeta()
|
||||
</span><pre>getColumnMeta()</pre></a></li>
|
||||
<li class="method public "><a href="#nextRowset" title="nextRowset :: "><span class="description">nextRowset()
|
||||
</span><pre>nextRowset()</pre></a></li>
|
||||
<li class="method public "><a href="#rowCount" title="rowCount :: Return the number of rows affected by the previous query"><span class="description">Return the number of rows affected by the previous query</span><pre>rowCount()</pre></a></li>
|
||||
<li class="method public "><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
|
||||
</span><pre>setAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#setFetchMode" title="setFetchMode :: "><span class="description">setFetchMode()
|
||||
</span><pre>setFetchMode()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private "><a href="#%24result" title="$result :: Data pulled from query"><span class="description">Data pulled from query</span><pre>$result</pre></a></li>
|
||||
<li class="property private "><a href="#%24row" title="$row :: Current row in result array"><span class="description">Current row in result array</span><pre>$row</pre></a></li>
|
||||
<li class="property private "><a href="#%24statement" title="$statement :: Reference to fbird resource"><span class="description">Reference to fbird resource</span><pre>$statement</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CFirebird_Result" id="\Firebird_Result"></a><div href="../classes/Firebird_Result.html" class="element class">
|
||||
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
|
||||
data-fetching methods</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Create the object by passing the resource for
|
||||
the query</h2>
|
||||
<pre>__construct(resource $link) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$link</h4>
|
||||
<code>resource</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
|
||||
<h2>__sleep()
|
||||
</h2>
|
||||
<pre>__sleep() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::__sleep()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
|
||||
<h2>__wakeup()
|
||||
</h2>
|
||||
<pre>__wakeup() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::__wakeup()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="bindColumn" id="bindColumn"></a><div class="element clickable method public bindColumn" data-toggle="collapse" data-target=".bindColumn .collapse">
|
||||
<h2>Invalidate method for data consistency</h2>
|
||||
<pre>bindColumn(mixed $column, mixed $param, int $type, mixed $maxlen, array $driverdata) : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$column</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$param</h4>
|
||||
<code>mixed</code><p>&$param</p>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$type</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$maxlen</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$driverdata</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="bindParam" id="bindParam"></a><div class="element clickable method public bindParam" data-toggle="collapse" data-target=".bindParam .collapse">
|
||||
<h2>Invalidate method for data consistency</h2>
|
||||
<pre>bindParam(mixed $parameter, mixed $variable, int $data_type, mixed $maxlen, array $driverdata) : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$parameter</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$variable</h4>
|
||||
<code>mixed</code><p>&$variable</p>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$data_type</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$maxlen</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$driverdata</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="bindValue" id="bindValue"></a><div class="element clickable method public bindValue" data-toggle="collapse" data-target=".bindValue .collapse">
|
||||
<h2>Invalidate method for data consistency</h2>
|
||||
<pre>bindValue(mixed $parameter, mixed $variable, int $data_type) : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$parameter</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$variable</h4>
|
||||
<code>mixed</code><p>&$variable</p>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$data_type</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="closeCursor" id="closeCursor"></a><div class="element clickable method public closeCursor" data-toggle="collapse" data-target=".closeCursor .collapse">
|
||||
<h2>closeCursor()
|
||||
</h2>
|
||||
<pre>closeCursor() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::closeCursor()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="columnCount" id="columnCount"></a><div class="element clickable method public columnCount" data-toggle="collapse" data-target=".columnCount .collapse">
|
||||
<h2>columnCount()
|
||||
</h2>
|
||||
<pre>columnCount() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::columnCount()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="debugDumpParams" id="debugDumpParams"></a><div class="element clickable method public debugDumpParams" data-toggle="collapse" data-target=".debugDumpParams .collapse">
|
||||
<h2>debugDumpParams()
|
||||
</h2>
|
||||
<pre>debugDumpParams() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::debugDumpParams()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
|
||||
<h2>Method to emulate PDOStatement->errorCode</h2>
|
||||
<pre>errorCode() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
|
||||
<h2>Method to emulate PDO->errorInfo / PDOStatement->errorInfo</h2>
|
||||
<pre>errorInfo() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="execute" id="execute"></a><div class="element clickable method public execute" data-toggle="collapse" data-target=".execute .collapse">
|
||||
<h2>Run a prepared statement query</h2>
|
||||
<pre>execute(array $args) : bool</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>bool</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="fetch" id="fetch"></a><div class="element clickable method public fetch" data-toggle="collapse" data-target=".fetch .collapse">
|
||||
<h2>Emulate PDO fetch public function</h2>
|
||||
<pre>fetch(int $fetch_style, mixed $statement, mixed $offset) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$fetch_style</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$offset</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="fetchAll" id="fetchAll"></a><div class="element clickable method public fetchAll" data-toggle="collapse" data-target=".fetchAll .collapse">
|
||||
<h2>Emulate PDO fetchAll public function</h2>
|
||||
<pre>fetchAll(int $fetch_style, mixed $statement, mixed $ctor_args) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$fetch_style</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$ctor_args</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="fetchColumn" id="fetchColumn"></a><div class="element clickable method public fetchColumn" data-toggle="collapse" data-target=".fetchColumn .collapse">
|
||||
<h2>Emulate PDOStatement::fetchColumn</h2>
|
||||
<pre>fetchColumn(int $column_num) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$column_num</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="fetchObject" id="fetchObject"></a><div class="element clickable method public fetchObject" data-toggle="collapse" data-target=".fetchObject .collapse">
|
||||
<h2>Emulate PDOStatement::fetchObject, but only for the default use</h2>
|
||||
<pre>fetchObject(string $class_name, array $ctor_args) : <a href="http://php.net/manual/en/class.stdclass.php">\stdClass</a></pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$class_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$ctor_args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="http://php.net/manual/en/class.stdclass.php">\stdClass</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
|
||||
<h2>getAttribute()
|
||||
</h2>
|
||||
<pre>getAttribute() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::getAttribute()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getColumnMeta" id="getColumnMeta"></a><div class="element clickable method public getColumnMeta" data-toggle="collapse" data-target=".getColumnMeta .collapse">
|
||||
<h2>getColumnMeta()
|
||||
</h2>
|
||||
<pre>getColumnMeta() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::getColumnMeta()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="nextRowset" id="nextRowset"></a><div class="element clickable method public nextRowset" data-toggle="collapse" data-target=".nextRowset .collapse">
|
||||
<h2>nextRowset()
|
||||
</h2>
|
||||
<pre>nextRowset() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::nextRowset()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="rowCount" id="rowCount"></a><div class="element clickable method public rowCount" data-toggle="collapse" data-target=".rowCount .collapse">
|
||||
<h2>Return the number of rows affected by the previous query</h2>
|
||||
<pre>rowCount() : int</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
|
||||
<h2>setAttribute()
|
||||
</h2>
|
||||
<pre>setAttribute() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::setAttribute()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setFetchMode" id="setFetchMode"></a><div class="element clickable method public setFetchMode" data-toggle="collapse" data-target=".setFetchMode .collapse">
|
||||
<h2>setFetchMode()
|
||||
</h2>
|
||||
<pre>setFetchMode() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDOStatement::setFetchMode()</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24result" id="$result"> </a><div class="element clickable property private $result" data-toggle="collapse" data-target=".$result .collapse">
|
||||
<h2>Data pulled from query</h2>
|
||||
<pre>$result </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>param</th>
|
||||
<td><p>mixed</p></td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24row" id="$row"> </a><div class="element clickable property private $row" data-toggle="collapse" data-target=".$row .collapse">
|
||||
<h2>Current row in result array</h2>
|
||||
<pre>$row : int</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24statement" id="$statement"> </a><div class="element clickable property private $statement" data-toggle="collapse" data-target=".$statement .collapse">
|
||||
<h2>Reference to fbird resource</h2>
|
||||
<pre>$statement : resource</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,316 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \Firebird_SQL</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
|
||||
<li class="method public "><a href="#column_list" title="column_list :: 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="#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 inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
|
||||
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
|
||||
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
|
||||
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
|
||||
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
|
||||
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
|
||||
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
|
||||
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
|
||||
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CFirebird_SQL" id="\Firebird_SQL"></a><div href="../classes/Firebird_SQL.html" class="element class">
|
||||
<p class="short_description">Firebird Specific SQL</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
|
||||
<h2>Get the 'average' keyword</h2>
|
||||
<pre>avg() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::avg()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
|
||||
<h2>Return sql to list columns of the specified table</h2>
|
||||
<pre>column_list(string $table) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse">
|
||||
<h2>Returns sql to list other databases</h2>
|
||||
<pre>db_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
|
||||
<h2>Get the 'distinct' keyword</h2>
|
||||
<pre>distinct() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::distinct()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
|
||||
<h2>Return sql to list functions</h2>
|
||||
<pre>function_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
|
||||
<h2>Limit clause</h2>
|
||||
<pre>limit(string $sql, int $limit, int $offset) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$limit</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$offset</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
|
||||
<h2>Get the max keyword sql</h2>
|
||||
<pre>max() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::max()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
|
||||
<h2>Get the min keyword sql</h2>
|
||||
<pre>min() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::min()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
|
||||
<h2>Return sql to list stored procedures</h2>
|
||||
<pre>procedure_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse">
|
||||
<h2>Random ordering keyword</h2>
|
||||
<pre>random() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse">
|
||||
<h2>Return sql to list sequences</h2>
|
||||
<pre>sequence_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
|
||||
<h2>Get the 'sum' keyword</h2>
|
||||
<pre>sum() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::sum()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
|
||||
<h2>Returns sql to list system tables</h2>
|
||||
<pre>system_table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse">
|
||||
<h2>Returns sql to list tables</h2>
|
||||
<pre>table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse">
|
||||
<h2>Returns sql to list triggers</h2>
|
||||
<pre>trigger_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse">
|
||||
<h2>SQL to show list of field types</h2>
|
||||
<pre>type_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse">
|
||||
<h2>Returns sql to list views</h2>
|
||||
<pre>view_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,220 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \Firebird_Util</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the 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="#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="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
|
||||
<li class="method public "><a href="#create_table" title="create_table :: Convienience public function to generate sql for creating a db table"><span class="description">Convienience public function to generate sql for creating a db table</span><pre>create_table()</pre></a></li>
|
||||
<li class="method public "><a href="#delete_table" title="delete_table :: Drop the selected table"><span class="description">Drop the selected table</span><pre>delete_table()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CFirebird_Util" id="\Firebird_Util"></a><div href="../classes/Firebird_Util.html" class="element class">
|
||||
<p class="short_description">Firebird-specific backup, import and creation methods</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
|
||||
<h2>Enable calling driver methods</h2>
|
||||
<pre>__call(string $method, array $args) </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::__call()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$method</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Save a reference to the current connection object</h2>
|
||||
<pre>__construct(object $conn) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$conn</h4>
|
||||
<code>object</code><p>&$conn</p>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse">
|
||||
<h2>Create an SQL backup file for the current database's data</h2>
|
||||
<pre>backup_data(array $exclude, bool $system_tables) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$exclude</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$system_tables</h4>
|
||||
<code>bool</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse">
|
||||
<h2>Create an SQL backup file for the current database's structure</h2>
|
||||
<pre>backup_structure() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse">
|
||||
<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>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$fields</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$constraints</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$indexes</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse">
|
||||
<h2>Drop the selected table</h2>
|
||||
<pre>delete_table(string $name) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
|
||||
<h2>Reference to the current connection object</h2>
|
||||
<pre>$conn </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::$$conn</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -436,7 +433,7 @@ dynamic methods</h2>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -762,7 +759,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -202,7 +199,7 @@ of the singleton</h2>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -712,7 +709,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -642,7 +639,7 @@ Used for outputing HTML</h2>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -974,7 +971,7 @@ supports</p></p>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -146,7 +143,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -1,912 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \MySQL</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Connect to MySQL Database"><span class="description">Connect to MySQL Database</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
|
||||
</span><pre>__sleep()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
|
||||
</span><pre>__wakeup()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
|
||||
</span><pre>beginTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#commit" title="commit :: "><span class="description">commit()
|
||||
</span><pre>commit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
|
||||
</span><pre>errorCode()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
|
||||
</span><pre>errorInfo()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
|
||||
</span><pre>exec()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
|
||||
</span><pre>getAttribute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
|
||||
</span><pre>getAvailableDrivers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
|
||||
the connection/database"><span class="description">Retreives an array of non-user-created tables for
|
||||
the connection/database</span><pre>get_system_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
|
||||
</span><pre>inTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
|
||||
</span><pre>lastInsertId()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare" title="prepare :: "><span class="description">prepare()
|
||||
</span><pre>prepare()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#query" title="query :: "><span class="description">query()
|
||||
</span><pre>query()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
|
||||
</span><pre>quote()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
|
||||
</span><pre>rollBack()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
|
||||
</span><pre>setAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#switch_db" title="switch_db :: Connect to a different database"><span class="description">Connect to a different database</span><pre>switch_db()</pre></a></li>
|
||||
<li class="method public "><a href="#truncate" title="truncate :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
|
||||
<li class="method protected inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
|
||||
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="property protected "><a href="#%24escape_char" title="$escape_char :: Set the backtick as the MySQL escape character"><span class="description">Set the backtick as the MySQL escape character</span><pre>$escape_char</pre></a></li>
|
||||
<li class="property protected inherited"><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CMySQL" id="\MySQL"></a><div href="../classes/MySQL.html" class="element class">
|
||||
<p class="short_description">MySQL specific class</p>
|
||||
<div class="details">
|
||||
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Connect to MySQL Database</h2>
|
||||
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$dsn</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$username</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$password</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$options</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
|
||||
<h2>__sleep()
|
||||
</h2>
|
||||
<pre>__sleep() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__sleep()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__sleep()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
|
||||
<h2>__wakeup()
|
||||
</h2>
|
||||
<pre>__wakeup() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__wakeup()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__wakeup()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
|
||||
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
|
||||
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::affected_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
|
||||
<h2>beginTransaction()
|
||||
</h2>
|
||||
<pre>beginTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::beginTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::beginTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
|
||||
<h2>commit()
|
||||
</h2>
|
||||
<pre>commit() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::commit()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::commit()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
|
||||
<h2>Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</h2>
|
||||
<pre>empty_table(string $table) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::empty_table()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
|
||||
<h2>errorCode()
|
||||
</h2>
|
||||
<pre>errorCode() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorCode()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::errorCode()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
|
||||
<h2>errorInfo()
|
||||
</h2>
|
||||
<pre>errorInfo() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorInfo()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::errorInfo()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
|
||||
<h2>exec()
|
||||
</h2>
|
||||
<pre>exec() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::exec()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::exec()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
|
||||
<h2>getAttribute()
|
||||
</h2>
|
||||
<pre>getAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
|
||||
<h2>getAvailableDrivers()
|
||||
</h2>
|
||||
<pre>getAvailableDrivers() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
|
||||
<h2>Retrieve column information for the current database table</h2>
|
||||
<pre>get_columns(string $table) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_columns()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
|
||||
<h2>Return list of dbs for the current connection, if possible</h2>
|
||||
<pre>get_dbs() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_dbs()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
|
||||
<h2>Return list of function for the current database</h2>
|
||||
<pre>get_functions() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_functions()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
|
||||
<h2>Return the last error for the current database connection</h2>
|
||||
<pre>get_last_error() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_last_error()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
|
||||
<h2>Return list of stored procedures for the current database</h2>
|
||||
<pre>get_procedures() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_procedures()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
|
||||
<h2>Retreives the data from a select query</h2>
|
||||
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_query_data()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
|
||||
<h2>Return schemas for databases that list them</h2>
|
||||
<pre>get_schemas() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_schemas()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
|
||||
<h2>Return list of sequences for the current database, if they exist</h2>
|
||||
<pre>get_sequences() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_sequences()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
|
||||
<h2>Retreives an array of non-user-created tables for
|
||||
the connection/database</h2>
|
||||
<pre>get_system_tables() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_system_tables()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
|
||||
<h2>Return list of tables for the current database</h2>
|
||||
<pre>get_tables() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_tables()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
|
||||
<h2>Return list of triggers for the current database</h2>
|
||||
<pre>get_triggers() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_triggers()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
|
||||
<h2>Retrieve list of data types for the database</h2>
|
||||
<pre>get_types() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_types()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
|
||||
<h2>Return list of views for the current database</h2>
|
||||
<pre>get_views() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_views()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
|
||||
<h2>inTransaction()
|
||||
</h2>
|
||||
<pre>inTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::inTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::inTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
|
||||
<h2>lastInsertId()
|
||||
</h2>
|
||||
<pre>lastInsertId() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
|
||||
<h2>Return the number of rows returned for a SELECT query</h2>
|
||||
<pre>num_rows() : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::num_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
|
||||
<h2>prepare()
|
||||
</h2>
|
||||
<pre>prepare() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::prepare()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
|
||||
<h2>Create and execute a prepared statement with the provided parameters</h2>
|
||||
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare_execute()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
|
||||
<h2>Simplifies prepared statements for database queries</h2>
|
||||
<pre>prepare_query(string $sql, array $data) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$data</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response">
|
||||
<code>mixed</code>PDOStatement / FALSE</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
|
||||
<h2>query()
|
||||
</h2>
|
||||
<pre>query() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::query()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::query()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
|
||||
<h2>quote()
|
||||
</h2>
|
||||
<pre>quote() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::quote()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
|
||||
<h2>Surrounds the string with the databases identifier escape characters</h2>
|
||||
<pre>quote_ident(mixed $ident) : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote_ident()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$ident</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
|
||||
<h2>rollBack()
|
||||
</h2>
|
||||
<pre>rollBack() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::rollBack()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::rollBack()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
|
||||
<h2>setAttribute()
|
||||
</h2>
|
||||
<pre>setAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::setAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::setAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="switch_db" id="switch_db"></a><div class="element clickable method public switch_db" data-toggle="collapse" data-target=".switch_db .collapse">
|
||||
<h2>Connect to a different database</h2>
|
||||
<pre>switch_db(string $name) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
|
||||
<h2>Empty a table</h2>
|
||||
<pre>truncate(string $table) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
|
||||
<h2>Helper method for quote_ident</h2>
|
||||
<pre>_quote(mixed $str) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::_quote()</td>
|
||||
</tr></table>
|
||||
<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>
|
||||
<a name="driver_query" id="driver_query"></a><div class="element clickable method protected driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
|
||||
<h2>Method to simplify retreiving db results for meta-data queries</h2>
|
||||
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::driver_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$filtered_index</h4>
|
||||
<code>bool</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
|
||||
<h2>Reference to sql sub class</h2>
|
||||
<pre>$sql : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$sql</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
|
||||
<h2>Reference to util sub class</h2>
|
||||
<pre>$util : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$util</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
|
||||
<h2>Set the backtick as the MySQL escape character</h2>
|
||||
<pre>$escape_char : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
|
||||
<h2>Reference to the last executed query</h2>
|
||||
<pre>$statement : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$statement</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,321 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \MySQL_SQL</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
|
||||
<li class="method public "><a href="#column_list" title="column_list :: 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="#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 inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
|
||||
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
|
||||
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
|
||||
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
|
||||
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
|
||||
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
|
||||
<li class="method public "><a href="#system_table_list" title="system_table_list :: Overridden in MySQL class"><span class="description">Overridden in MySQL class</span><pre>system_table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
|
||||
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
|
||||
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CMySQL_SQL" id="\MySQL_SQL"></a><div href="../classes/MySQL_SQL.html" class="element class">
|
||||
<p class="short_description">MySQL specifc SQL</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
|
||||
<h2>Get the 'average' keyword</h2>
|
||||
<pre>avg() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::avg()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
|
||||
<h2>SQL to show infromation about columns in a table</h2>
|
||||
<pre>column_list(string $table) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse">
|
||||
<h2>Returns sql to list other databases</h2>
|
||||
<pre>db_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
|
||||
<h2>Get the 'distinct' keyword</h2>
|
||||
<pre>distinct() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::distinct()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
|
||||
<h2>Return sql to list functions</h2>
|
||||
<pre>function_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
|
||||
<h2>Limit clause</h2>
|
||||
<pre>limit(string $sql, int $limit, int $offset) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$limit</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$offset</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
|
||||
<h2>Get the max keyword sql</h2>
|
||||
<pre>max() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::max()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
|
||||
<h2>Get the min keyword sql</h2>
|
||||
<pre>min() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::min()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
|
||||
<h2>Return sql to list stored procedures</h2>
|
||||
<pre>procedure_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse">
|
||||
<h2>Random ordering keyword</h2>
|
||||
<pre>random() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse">
|
||||
<h2>Return sql to list sequences</h2>
|
||||
<pre>sequence_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
|
||||
<h2>Get the 'sum' keyword</h2>
|
||||
<pre>sum() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::sum()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
|
||||
<h2>Overridden in MySQL class</h2>
|
||||
<pre>system_table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse">
|
||||
<h2>Returns sql to list tables</h2>
|
||||
<pre>table_list(string $database) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$database</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse">
|
||||
<h2>Returns sql to list triggers</h2>
|
||||
<pre>trigger_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse">
|
||||
<h2>SQL to show list of field types</h2>
|
||||
<pre>type_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse">
|
||||
<h2>Returns sql to list views</h2>
|
||||
<pre>view_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,216 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \MySQL_Util</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the 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="#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="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
|
||||
<li class="method public "><a href="#create_table" title="create_table :: Convienience public function for creating a new MySQL table"><span class="description">Convienience public function for creating a new MySQL table</span><pre>create_table()</pre></a></li>
|
||||
<li class="method public "><a href="#delete_table" title="delete_table :: Convience public function for droping a table"><span class="description">Convience public function for droping a table</span><pre>delete_table()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CMySQL_Util" id="\MySQL_Util"></a><div href="../classes/MySQL_Util.html" class="element class">
|
||||
<p class="short_description">MySQL-specific backup, import and creation methods</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
|
||||
<h2>Enable calling driver methods</h2>
|
||||
<pre>__call(string $method, array $args) </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::__call()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$method</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Save a reference to the current connection object</h2>
|
||||
<pre>__construct(object $conn) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$conn</h4>
|
||||
<code>object</code><p>&$conn</p>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse">
|
||||
<h2>Create an SQL backup file for the current database's data</h2>
|
||||
<pre>backup_data(array $exclude) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$exclude</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse">
|
||||
<h2>Create an SQL backup file for the current database's structure</h2>
|
||||
<pre>backup_structure() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse">
|
||||
<h2>Convienience public function for creating a new MySQL table</h2>
|
||||
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$columns</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$constraints</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$indexes</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse">
|
||||
<h2>Convience public function for droping a table</h2>
|
||||
<pre>delete_table(string $name) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
|
||||
<h2>Reference to the current connection object</h2>
|
||||
<pre>$conn </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::$$conn</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,914 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \ODBC</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: 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 inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
|
||||
</span><pre>__sleep()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
|
||||
</span><pre>__wakeup()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
|
||||
</span><pre>beginTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#commit" title="commit :: "><span class="description">commit()
|
||||
</span><pre>commit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
|
||||
</span><pre>errorCode()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
|
||||
</span><pre>errorInfo()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
|
||||
</span><pre>exec()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
|
||||
</span><pre>getAttribute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
|
||||
</span><pre>getAvailableDrivers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
|
||||
the connection/database"><span class="description">Retreives an array of non-user-created tables for
|
||||
the connection/database</span><pre>get_system_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
|
||||
</span><pre>inTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
|
||||
</span><pre>lastInsertId()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare" title="prepare :: "><span class="description">prepare()
|
||||
</span><pre>prepare()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#query" title="query :: "><span class="description">query()
|
||||
</span><pre>query()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
|
||||
</span><pre>quote()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
|
||||
</span><pre>rollBack()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
|
||||
</span><pre>setAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#switch_db" title="switch_db :: Doesn't apply to ODBC"><span class="description">Doesn't apply to ODBC</span><pre>switch_db()</pre></a></li>
|
||||
<li class="method public "><a href="#truncate" title="truncate :: Empty the current database"><span class="description">Empty the current database</span><pre>truncate()</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
|
||||
<li class="method protected inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
|
||||
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="property protected "><a href="#%24escape_char" title="$escape_char :: Don't define the escape char - or define it in sub-drivers in a refactor"><span class="description">Don't define the escape char - or define it in sub-drivers in a refactor</span><pre>$escape_char</pre></a></li>
|
||||
<li class="property protected inherited"><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CODBC" id="\ODBC"></a><div href="../classes/ODBC.html" class="element class">
|
||||
<p class="short_description">ODBC Database Driver</p>
|
||||
<div class="details">
|
||||
<p class="long_description"><p>For general database access for databases not specified by the main drivers</p></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Use ODBC to connect to a database</h2>
|
||||
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$dsn</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$username</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$password</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$options</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
|
||||
<h2>__sleep()
|
||||
</h2>
|
||||
<pre>__sleep() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__sleep()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__sleep()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
|
||||
<h2>__wakeup()
|
||||
</h2>
|
||||
<pre>__wakeup() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__wakeup()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__wakeup()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
|
||||
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
|
||||
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::affected_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
|
||||
<h2>beginTransaction()
|
||||
</h2>
|
||||
<pre>beginTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::beginTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::beginTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
|
||||
<h2>commit()
|
||||
</h2>
|
||||
<pre>commit() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::commit()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::commit()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
|
||||
<h2>Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</h2>
|
||||
<pre>empty_table(string $table) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::empty_table()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
|
||||
<h2>errorCode()
|
||||
</h2>
|
||||
<pre>errorCode() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorCode()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::errorCode()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
|
||||
<h2>errorInfo()
|
||||
</h2>
|
||||
<pre>errorInfo() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorInfo()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::errorInfo()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
|
||||
<h2>exec()
|
||||
</h2>
|
||||
<pre>exec() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::exec()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::exec()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
|
||||
<h2>getAttribute()
|
||||
</h2>
|
||||
<pre>getAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
|
||||
<h2>getAvailableDrivers()
|
||||
</h2>
|
||||
<pre>getAvailableDrivers() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
|
||||
<h2>Retrieve column information for the current database table</h2>
|
||||
<pre>get_columns(string $table) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_columns()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
|
||||
<h2>Return list of dbs for the current connection, if possible</h2>
|
||||
<pre>get_dbs() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_dbs()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
|
||||
<h2>Return list of function for the current database</h2>
|
||||
<pre>get_functions() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_functions()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
|
||||
<h2>Return the last error for the current database connection</h2>
|
||||
<pre>get_last_error() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_last_error()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
|
||||
<h2>Return list of stored procedures for the current database</h2>
|
||||
<pre>get_procedures() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_procedures()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
|
||||
<h2>Retreives the data from a select query</h2>
|
||||
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_query_data()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
|
||||
<h2>Return schemas for databases that list them</h2>
|
||||
<pre>get_schemas() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_schemas()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
|
||||
<h2>Return list of sequences for the current database, if they exist</h2>
|
||||
<pre>get_sequences() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_sequences()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
|
||||
<h2>Retreives an array of non-user-created tables for
|
||||
the connection/database</h2>
|
||||
<pre>get_system_tables() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_system_tables()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
|
||||
<h2>Return list of tables for the current database</h2>
|
||||
<pre>get_tables() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_tables()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
|
||||
<h2>Return list of triggers for the current database</h2>
|
||||
<pre>get_triggers() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_triggers()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
|
||||
<h2>Retrieve list of data types for the database</h2>
|
||||
<pre>get_types() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_types()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
|
||||
<h2>Return list of views for the current database</h2>
|
||||
<pre>get_views() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_views()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
|
||||
<h2>inTransaction()
|
||||
</h2>
|
||||
<pre>inTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::inTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::inTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
|
||||
<h2>lastInsertId()
|
||||
</h2>
|
||||
<pre>lastInsertId() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
|
||||
<h2>Return the number of rows returned for a SELECT query</h2>
|
||||
<pre>num_rows() : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::num_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
|
||||
<h2>prepare()
|
||||
</h2>
|
||||
<pre>prepare() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::prepare()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
|
||||
<h2>Create and execute a prepared statement with the provided parameters</h2>
|
||||
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare_execute()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
|
||||
<h2>Simplifies prepared statements for database queries</h2>
|
||||
<pre>prepare_query(string $sql, array $data) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$data</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response">
|
||||
<code>mixed</code>PDOStatement / FALSE</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
|
||||
<h2>query()
|
||||
</h2>
|
||||
<pre>query() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::query()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::query()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
|
||||
<h2>quote()
|
||||
</h2>
|
||||
<pre>quote() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::quote()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
|
||||
<h2>Surrounds the string with the databases identifier escape characters</h2>
|
||||
<pre>quote_ident(mixed $ident) : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote_ident()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$ident</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
|
||||
<h2>rollBack()
|
||||
</h2>
|
||||
<pre>rollBack() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::rollBack()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::rollBack()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
|
||||
<h2>setAttribute()
|
||||
</h2>
|
||||
<pre>setAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::setAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::setAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="switch_db" id="switch_db"></a><div class="element clickable method public switch_db" data-toggle="collapse" data-target=".switch_db .collapse">
|
||||
<h2>Doesn't apply to ODBC</h2>
|
||||
<pre>switch_db(string $name) : bool</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>bool</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
|
||||
<h2>Empty the current database</h2>
|
||||
<pre>truncate(string $table) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
|
||||
<h2>Helper method for quote_ident</h2>
|
||||
<pre>_quote(mixed $str) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::_quote()</td>
|
||||
</tr></table>
|
||||
<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>
|
||||
<a name="driver_query" id="driver_query"></a><div class="element clickable method protected driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
|
||||
<h2>Method to simplify retreiving db results for meta-data queries</h2>
|
||||
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::driver_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$filtered_index</h4>
|
||||
<code>bool</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
|
||||
<h2>Reference to sql sub class</h2>
|
||||
<pre>$sql : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$sql</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
|
||||
<h2>Reference to util sub class</h2>
|
||||
<pre>$util : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$util</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
|
||||
<h2>Don't define the escape char - or define it in sub-drivers in a refactor</h2>
|
||||
<pre>$escape_char : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
|
||||
<h2>Reference to the last executed query</h2>
|
||||
<pre>$statement : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$statement</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,316 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \ODBC_SQL</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
|
||||
<li class="method public "><a href="#column_list" title="column_list :: 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="#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 inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
|
||||
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
|
||||
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
|
||||
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
|
||||
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
|
||||
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
|
||||
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
|
||||
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
|
||||
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CODBC_SQL" id="\ODBC_SQL"></a><div href="../classes/ODBC_SQL.html" class="element class">
|
||||
<p class="short_description">ODBC SQL Class</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
|
||||
<h2>Get the 'average' keyword</h2>
|
||||
<pre>avg() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::avg()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
|
||||
<h2>SQL to show infromation about columns in a table</h2>
|
||||
<pre>column_list(string $table) : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse">
|
||||
<h2>Returns sql to list other databases</h2>
|
||||
<pre>db_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
|
||||
<h2>Get the 'distinct' keyword</h2>
|
||||
<pre>distinct() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::distinct()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
|
||||
<h2>Return sql to list functions</h2>
|
||||
<pre>function_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
|
||||
<h2>Limit clause</h2>
|
||||
<pre>limit(string $sql, int $limit, int $offset) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$limit</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$offset</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
|
||||
<h2>Get the max keyword sql</h2>
|
||||
<pre>max() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::max()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
|
||||
<h2>Get the min keyword sql</h2>
|
||||
<pre>min() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::min()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
|
||||
<h2>Return sql to list stored procedures</h2>
|
||||
<pre>procedure_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse">
|
||||
<h2>Random ordering keyword</h2>
|
||||
<pre>random() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse">
|
||||
<h2>Return sql to list sequences</h2>
|
||||
<pre>sequence_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
|
||||
<h2>Get the 'sum' keyword</h2>
|
||||
<pre>sum() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::sum()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
|
||||
<h2>Returns sql to list system tables</h2>
|
||||
<pre>system_table_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse">
|
||||
<h2>Returns sql to list tables</h2>
|
||||
<pre>table_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse">
|
||||
<h2>Returns sql to list triggers</h2>
|
||||
<pre>trigger_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse">
|
||||
<h2>SQL to show list of field types</h2>
|
||||
<pre>type_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse">
|
||||
<h2>Returns sql to list views</h2>
|
||||
<pre>view_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,211 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \ODBC_Util</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the 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="#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="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
|
||||
<li class="method public "><a href="#create_table" title="create_table :: Database-specific method to create a new table"><span class="description">Database-specific method to create a new table</span><pre>create_table()</pre></a></li>
|
||||
<li class="method public "><a href="#delete_table" title="delete_table :: Remove a table from the database"><span class="description">Remove a table from the database</span><pre>delete_table()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CODBC_Util" id="\ODBC_Util"></a><div href="../classes/ODBC_Util.html" class="element class">
|
||||
<p class="short_description">ODBC-specific backup, import and creation methods</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
|
||||
<h2>Enable calling driver methods</h2>
|
||||
<pre>__call(string $method, array $args) </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::__call()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$method</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Save a reference to the current connection object</h2>
|
||||
<pre>__construct(object $conn) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$conn</h4>
|
||||
<code>object</code><p>&$conn</p>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse">
|
||||
<h2>Create an SQL backup file for the current database's data</h2>
|
||||
<pre>backup_data() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse">
|
||||
<h2>Create an SQL backup file for the current database's structure</h2>
|
||||
<pre>backup_structure() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse">
|
||||
<h2>Database-specific method to create a new table</h2>
|
||||
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$columns</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$constraints</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$indexes</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse">
|
||||
<h2>Remove a table from the database</h2>
|
||||
<pre>delete_table(string $name) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
|
||||
<h2>Reference to the current connection object</h2>
|
||||
<pre>$conn </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::$$conn</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,633 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \PHP_Session</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#__call" title="__call :: Allow calling of array methods on the object and
|
||||
dynamic methods"><span class="description">Allow calling of array methods on the object and
|
||||
dynamic methods</span><pre>__call()</pre></a></li>
|
||||
<li class="method public "><a href="#__get" title="__get :: Retreive a session value"><span class="description">Retreive a session value</span><pre>__get()</pre></a></li>
|
||||
<li class="method public "><a href="#__set" title="__set :: Set a session value"><span class="description">Set a session value</span><pre>__set()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#append" title="append :: "><span class="description">append()
|
||||
</span><pre>append()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#asort" title="asort :: "><span class="description">asort()
|
||||
</span><pre>asort()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#count" title="count :: "><span class="description">count()
|
||||
</span><pre>count()</pre></a></li>
|
||||
<li class="method public "><a href="#destroy" title="destroy :: Destroy a session"><span class="description">Destroy a session</span><pre>destroy()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#exchangeArray" title="exchangeArray :: "><span class="description">exchangeArray()
|
||||
</span><pre>exchangeArray()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getArrayCopy" title="getArrayCopy :: "><span class="description">getArrayCopy()
|
||||
</span><pre>getArrayCopy()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getFlags" title="getFlags :: "><span class="description">getFlags()
|
||||
</span><pre>getFlags()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getIterator" title="getIterator :: "><span class="description">getIterator()
|
||||
</span><pre>getIterator()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getIteratorClass" title="getIteratorClass :: "><span class="description">getIteratorClass()
|
||||
</span><pre>getIteratorClass()</pre></a></li>
|
||||
<li class="method public "><a href="#get_instance" title="get_instance :: Return or create singleton"><span class="description">Return or create singleton</span><pre>get_instance()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#ksort" title="ksort :: "><span class="description">ksort()
|
||||
</span><pre>ksort()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#natcasesort" title="natcasesort :: "><span class="description">natcasesort()
|
||||
</span><pre>natcasesort()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#natsort" title="natsort :: "><span class="description">natsort()
|
||||
</span><pre>natsort()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#offsetExists" title="offsetExists :: "><span class="description">offsetExists()
|
||||
</span><pre>offsetExists()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#offsetGet" title="offsetGet :: "><span class="description">offsetGet()
|
||||
</span><pre>offsetGet()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#offsetSet" title="offsetSet :: "><span class="description">offsetSet()
|
||||
</span><pre>offsetSet()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#offsetUnset" title="offsetUnset :: "><span class="description">offsetUnset()
|
||||
</span><pre>offsetUnset()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#serialize" title="serialize :: "><span class="description">serialize()
|
||||
</span><pre>serialize()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#setFlags" title="setFlags :: "><span class="description">setFlags()
|
||||
</span><pre>setFlags()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#setIteratorClass" title="setIteratorClass :: "><span class="description">setIteratorClass()
|
||||
</span><pre>setIteratorClass()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#uasort" title="uasort :: "><span class="description">uasort()
|
||||
</span><pre>uasort()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#uksort" title="uksort :: "><span class="description">uksort()
|
||||
</span><pre>uksort()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#unserialize" title="unserialize :: "><span class="description">unserialize()
|
||||
</span><pre>unserialize()</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="method protected "><a href="#__construct" title="__construct :: Start a session"><span class="description">Start a session</span><pre>__construct()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="property protected "><a href="#%24instance" title="$instance :: Instance of the current class"><span class="description">Instance of the current class</span><pre>$instance</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CPHP_Session" id="\PHP_Session"></a><div href="../classes/PHP_Session.html" class="element class">
|
||||
<p class="short_description">Class to improve handling of PHP sessions</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/miniMVC.Libraries.html">miniMVC</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Libraries</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
|
||||
<h2>Allow calling of array methods on the object and
|
||||
dynamic methods</h2>
|
||||
<pre>__call(string $name, array $params) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::__call()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__get" id="__get"></a><div class="element clickable method public __get" data-toggle="collapse" data-target=".__get .collapse">
|
||||
<h2>Retreive a session value</h2>
|
||||
<pre>__get(string $key) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$key</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__set" id="__set"></a><div class="element clickable method public __set" data-toggle="collapse" data-target=".__set .collapse">
|
||||
<h2>Set a session value</h2>
|
||||
<pre>__set(string $key, mixed $val) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$key</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$val</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="append" id="append"></a><div class="element clickable method public append" data-toggle="collapse" data-target=".append .collapse">
|
||||
<h2>append()
|
||||
</h2>
|
||||
<pre>append() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::append()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::append()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="asort" id="asort"></a><div class="element clickable method public asort" data-toggle="collapse" data-target=".asort .collapse">
|
||||
<h2>asort()
|
||||
</h2>
|
||||
<pre>asort() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::asort()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::asort()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="count" id="count"></a><div class="element clickable method public count" data-toggle="collapse" data-target=".count .collapse">
|
||||
<h2>count()
|
||||
</h2>
|
||||
<pre>count() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::count()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::count()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="destroy" id="destroy"></a><div class="element clickable method public destroy" data-toggle="collapse" data-target=".destroy .collapse">
|
||||
<h2>Destroy a session</h2>
|
||||
<pre>destroy() : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="exchangeArray" id="exchangeArray"></a><div class="element clickable method public exchangeArray" data-toggle="collapse" data-target=".exchangeArray .collapse">
|
||||
<h2>exchangeArray()
|
||||
</h2>
|
||||
<pre>exchangeArray() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::exchangeArray()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::exchangeArray()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getArrayCopy" id="getArrayCopy"></a><div class="element clickable method public getArrayCopy" data-toggle="collapse" data-target=".getArrayCopy .collapse">
|
||||
<h2>getArrayCopy()
|
||||
</h2>
|
||||
<pre>getArrayCopy() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::getArrayCopy()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::getArrayCopy()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getFlags" id="getFlags"></a><div class="element clickable method public getFlags" data-toggle="collapse" data-target=".getFlags .collapse">
|
||||
<h2>getFlags()
|
||||
</h2>
|
||||
<pre>getFlags() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::getFlags()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::getFlags()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getIterator" id="getIterator"></a><div class="element clickable method public getIterator" data-toggle="collapse" data-target=".getIterator .collapse">
|
||||
<h2>getIterator()
|
||||
</h2>
|
||||
<pre>getIterator() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::getIterator()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::getIterator()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getIteratorClass" id="getIteratorClass"></a><div class="element clickable method public getIteratorClass" data-toggle="collapse" data-target=".getIteratorClass .collapse">
|
||||
<h2>getIteratorClass()
|
||||
</h2>
|
||||
<pre>getIteratorClass() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::getIteratorClass()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::getIteratorClass()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_instance" id="get_instance"></a><div class="element clickable method public get_instance" data-toggle="collapse" data-target=".get_instance .collapse">
|
||||
<h2>Return or create singleton</h2>
|
||||
<pre>get_instance() : <a href="../classes/PHP_Session.html">\PHP_Session</a></pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>fluent</th>
|
||||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="../classes/PHP_Session.html">\PHP_Session</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="ksort" id="ksort"></a><div class="element clickable method public ksort" data-toggle="collapse" data-target=".ksort .collapse">
|
||||
<h2>ksort()
|
||||
</h2>
|
||||
<pre>ksort() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::ksort()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::ksort()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="natcasesort" id="natcasesort"></a><div class="element clickable method public natcasesort" data-toggle="collapse" data-target=".natcasesort .collapse">
|
||||
<h2>natcasesort()
|
||||
</h2>
|
||||
<pre>natcasesort() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::natcasesort()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::natcasesort()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="natsort" id="natsort"></a><div class="element clickable method public natsort" data-toggle="collapse" data-target=".natsort .collapse">
|
||||
<h2>natsort()
|
||||
</h2>
|
||||
<pre>natsort() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::natsort()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::natsort()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="offsetExists" id="offsetExists"></a><div class="element clickable method public offsetExists" data-toggle="collapse" data-target=".offsetExists .collapse">
|
||||
<h2>offsetExists()
|
||||
</h2>
|
||||
<pre>offsetExists() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::offsetExists()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::offsetExists()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="offsetGet" id="offsetGet"></a><div class="element clickable method public offsetGet" data-toggle="collapse" data-target=".offsetGet .collapse">
|
||||
<h2>offsetGet()
|
||||
</h2>
|
||||
<pre>offsetGet() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::offsetGet()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::offsetGet()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="offsetSet" id="offsetSet"></a><div class="element clickable method public offsetSet" data-toggle="collapse" data-target=".offsetSet .collapse">
|
||||
<h2>offsetSet()
|
||||
</h2>
|
||||
<pre>offsetSet() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::offsetSet()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::offsetSet()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="offsetUnset" id="offsetUnset"></a><div class="element clickable method public offsetUnset" data-toggle="collapse" data-target=".offsetUnset .collapse">
|
||||
<h2>offsetUnset()
|
||||
</h2>
|
||||
<pre>offsetUnset() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::offsetUnset()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::offsetUnset()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="serialize" id="serialize"></a><div class="element clickable method public serialize" data-toggle="collapse" data-target=".serialize .collapse">
|
||||
<h2>serialize()
|
||||
</h2>
|
||||
<pre>serialize() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::serialize()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::serialize()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setFlags" id="setFlags"></a><div class="element clickable method public setFlags" data-toggle="collapse" data-target=".setFlags .collapse">
|
||||
<h2>setFlags()
|
||||
</h2>
|
||||
<pre>setFlags() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::setFlags()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::setFlags()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setIteratorClass" id="setIteratorClass"></a><div class="element clickable method public setIteratorClass" data-toggle="collapse" data-target=".setIteratorClass .collapse">
|
||||
<h2>setIteratorClass()
|
||||
</h2>
|
||||
<pre>setIteratorClass() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::setIteratorClass()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::setIteratorClass()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="uasort" id="uasort"></a><div class="element clickable method public uasort" data-toggle="collapse" data-target=".uasort .collapse">
|
||||
<h2>uasort()
|
||||
</h2>
|
||||
<pre>uasort() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::uasort()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::uasort()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="uksort" id="uksort"></a><div class="element clickable method public uksort" data-toggle="collapse" data-target=".uksort .collapse">
|
||||
<h2>uksort()
|
||||
</h2>
|
||||
<pre>uksort() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::uksort()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::uksort()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="unserialize" id="unserialize"></a><div class="element clickable method public unserialize" data-toggle="collapse" data-target=".unserialize .collapse">
|
||||
<h2>unserialize()
|
||||
</h2>
|
||||
<pre>unserialize() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>ArrayObject::unserialize()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\MM::unserialize()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method protected __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Start a session</h2>
|
||||
<pre>__construct() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24instance" id="$instance"> </a><div class="element clickable property protected $instance" data-toggle="collapse" data-target=".$instance .collapse">
|
||||
<h2>Instance of the current class</h2>
|
||||
<pre>$instance : <a href="../classes/PHP_Session.html">\PHP_Session</a></pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-03T12:48:51-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,914 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \PgSQL</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Connect to a PosgreSQL database"><span class="description">Connect to a PosgreSQL database</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
|
||||
</span><pre>__sleep()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
|
||||
</span><pre>__wakeup()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
|
||||
</span><pre>beginTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#commit" title="commit :: "><span class="description">commit()
|
||||
</span><pre>commit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
|
||||
</span><pre>errorCode()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
|
||||
</span><pre>errorInfo()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
|
||||
</span><pre>exec()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
|
||||
</span><pre>getAttribute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
|
||||
</span><pre>getAvailableDrivers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
|
||||
<li class="method public "><a href="#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 inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_system_tables" title="get_system_tables :: Retreives an array of non-user-created tables for
|
||||
the connection/database"><span class="description">Retreives an array of non-user-created tables for
|
||||
the connection/database</span><pre>get_system_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_tables" title="get_tables :: Return list of tables for the current database"><span class="description">Return list of tables for the current database</span><pre>get_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
|
||||
</span><pre>inTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
|
||||
</span><pre>lastInsertId()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare" title="prepare :: "><span class="description">prepare()
|
||||
</span><pre>prepare()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#query" title="query :: "><span class="description">query()
|
||||
</span><pre>query()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
|
||||
</span><pre>quote()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
|
||||
</span><pre>rollBack()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
|
||||
</span><pre>setAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#switch_db" title="switch_db :: Connect to a different database"><span class="description">Connect to a different database</span><pre>switch_db()</pre></a></li>
|
||||
<li class="method public "><a href="#truncate" title="truncate :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
|
||||
<li class="method protected inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
|
||||
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
|
||||
<li class="property protected inherited"><a href="#%24statement" title="$statement :: Reference to the last executed query"><span class="description">Reference to the last executed query</span><pre>$statement</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CPgSQL" id="\PgSQL"></a><div href="../classes/PgSQL.html" class="element class">
|
||||
<p class="short_description">PostgreSQL specifc class</p>
|
||||
<div class="details">
|
||||
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Connect to a PosgreSQL database</h2>
|
||||
<pre>__construct(string $dsn, string $username, string $password, array $options) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$dsn</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$username</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$password</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$options</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
|
||||
<h2>__sleep()
|
||||
</h2>
|
||||
<pre>__sleep() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__sleep()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__sleep()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
|
||||
<h2>__wakeup()
|
||||
</h2>
|
||||
<pre>__wakeup() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__wakeup()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__wakeup()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
|
||||
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
|
||||
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::affected_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
|
||||
<h2>beginTransaction()
|
||||
</h2>
|
||||
<pre>beginTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::beginTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::beginTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
|
||||
<h2>commit()
|
||||
</h2>
|
||||
<pre>commit() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::commit()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::commit()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
|
||||
<h2>Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</h2>
|
||||
<pre>empty_table(string $table) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::empty_table()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
|
||||
<h2>errorCode()
|
||||
</h2>
|
||||
<pre>errorCode() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorCode()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::errorCode()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
|
||||
<h2>errorInfo()
|
||||
</h2>
|
||||
<pre>errorInfo() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorInfo()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::errorInfo()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
|
||||
<h2>exec()
|
||||
</h2>
|
||||
<pre>exec() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::exec()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::exec()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
|
||||
<h2>getAttribute()
|
||||
</h2>
|
||||
<pre>getAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
|
||||
<h2>getAvailableDrivers()
|
||||
</h2>
|
||||
<pre>getAvailableDrivers() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
|
||||
<h2>Retrieve column information for the current database table</h2>
|
||||
<pre>get_columns(string $table) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_columns()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
|
||||
<h2>Return list of dbs for the current connection, if possible</h2>
|
||||
<pre>get_dbs() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_dbs()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
|
||||
<h2>Return list of function for the current database</h2>
|
||||
<pre>get_functions() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_functions()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
|
||||
<h2>Return the last error for the current database connection</h2>
|
||||
<pre>get_last_error() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_last_error()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
|
||||
<h2>Return list of stored procedures for the current database</h2>
|
||||
<pre>get_procedures() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_procedures()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
|
||||
<h2>Retreives the data from a select query</h2>
|
||||
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_query_data()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
|
||||
<h2>Get a list of schemas for the current connection</h2>
|
||||
<pre>get_schemas() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
|
||||
<h2>Return list of sequences for the current database, if they exist</h2>
|
||||
<pre>get_sequences() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_sequences()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
|
||||
<h2>Retreives an array of non-user-created tables for
|
||||
the connection/database</h2>
|
||||
<pre>get_system_tables() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_system_tables()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
|
||||
<h2>Return list of tables for the current database</h2>
|
||||
<pre>get_tables() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_tables()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
|
||||
<h2>Return list of triggers for the current database</h2>
|
||||
<pre>get_triggers() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_triggers()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
|
||||
<h2>Retrieve list of data types for the database</h2>
|
||||
<pre>get_types() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_types()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
|
||||
<h2>Return list of views for the current database</h2>
|
||||
<pre>get_views() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_views()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
|
||||
<h2>inTransaction()
|
||||
</h2>
|
||||
<pre>inTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::inTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::inTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
|
||||
<h2>lastInsertId()
|
||||
</h2>
|
||||
<pre>lastInsertId() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
|
||||
<h2>Return the number of rows returned for a SELECT query</h2>
|
||||
<pre>num_rows() : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::num_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
|
||||
<h2>prepare()
|
||||
</h2>
|
||||
<pre>prepare() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::prepare()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
|
||||
<h2>Create and execute a prepared statement with the provided parameters</h2>
|
||||
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare_execute()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
|
||||
<h2>Simplifies prepared statements for database queries</h2>
|
||||
<pre>prepare_query(string $sql, array $data) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$data</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response">
|
||||
<code>mixed</code>PDOStatement / FALSE</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
|
||||
<h2>query()
|
||||
</h2>
|
||||
<pre>query() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::query()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::query()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
|
||||
<h2>quote()
|
||||
</h2>
|
||||
<pre>quote() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::quote()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
|
||||
<h2>Surrounds the string with the databases identifier escape characters</h2>
|
||||
<pre>quote_ident(mixed $ident) : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote_ident()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$ident</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
|
||||
<h2>rollBack()
|
||||
</h2>
|
||||
<pre>rollBack() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::rollBack()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::rollBack()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
|
||||
<h2>setAttribute()
|
||||
</h2>
|
||||
<pre>setAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::setAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::setAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="switch_db" id="switch_db"></a><div class="element clickable method public switch_db" data-toggle="collapse" data-target=".switch_db .collapse">
|
||||
<h2>Connect to a different database</h2>
|
||||
<pre>switch_db(string $name) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
|
||||
<h2>Empty a table</h2>
|
||||
<pre>truncate(string $table) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
|
||||
<h2>Helper method for quote_ident</h2>
|
||||
<pre>_quote(mixed $str) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::_quote()</td>
|
||||
</tr></table>
|
||||
<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>
|
||||
<a name="driver_query" id="driver_query"></a><div class="element clickable method protected driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
|
||||
<h2>Method to simplify retreiving db results for meta-data queries</h2>
|
||||
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::driver_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$filtered_index</h4>
|
||||
<code>bool</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
|
||||
<h2>Reference to sql sub class</h2>
|
||||
<pre>$sql : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$sql</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
|
||||
<h2>Reference to util sub class</h2>
|
||||
<pre>$util : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$util</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
|
||||
<h2>Character to escape identifiers</h2>
|
||||
<pre>$escape_char : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$escape_char</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
|
||||
<h2>Reference to the last executed query</h2>
|
||||
<pre>$statement : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$statement</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,316 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \PgSQL_SQL</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
|
||||
<li class="method public "><a href="#column_list" title="column_list :: 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="#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 inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
|
||||
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
|
||||
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
|
||||
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
|
||||
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
|
||||
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
|
||||
<li class="method public "><a href="#system_table_list" title="system_table_list :: Returns sql to list system tables"><span class="description">Returns sql to list system tables</span><pre>system_table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
|
||||
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
|
||||
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CPgSQL_SQL" id="\PgSQL_SQL"></a><div href="../classes/PgSQL_SQL.html" class="element class">
|
||||
<p class="short_description">PostgreSQL specifc SQL</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
|
||||
<h2>Get the 'average' keyword</h2>
|
||||
<pre>avg() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::avg()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
|
||||
<h2>Return sql to list columns of the specified table</h2>
|
||||
<pre>column_list(string $table) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse">
|
||||
<h2>Returns sql to list other databases</h2>
|
||||
<pre>db_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
|
||||
<h2>Get the 'distinct' keyword</h2>
|
||||
<pre>distinct() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::distinct()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
|
||||
<h2>Return sql to list functions</h2>
|
||||
<pre>function_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
|
||||
<h2>Limit clause</h2>
|
||||
<pre>limit(string $sql, int $limit, int $offset) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$limit</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$offset</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
|
||||
<h2>Get the max keyword sql</h2>
|
||||
<pre>max() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::max()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
|
||||
<h2>Get the min keyword sql</h2>
|
||||
<pre>min() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::min()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
|
||||
<h2>Return sql to list stored procedures</h2>
|
||||
<pre>procedure_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse">
|
||||
<h2>Random ordering keyword</h2>
|
||||
<pre>random() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse">
|
||||
<h2>Return sql to list sequences</h2>
|
||||
<pre>sequence_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
|
||||
<h2>Get the 'sum' keyword</h2>
|
||||
<pre>sum() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::sum()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
|
||||
<h2>Returns sql to list system tables</h2>
|
||||
<pre>system_table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse">
|
||||
<h2>Returns sql to list tables</h2>
|
||||
<pre>table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse">
|
||||
<h2>Returns sql to list triggers</h2>
|
||||
<pre>trigger_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse">
|
||||
<h2>SQL to show list of field types</h2>
|
||||
<pre>type_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse">
|
||||
<h2>Returns sql to list views</h2>
|
||||
<pre>view_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,216 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \PgSQL_Util</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the 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="#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="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
|
||||
<li class="method public "><a href="#create_table" title="create_table :: Database-specific method to create a new table"><span class="description">Database-specific method to create a new table</span><pre>create_table()</pre></a></li>
|
||||
<li class="method public "><a href="#delete_table" title="delete_table :: Database-specific SQL for dropping a table"><span class="description">Database-specific SQL for dropping a table</span><pre>delete_table()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CPgSQL_Util" id="\PgSQL_Util"></a><div href="../classes/PgSQL_Util.html" class="element class">
|
||||
<p class="short_description">Posgres-specific backup, import and creation methods</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
|
||||
<h2>Enable calling driver methods</h2>
|
||||
<pre>__call(string $method, array $args) </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::__call()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$method</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Save a reference to the current connection object</h2>
|
||||
<pre>__construct(object $conn) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$conn</h4>
|
||||
<code>object</code><p>&$conn</p>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse">
|
||||
<h2>Create an SQL backup file for the current database's data</h2>
|
||||
<pre>backup_data(array $exclude) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$exclude</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse">
|
||||
<h2>Create an SQL backup file for the current database's structure</h2>
|
||||
<pre>backup_structure() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse">
|
||||
<h2>Database-specific method to create a new table</h2>
|
||||
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$columns</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$constraints</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$indexes</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse">
|
||||
<h2>Database-specific SQL for dropping a table</h2>
|
||||
<pre>delete_table(string $name) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
|
||||
<h2>Reference to the current connection object</h2>
|
||||
<pre>$conn </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::$$conn</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,929 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \SQLite</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Open SQLite Database"><span class="description">Open SQLite Database</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__sleep" title="__sleep :: "><span class="description">__sleep()
|
||||
</span><pre>__sleep()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#__wakeup" title="__wakeup :: "><span class="description">__wakeup()
|
||||
</span><pre>__wakeup()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#affected_rows" title="affected_rows :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query"><span class="description">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</span><pre>affected_rows()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#beginTransaction" title="beginTransaction :: "><span class="description">beginTransaction()
|
||||
</span><pre>beginTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#commit" title="commit :: "><span class="description">commit()
|
||||
</span><pre>commit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#empty_table" title="empty_table :: Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';"><span class="description">Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</span><pre>empty_table()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#errorCode" title="errorCode :: "><span class="description">errorCode()
|
||||
</span><pre>errorCode()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#errorInfo" title="errorInfo :: "><span class="description">errorInfo()
|
||||
</span><pre>errorInfo()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#exec" title="exec :: "><span class="description">exec()
|
||||
</span><pre>exec()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAttribute" title="getAttribute :: "><span class="description">getAttribute()
|
||||
</span><pre>getAttribute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#getAvailableDrivers" title="getAvailableDrivers :: "><span class="description">getAvailableDrivers()
|
||||
</span><pre>getAvailableDrivers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_columns" title="get_columns :: Retrieve column information for the current database table"><span class="description">Retrieve column information for the current database table</span><pre>get_columns()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_dbs" title="get_dbs :: Return list of dbs for the current connection, if possible"><span class="description">Return list of dbs for the current connection, if possible</span><pre>get_dbs()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_functions" title="get_functions :: Return list of function for the current database"><span class="description">Return list of function for the current database</span><pre>get_functions()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_last_error" title="get_last_error :: Return the last error for the current database connection"><span class="description">Return the last error for the current database connection</span><pre>get_last_error()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_procedures" title="get_procedures :: Return list of stored procedures for the current database"><span class="description">Return list of stored procedures for the current database</span><pre>get_procedures()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_query_data" title="get_query_data :: Retreives the data from a select query"><span class="description">Retreives the data from a select query</span><pre>get_query_data()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_schemas" title="get_schemas :: Return schemas for databases that list them"><span class="description">Return schemas for databases that list them</span><pre>get_schemas()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_sequences" title="get_sequences :: Return list of sequences for the current database, if they exist"><span class="description">Return list of sequences for the current database, if they exist</span><pre>get_sequences()</pre></a></li>
|
||||
<li class="method public "><a href="#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="#get_tables" title="get_tables :: List tables for the current database"><span class="description">List tables for the current database</span><pre>get_tables()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_triggers" title="get_triggers :: Return list of triggers for the current database"><span class="description">Return list of triggers for the current database</span><pre>get_triggers()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_types" title="get_types :: Retrieve list of data types for the database"><span class="description">Retrieve list of data types for the database</span><pre>get_types()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#get_views" title="get_views :: Return list of views for the current database"><span class="description">Return list of views for the current database</span><pre>get_views()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#inTransaction" title="inTransaction :: "><span class="description">inTransaction()
|
||||
</span><pre>inTransaction()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#lastInsertId" title="lastInsertId :: "><span class="description">lastInsertId()
|
||||
</span><pre>lastInsertId()</pre></a></li>
|
||||
<li class="method public "><a href="#load_database" title="load_database :: Load a database for the current connection"><span class="description">Load a database for the current connection</span><pre>load_database()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#num_rows" title="num_rows :: Return the number of rows returned for a SELECT query"><span class="description">Return the number of rows returned for a SELECT query</span><pre>num_rows()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare" title="prepare :: "><span class="description">prepare()
|
||||
</span><pre>prepare()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare_execute" title="prepare_execute :: Create and execute a prepared statement with the provided parameters"><span class="description">Create and execute a prepared statement with the provided parameters</span><pre>prepare_execute()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#prepare_query" title="prepare_query :: Simplifies prepared statements for database queries"><span class="description">Simplifies prepared statements for database queries</span><pre>prepare_query()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#query" title="query :: "><span class="description">query()
|
||||
</span><pre>query()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote" title="quote :: "><span class="description">quote()
|
||||
</span><pre>quote()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#quote_ident" title="quote_ident :: Surrounds the string with the databases identifier escape characters"><span class="description">Surrounds the string with the databases identifier escape characters</span><pre>quote_ident()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#rollBack" title="rollBack :: "><span class="description">rollBack()
|
||||
</span><pre>rollBack()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#setAttribute" title="setAttribute :: "><span class="description">setAttribute()
|
||||
</span><pre>setAttribute()</pre></a></li>
|
||||
<li class="method public "><a href="#switch_db" title="switch_db :: Doesn't apply to sqlite"><span class="description">Doesn't apply to sqlite</span><pre>switch_db()</pre></a></li>
|
||||
<li class="method public "><a href="#truncate" title="truncate :: Empty a table"><span class="description">Empty a table</span><pre>truncate()</pre></a></li>
|
||||
<li class="method public "><a href="#unload_database" title="unload_database :: Unload a database from the current connection"><span class="description">Unload a database from the current connection</span><pre>unload_database()</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="method protected inherited"><a href="#_quote" title="_quote :: Helper method for quote_ident"><span class="description">Helper method for quote_ident</span><pre>_quote()</pre></a></li>
|
||||
<li class="method protected inherited"><a href="#driver_query" title="driver_query :: Method to simplify retreiving db results for meta-data queries"><span class="description">Method to simplify retreiving db results for meta-data queries</span><pre>driver_query()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="property public inherited"><a href="#%24sql" title="$sql :: Reference to sql sub class"><span class="description">Reference to sql sub class</span><pre>$sql</pre></a></li>
|
||||
<li class="property public inherited"><a href="#%24util" title="$util :: Reference to util sub class"><span class="description">Reference to util sub class</span><pre>$util</pre></a></li>
|
||||
<li class="nav-header protected">» Protected</li>
|
||||
<li class="property protected inherited"><a href="#%24escape_char" title="$escape_char :: Character to escape identifiers"><span class="description">Character to escape identifiers</span><pre>$escape_char</pre></a></li>
|
||||
<li class="property protected "><a href="#%24statement" title="$statement :: Reference to the last executed sql query"><span class="description">Reference to the last executed sql query</span><pre>$statement</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CSQLite" id="\SQLite"></a><div href="../classes/SQLite.html" class="element class">
|
||||
<p class="short_description">SQLite specific class</p>
|
||||
<div class="details">
|
||||
<p class="long_description"><p>Extends PDO to simplify cross-database issues</p></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Open SQLite Database</h2>
|
||||
<pre>__construct(string $dsn, string $user, string $pass) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$dsn</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$user</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$pass</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__sleep" id="__sleep"></a><div class="element clickable method public __sleep" data-toggle="collapse" data-target=".__sleep .collapse">
|
||||
<h2>__sleep()
|
||||
</h2>
|
||||
<pre>__sleep() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__sleep()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__sleep()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__wakeup" id="__wakeup"></a><div class="element clickable method public __wakeup" data-toggle="collapse" data-target=".__wakeup .collapse">
|
||||
<h2>__wakeup()
|
||||
</h2>
|
||||
<pre>__wakeup() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::__wakeup()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::__wakeup()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="affected_rows" id="affected_rows"></a><div class="element clickable method public affected_rows" data-toggle="collapse" data-target=".affected_rows .collapse">
|
||||
<h2>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</h2>
|
||||
<pre>affected_rows(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::affected_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="beginTransaction" id="beginTransaction"></a><div class="element clickable method public beginTransaction" data-toggle="collapse" data-target=".beginTransaction .collapse">
|
||||
<h2>beginTransaction()
|
||||
</h2>
|
||||
<pre>beginTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::beginTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::beginTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="commit" id="commit"></a><div class="element clickable method public commit" data-toggle="collapse" data-target=".commit .collapse">
|
||||
<h2>commit()
|
||||
</h2>
|
||||
<pre>commit() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::commit()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::commit()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="empty_table" id="empty_table"></a><div class="element clickable method public empty_table" data-toggle="collapse" data-target=".empty_table .collapse">
|
||||
<h2>Deletes all the rows from a table. Does the same as the truncate
|
||||
method if the database does not support 'TRUNCATE';</h2>
|
||||
<pre>empty_table(string $table) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::empty_table()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorCode" id="errorCode"></a><div class="element clickable method public errorCode" data-toggle="collapse" data-target=".errorCode .collapse">
|
||||
<h2>errorCode()
|
||||
</h2>
|
||||
<pre>errorCode() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorCode()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::errorCode()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="errorInfo" id="errorInfo"></a><div class="element clickable method public errorInfo" data-toggle="collapse" data-target=".errorInfo .collapse">
|
||||
<h2>errorInfo()
|
||||
</h2>
|
||||
<pre>errorInfo() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::errorInfo()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::errorInfo()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="exec" id="exec"></a><div class="element clickable method public exec" data-toggle="collapse" data-target=".exec .collapse">
|
||||
<h2>exec()
|
||||
</h2>
|
||||
<pre>exec() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::exec()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::exec()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAttribute" id="getAttribute"></a><div class="element clickable method public getAttribute" data-toggle="collapse" data-target=".getAttribute .collapse">
|
||||
<h2>getAttribute()
|
||||
</h2>
|
||||
<pre>getAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="getAvailableDrivers" id="getAvailableDrivers"></a><div class="element clickable method public getAvailableDrivers" data-toggle="collapse" data-target=".getAvailableDrivers .collapse">
|
||||
<h2>getAvailableDrivers()
|
||||
</h2>
|
||||
<pre>getAvailableDrivers() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::getAvailableDrivers()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_columns" id="get_columns"></a><div class="element clickable method public get_columns" data-toggle="collapse" data-target=".get_columns .collapse">
|
||||
<h2>Retrieve column information for the current database table</h2>
|
||||
<pre>get_columns(string $table) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_columns()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
|
||||
<h2>Return list of dbs for the current connection, if possible</h2>
|
||||
<pre>get_dbs() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_dbs()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_functions" id="get_functions"></a><div class="element clickable method public get_functions" data-toggle="collapse" data-target=".get_functions .collapse">
|
||||
<h2>Return list of function for the current database</h2>
|
||||
<pre>get_functions() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_functions()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_last_error" id="get_last_error"></a><div class="element clickable method public get_last_error" data-toggle="collapse" data-target=".get_last_error .collapse">
|
||||
<h2>Return the last error for the current database connection</h2>
|
||||
<pre>get_last_error() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_last_error()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_procedures" id="get_procedures"></a><div class="element clickable method public get_procedures" data-toggle="collapse" data-target=".get_procedures .collapse">
|
||||
<h2>Return list of stored procedures for the current database</h2>
|
||||
<pre>get_procedures() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_procedures()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_query_data" id="get_query_data"></a><div class="element clickable method public get_query_data" data-toggle="collapse" data-target=".get_query_data .collapse">
|
||||
<h2>Retreives the data from a select query</h2>
|
||||
<pre>get_query_data(<a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a> $statement) : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_query_data()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$statement</h4>
|
||||
<code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_schemas" id="get_schemas"></a><div class="element clickable method public get_schemas" data-toggle="collapse" data-target=".get_schemas .collapse">
|
||||
<h2>Return schemas for databases that list them</h2>
|
||||
<pre>get_schemas() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_schemas()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_sequences" id="get_sequences"></a><div class="element clickable method public get_sequences" data-toggle="collapse" data-target=".get_sequences .collapse">
|
||||
<h2>Return list of sequences for the current database, if they exist</h2>
|
||||
<pre>get_sequences() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_sequences()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_system_tables" id="get_system_tables"></a><div class="element clickable method public get_system_tables" data-toggle="collapse" data-target=".get_system_tables .collapse">
|
||||
<h2>List system tables for the current database</h2>
|
||||
<pre>get_system_tables() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_tables" id="get_tables"></a><div class="element clickable method public get_tables" data-toggle="collapse" data-target=".get_tables .collapse">
|
||||
<h2>List tables for the current database</h2>
|
||||
<pre>get_tables() : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_triggers" id="get_triggers"></a><div class="element clickable method public get_triggers" data-toggle="collapse" data-target=".get_triggers .collapse">
|
||||
<h2>Return list of triggers for the current database</h2>
|
||||
<pre>get_triggers() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_triggers()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_types" id="get_types"></a><div class="element clickable method public get_types" data-toggle="collapse" data-target=".get_types .collapse">
|
||||
<h2>Retrieve list of data types for the database</h2>
|
||||
<pre>get_types() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_types()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_views" id="get_views"></a><div class="element clickable method public get_views" data-toggle="collapse" data-target=".get_views .collapse">
|
||||
<h2>Return list of views for the current database</h2>
|
||||
<pre>get_views() : array</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::get_views()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="inTransaction" id="inTransaction"></a><div class="element clickable method public inTransaction" data-toggle="collapse" data-target=".inTransaction .collapse">
|
||||
<h2>inTransaction()
|
||||
</h2>
|
||||
<pre>inTransaction() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::inTransaction()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::inTransaction()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="lastInsertId" id="lastInsertId"></a><div class="element clickable method public lastInsertId" data-toggle="collapse" data-target=".lastInsertId .collapse">
|
||||
<h2>lastInsertId()
|
||||
</h2>
|
||||
<pre>lastInsertId() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::lastInsertId()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="load_database" id="load_database"></a><div class="element clickable method public load_database" data-toggle="collapse" data-target=".load_database .collapse">
|
||||
<h2>Load a database for the current connection</h2>
|
||||
<pre>load_database(string $db, string $name) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$db</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="num_rows" id="num_rows"></a><div class="element clickable method public num_rows" data-toggle="collapse" data-target=".num_rows .collapse">
|
||||
<h2>Return the number of rows returned for a SELECT query</h2>
|
||||
<pre>num_rows() : int</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::num_rows()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>int</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare" id="prepare"></a><div class="element clickable method public prepare" data-toggle="collapse" data-target=".prepare .collapse">
|
||||
<h2>prepare()
|
||||
</h2>
|
||||
<pre>prepare() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::prepare()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_execute" id="prepare_execute"></a><div class="element clickable method public prepare_execute" data-toggle="collapse" data-target=".prepare_execute .collapse">
|
||||
<h2>Create and execute a prepared statement with the provided parameters</h2>
|
||||
<pre>prepare_execute(string $sql, array $params) : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare_execute()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="prepare_query" id="prepare_query"></a><div class="element clickable method public prepare_query" data-toggle="collapse" data-target=".prepare_query .collapse">
|
||||
<h2>Simplifies prepared statements for database queries</h2>
|
||||
<pre>prepare_query(string $sql, array $data) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::prepare_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$data</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response">
|
||||
<code>mixed</code>PDOStatement / FALSE</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
|
||||
<h2>query()
|
||||
</h2>
|
||||
<pre>query() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::query()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::query()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote" id="quote"></a><div class="element clickable method public quote" data-toggle="collapse" data-target=".quote .collapse">
|
||||
<h2>quote()
|
||||
</h2>
|
||||
<pre>quote() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::quote()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="quote_ident" id="quote_ident"></a><div class="element clickable method public quote_ident" data-toggle="collapse" data-target=".quote_ident .collapse">
|
||||
<h2>Surrounds the string with the databases identifier escape characters</h2>
|
||||
<pre>quote_ident(mixed $ident) : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::quote_ident()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$ident</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="rollBack" id="rollBack"></a><div class="element clickable method public rollBack" data-toggle="collapse" data-target=".rollBack .collapse">
|
||||
<h2>rollBack()
|
||||
</h2>
|
||||
<pre>rollBack() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::rollBack()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::rollBack()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="setAttribute" id="setAttribute"></a><div class="element clickable method public setAttribute" data-toggle="collapse" data-target=".setAttribute .collapse">
|
||||
<h2>setAttribute()
|
||||
</h2>
|
||||
<pre>setAttribute() </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>PDO::setAttribute()</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::setAttribute()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="switch_db" id="switch_db"></a><div class="element clickable method public switch_db" data-toggle="collapse" data-target=".switch_db .collapse">
|
||||
<h2>Doesn't apply to sqlite</h2>
|
||||
<pre>switch_db(string $name) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="truncate" id="truncate"></a><div class="element clickable method public truncate" data-toggle="collapse" data-target=".truncate .collapse">
|
||||
<h2>Empty a table</h2>
|
||||
<pre>truncate(string $table) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="unload_database" id="unload_database"></a><div class="element clickable method public unload_database" data-toggle="collapse" data-target=".unload_database .collapse">
|
||||
<h2>Unload a database from the current connection</h2>
|
||||
<pre>unload_database(string $name) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_quote" id="_quote"></a><div class="element clickable method protected _quote" data-toggle="collapse" data-target="._quote .collapse">
|
||||
<h2>Helper method for quote_ident</h2>
|
||||
<pre>_quote(mixed $str) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::_quote()</td>
|
||||
</tr></table>
|
||||
<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>
|
||||
<a name="driver_query" id="driver_query"></a><div class="element clickable method protected driver_query" data-toggle="collapse" data-target=".driver_query .collapse">
|
||||
<h2>Method to simplify retreiving db results for meta-data queries</h2>
|
||||
<pre>driver_query(string $sql, bool $filtered_index) : mixed</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::driver_query()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$filtered_index</h4>
|
||||
<code>bool</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24sql" id="$sql"> </a><div class="element clickable property public $sql" data-toggle="collapse" data-target=".$sql .collapse">
|
||||
<h2>Reference to sql sub class</h2>
|
||||
<pre>$sql : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$sql</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24util" id="$util"> </a><div class="element clickable property public $util" data-toggle="collapse" data-target=".$util .collapse">
|
||||
<h2>Reference to util sub class</h2>
|
||||
<pre>$util : Object</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$util</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24escape_char" id="$escape_char"> </a><div class="element clickable property protected $escape_char" data-toggle="collapse" data-target=".$escape_char .collapse">
|
||||
<h2>Character to escape identifiers</h2>
|
||||
<pre>$escape_char : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_PDO::$$escape_char</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="%24statement" id="$statement"> </a><div class="element clickable property protected $statement" data-toggle="collapse" data-target=".$statement .collapse">
|
||||
<h2>Reference to the last executed sql query</h2>
|
||||
<pre>$statement : <a href="http://php.net/manual/en/class.pdostatement.php">\PDOStatement</a></pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,316 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \SQLite_SQL</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#avg" title="avg :: Get the 'average' keyword"><span class="description">Get the 'average' keyword</span><pre>avg()</pre></a></li>
|
||||
<li class="method public "><a href="#column_list" title="column_list :: 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="#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 inherited"><a href="#distinct" title="distinct :: Get the 'distinct' keyword"><span class="description">Get the 'distinct' keyword</span><pre>distinct()</pre></a></li>
|
||||
<li class="method public "><a href="#function_list" title="function_list :: Return sql to list functions"><span class="description">Return sql to list functions</span><pre>function_list()</pre></a></li>
|
||||
<li class="method public "><a href="#limit" title="limit :: Limit clause"><span class="description">Limit clause</span><pre>limit()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#max" title="max :: Get the max keyword sql"><span class="description">Get the max keyword sql</span><pre>max()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#min" title="min :: Get the min keyword sql"><span class="description">Get the min keyword sql</span><pre>min()</pre></a></li>
|
||||
<li class="method public "><a href="#procedure_list" title="procedure_list :: Return sql to list stored procedures"><span class="description">Return sql to list stored procedures</span><pre>procedure_list()</pre></a></li>
|
||||
<li class="method public "><a href="#random" title="random :: Random ordering keyword"><span class="description">Random ordering keyword</span><pre>random()</pre></a></li>
|
||||
<li class="method public "><a href="#sequence_list" title="sequence_list :: Return sql to list sequences"><span class="description">Return sql to list sequences</span><pre>sequence_list()</pre></a></li>
|
||||
<li class="method public inherited"><a href="#sum" title="sum :: Get the 'sum' keyword"><span class="description">Get the 'sum' keyword</span><pre>sum()</pre></a></li>
|
||||
<li class="method public "><a href="#system_table_list" title="system_table_list :: Overridden in SQLite class"><span class="description">Overridden in SQLite class</span><pre>system_table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#table_list" title="table_list :: Returns sql to list tables"><span class="description">Returns sql to list tables</span><pre>table_list()</pre></a></li>
|
||||
<li class="method public "><a href="#trigger_list" title="trigger_list :: Returns sql to list triggers"><span class="description">Returns sql to list triggers</span><pre>trigger_list()</pre></a></li>
|
||||
<li class="method public "><a href="#type_list" title="type_list :: SQL to show list of field types"><span class="description">SQL to show list of field types</span><pre>type_list()</pre></a></li>
|
||||
<li class="method public "><a href="#view_list" title="view_list :: Returns sql to list views"><span class="description">Returns sql to list views</span><pre>view_list()</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CSQLite_SQL" id="\SQLite_SQL"></a><div href="../classes/SQLite_SQL.html" class="element class">
|
||||
<p class="short_description">SQLite Specific SQL</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="avg" id="avg"></a><div class="element clickable method public avg" data-toggle="collapse" data-target=".avg .collapse">
|
||||
<h2>Get the 'average' keyword</h2>
|
||||
<pre>avg() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::avg()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="column_list" id="column_list"></a><div class="element clickable method public column_list" data-toggle="collapse" data-target=".column_list .collapse">
|
||||
<h2>SQL to show infromation about columns in a table</h2>
|
||||
<pre>column_list(string $table) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$table</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="db_list" id="db_list"></a><div class="element clickable method public db_list" data-toggle="collapse" data-target=".db_list .collapse">
|
||||
<h2>Returns sql to list other databases</h2>
|
||||
<pre>db_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
|
||||
<h2>Get the 'distinct' keyword</h2>
|
||||
<pre>distinct() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::distinct()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="function_list" id="function_list"></a><div class="element clickable method public function_list" data-toggle="collapse" data-target=".function_list .collapse">
|
||||
<h2>Return sql to list functions</h2>
|
||||
<pre>function_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
|
||||
<h2>Limit clause</h2>
|
||||
<pre>limit(string $sql, int $limit, int $offset) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$sql</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$limit</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$offset</h4>
|
||||
<code>int</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="max" id="max"></a><div class="element clickable method public max" data-toggle="collapse" data-target=".max .collapse">
|
||||
<h2>Get the max keyword sql</h2>
|
||||
<pre>max() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::max()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="min" id="min"></a><div class="element clickable method public min" data-toggle="collapse" data-target=".min .collapse">
|
||||
<h2>Get the min keyword sql</h2>
|
||||
<pre>min() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::min()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="procedure_list" id="procedure_list"></a><div class="element clickable method public procedure_list" data-toggle="collapse" data-target=".procedure_list .collapse">
|
||||
<h2>Return sql to list stored procedures</h2>
|
||||
<pre>procedure_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="random" id="random"></a><div class="element clickable method public random" data-toggle="collapse" data-target=".random .collapse">
|
||||
<h2>Random ordering keyword</h2>
|
||||
<pre>random() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sequence_list" id="sequence_list"></a><div class="element clickable method public sequence_list" data-toggle="collapse" data-target=".sequence_list .collapse">
|
||||
<h2>Return sql to list sequences</h2>
|
||||
<pre>sequence_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="sum" id="sum"></a><div class="element clickable method public sum" data-toggle="collapse" data-target=".sum .collapse">
|
||||
<h2>Get the 'sum' keyword</h2>
|
||||
<pre>sum() : string</pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_SQL::sum()</td>
|
||||
</tr></table>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="system_table_list" id="system_table_list"></a><div class="element clickable method public system_table_list" data-toggle="collapse" data-target=".system_table_list .collapse">
|
||||
<h2>Overridden in SQLite class</h2>
|
||||
<pre>system_table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="table_list" id="table_list"></a><div class="element clickable method public table_list" data-toggle="collapse" data-target=".table_list .collapse">
|
||||
<h2>Returns sql to list tables</h2>
|
||||
<pre>table_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="trigger_list" id="trigger_list"></a><div class="element clickable method public trigger_list" data-toggle="collapse" data-target=".trigger_list .collapse">
|
||||
<h2>Returns sql to list triggers</h2>
|
||||
<pre>trigger_list() : FALSE</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>FALSE</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="type_list" id="type_list"></a><div class="element clickable method public type_list" data-toggle="collapse" data-target=".type_list .collapse">
|
||||
<h2>SQL to show list of field types</h2>
|
||||
<pre>type_list() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="view_list" id="view_list"></a><div class="element clickable method public view_list" data-toggle="collapse" data-target=".view_list .collapse">
|
||||
<h2>Returns sql to list views</h2>
|
||||
<pre>view_list() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,216 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \SQLite_Util</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public inherited"><a href="#__call" title="__call :: Enable calling driver methods"><span class="description">Enable calling driver methods</span><pre>__call()</pre></a></li>
|
||||
<li class="method public "><a href="#__construct" title="__construct :: Save a reference to the 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="#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="#backup_structure" title="backup_structure :: Create an SQL backup file for the current database's structure"><span class="description">Create an SQL backup file for the current database's structure</span><pre>backup_structure()</pre></a></li>
|
||||
<li class="method public "><a href="#create_table" title="create_table :: Convenience public function to create a new table"><span class="description">Convenience public function to create a new table</span><pre>create_table()</pre></a></li>
|
||||
<li class="method public "><a href="#delete_table" title="delete_table :: SQL to drop the specified table"><span class="description">SQL to drop the specified table</span><pre>delete_table()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private inherited"><a href="#%24conn" title="$conn :: Reference to the current connection object"><span class="description">Reference to the current connection object</span><pre>$conn</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CSQLite_Util" id="\SQLite_Util"></a><div href="../classes/SQLite_Util.html" class="element class">
|
||||
<p class="short_description">SQLite-specific backup, import and creation methods</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Drivers.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Drivers</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
|
||||
<h2>Enable calling driver methods</h2>
|
||||
<pre>__call(string $method, array $args) </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::__call()</td>
|
||||
</tr></table>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$method</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$args</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Save a reference to the current connection object</h2>
|
||||
<pre>__construct(object $conn) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$conn</h4>
|
||||
<code>object</code><p>&$conn</p>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_data" id="backup_data"></a><div class="element clickable method public backup_data" data-toggle="collapse" data-target=".backup_data .collapse">
|
||||
<h2>Create an SQL backup file for the current database's data</h2>
|
||||
<pre>backup_data(array $excluded) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$excluded</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="backup_structure" id="backup_structure"></a><div class="element clickable method public backup_structure" data-toggle="collapse" data-target=".backup_structure .collapse">
|
||||
<h2>Create an SQL backup file for the current database's structure</h2>
|
||||
<pre>backup_structure() : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="create_table" id="create_table"></a><div class="element clickable method public create_table" data-toggle="collapse" data-target=".create_table .collapse">
|
||||
<h2>Convenience public function to create a new table</h2>
|
||||
<pre>create_table(string $name, array $columns, array $constraints, array $indexes) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code><p>//Name of the table</p>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$columns</h4>
|
||||
<code>array</code><p>//columns as straight array and/or column => type pairs</p>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$constraints</h4>
|
||||
<code>array</code><p>// column => constraint pairs</p>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$indexes</h4>
|
||||
<code>array</code><p>// column => index pairs</p>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="delete_table" id="delete_table"></a><div class="element clickable method public delete_table" data-toggle="collapse" data-target=".delete_table .collapse">
|
||||
<h2>SQL to drop the specified table</h2>
|
||||
<pre>delete_table(string $name) : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>string</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24conn" id="$conn"> </a><div class="element clickable property private $conn" data-toggle="collapse" data-target=".$conn .collapse">
|
||||
<h2>Reference to the current connection object</h2>
|
||||
<pre>$conn </pre>
|
||||
<div class="labels"><span class="label">Inherited</span></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered"><tr>
|
||||
<th>inherited_from</th>
|
||||
<td>\DB_Util::$$conn</td>
|
||||
</tr></table>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,252 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » \Settings</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-method"></i> Methods</li>
|
||||
<li class="method public "><a href="#__destruct" title="__destruct :: Output the settings on destruct"><span class="description">Output the settings on destruct</span><pre>__destruct()</pre></a></li>
|
||||
<li class="method public "><a href="#__get" title="__get :: Magic method to simplify isset checking for config options"><span class="description">Magic method to simplify isset checking for config options</span><pre>__get()</pre></a></li>
|
||||
<li class="method public "><a href="#__set" title="__set :: Magic method to simplify setting config options"><span class="description">Magic method to simplify setting config options</span><pre>__set()</pre></a></li>
|
||||
<li class="method public "><a href="#add_db" title="add_db :: Add a database connection"><span class="description">Add a database connection</span><pre>add_db()</pre></a></li>
|
||||
<li class="method public "><a href="#edit_db" title="edit_db :: Edit a database connection"><span class="description">Edit a database connection</span><pre>edit_db()</pre></a></li>
|
||||
<li class="method public "><a href="#get_db" title="get_db :: Retreive a specific database connection"><span class="description">Retreive a specific database connection</span><pre>get_db()</pre></a></li>
|
||||
<li class="method public "><a href="#get_dbs" title="get_dbs :: Retreive all db connections"><span class="description">Retreive all db connections</span><pre>get_dbs()</pre></a></li>
|
||||
<li class="method public "><a href="#get_instance" title="get_instance :: Static method to retreive current instance
|
||||
of the singleton"><span class="description">Static method to retreive current instance
|
||||
of the singleton</span><pre>get_instance()</pre></a></li>
|
||||
<li class="method public "><a href="#remove_db" title="remove_db :: Remove a database connection"><span class="description">Remove a database connection</span><pre>remove_db()</pre></a></li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="method private "><a href="#__construct" title="__construct :: Load the settings file - private so it can't be loaded
|
||||
directly - the settings should be safe!"><span class="description">Load the settings file - private so it can't be loaded
|
||||
directly - the settings should be safe!</span><pre>__construct()</pre></a></li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-property"></i> Properties</li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private "><a href="#%24current" title="$current :: Settings object represented by the currently loaded JSON file"><span class="description">Settings object represented by the currently loaded JSON file</span><pre>$current</pre></a></li>
|
||||
<li class="property private "><a href="#%24instance" title="$instance :: Singleton instance"><span class="description">Singleton instance</span><pre>$instance</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CSettings" id="\Settings"></a><div href="../classes/Settings.html" class="element class">
|
||||
<p class="short_description">Class for manipulating datbase connections, and miscellaneous settings</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/Query.Helper%20Classes.html">Query</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Helper Classes</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>
|
||||
<i class="icon-custom icon-method"></i> Methods</h3>
|
||||
<a name="__destruct" id="__destruct"></a><div class="element clickable method public __destruct" data-toggle="collapse" data-target=".__destruct .collapse">
|
||||
<h2>Output the settings on destruct</h2>
|
||||
<pre>__destruct() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="__get" id="__get"></a><div class="element clickable method public __get" data-toggle="collapse" data-target=".__get .collapse">
|
||||
<h2>Magic method to simplify isset checking for config options</h2>
|
||||
<pre>__get(string $key) : mixed</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$key</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__set" id="__set"></a><div class="element clickable method public __set" data-toggle="collapse" data-target=".__set .collapse">
|
||||
<h2>Magic method to simplify setting config options</h2>
|
||||
<pre>__set(string $key, $val) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$key</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$val</h4>
|
||||
<code></code><p>mixed</p></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="add_db" id="add_db"></a><div class="element clickable method public add_db" data-toggle="collapse" data-target=".add_db .collapse">
|
||||
<h2>Add a database connection</h2>
|
||||
<pre>add_db(string $name, array $params) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="edit_db" id="edit_db"></a><div class="element clickable method public edit_db" data-toggle="collapse" data-target=".edit_db .collapse">
|
||||
<h2>Edit a database connection</h2>
|
||||
<pre>edit_db(string $name, array $params) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$params</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_db" id="get_db"></a><div class="element clickable method public get_db" data-toggle="collapse" data-target=".get_db .collapse">
|
||||
<h2>Retreive a specific database connection</h2>
|
||||
<pre>get_db(string $name) : object</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>object</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_dbs" id="get_dbs"></a><div class="element clickable method public get_dbs" data-toggle="collapse" data-target=".get_dbs .collapse">
|
||||
<h2>Retreive all db connections</h2>
|
||||
<pre>get_dbs() : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_instance" id="get_instance"></a><div class="element clickable method public get_instance" data-toggle="collapse" data-target=".get_instance .collapse">
|
||||
<h2>Static method to retreive current instance
|
||||
of the singleton</h2>
|
||||
<pre>get_instance() : <a href="../classes/Settings.html">\Settings</a></pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code><a href="../classes/Settings.html">\Settings</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="remove_db" id="remove_db"></a><div class="element clickable method public remove_db" data-toggle="collapse" data-target=".remove_db .collapse">
|
||||
<h2>Remove a database connection</h2>
|
||||
<pre>remove_db(string $name) </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="__construct" id="__construct"></a><div class="element clickable method private __construct" data-toggle="collapse" data-target=".__construct .collapse">
|
||||
<h2>Load the settings file - private so it can't be loaded
|
||||
directly - the settings should be safe!</h2>
|
||||
<pre>__construct() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24current" id="$current"> </a><div class="element clickable property private $current" data-toggle="collapse" data-target=".$current .collapse">
|
||||
<h2>Settings object represented by the currently loaded JSON file</h2>
|
||||
<pre>$current </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24instance" id="$instance"> </a><div class="element clickable property private $instance" data-toggle="collapse" data-target=".$instance .collapse">
|
||||
<h2>Singleton instance</h2>
|
||||
<pre>$instance </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -904,7 +901,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -826,7 +823,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -613,7 +610,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -69,7 +66,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -82,35 +79,12 @@
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
<div class="package-contents"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -66,7 +63,7 @@
|
||||
</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>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -59,7 +56,6 @@
|
||||
<div class="span7"><div class="well"><ul class="nav nav-list">
|
||||
<li class="nav-header">Packages</li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul></div></div>
|
||||
<div class="span5">
|
||||
@ -73,9 +69,7 @@
|
||||
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul></div>
|
||||
@ -84,7 +78,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -52,15 +49,7 @@
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4"><ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">Navigation</li>
|
||||
<li><a href="#sys/db/classes/query_builder.php"><i class="icon-file"></i>sys/db/classes/query_builder.php</a></li>
|
||||
<li><a href="#sys/db/drivers/pgsql/pgsql_util.php"><i class="icon-file"></i>sys/db/drivers/pgsql/pgsql_util.php</a></li>
|
||||
<li><a href="#sys/db/drivers/pgsql/pgsql_driver.php"><i class="icon-file"></i>sys/db/drivers/pgsql/pgsql_driver.php</a></li>
|
||||
<li><a href="#sys/db/drivers/mysql/mysql_util.php"><i class="icon-file"></i>sys/db/drivers/mysql/mysql_util.php</a></li>
|
||||
<li><a href="#sys/db/drivers/mysql/mysql_driver.php"><i class="icon-file"></i>sys/db/drivers/mysql/mysql_driver.php</a></li>
|
||||
<li><a href="#sys/db/drivers/firebird/firebird_util.php"><i class="icon-file"></i>sys/db/drivers/firebird/firebird_util.php</a></li>
|
||||
</ul></div>
|
||||
<div class="span4"><ul class="side-nav nav nav-list"><li class="nav-header">Navigation</li></ul></div>
|
||||
<div class="span8">
|
||||
<ul class="breadcrumb">
|
||||
<li>
|
||||
@ -68,122 +57,18 @@
|
||||
</li>
|
||||
<li>Markers</li>
|
||||
</ul>
|
||||
<div class="alert alert-info">No markers have been found in this project.</div>
|
||||
<div class="alert alert-info">
|
||||
The following markers were found:
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div id="marker-accordion">
|
||||
<div class="package-contents">
|
||||
<a name="sys/db/classes/query_builder.php" id="sys/db/classes/query_builder.php"></a><h3>
|
||||
<i class="icon-file"></i>sys/db/classes/query_builder.php<small style="float: right;padding-right: 10px;">1</small>
|
||||
</h3>
|
||||
<div><table class="table markers table-bordered">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Line</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>todo</td>
|
||||
<td>805</td>
|
||||
<td>make able to handle operators without spaces</td>
|
||||
</tr>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="package-contents">
|
||||
<a name="sys/db/drivers/pgsql/pgsql_util.php" id="sys/db/drivers/pgsql/pgsql_util.php"></a><h3>
|
||||
<i class="icon-file"></i>sys/db/drivers/pgsql/pgsql_util.php<small style="float: right;padding-right: 10px;">1</small>
|
||||
</h3>
|
||||
<div><table class="table markers table-bordered">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Line</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>todo</td>
|
||||
<td>114</td>
|
||||
<td>Implement Backup function</td>
|
||||
</tr>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="package-contents">
|
||||
<a name="sys/db/drivers/pgsql/pgsql_driver.php" id="sys/db/drivers/pgsql/pgsql_driver.php"></a><h3>
|
||||
<i class="icon-file"></i>sys/db/drivers/pgsql/pgsql_driver.php<small style="float: right;padding-right: 10px;">1</small>
|
||||
</h3>
|
||||
<div><table class="table markers table-bordered">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Line</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>todo</td>
|
||||
<td>46</td>
|
||||
<td>Implement</td>
|
||||
</tr>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="package-contents">
|
||||
<a name="sys/db/drivers/mysql/mysql_util.php" id="sys/db/drivers/mysql/mysql_util.php"></a><h3>
|
||||
<i class="icon-file"></i>sys/db/drivers/mysql/mysql_util.php<small style="float: right;padding-right: 10px;">1</small>
|
||||
</h3>
|
||||
<div><table class="table markers table-bordered">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Line</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>todo</td>
|
||||
<td>141</td>
|
||||
<td>Implement Backup function</td>
|
||||
</tr>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="package-contents">
|
||||
<a name="sys/db/drivers/mysql/mysql_driver.php" id="sys/db/drivers/mysql/mysql_driver.php"></a><h3>
|
||||
<i class="icon-file"></i>sys/db/drivers/mysql/mysql_driver.php<small style="float: right;padding-right: 10px;">1</small>
|
||||
</h3>
|
||||
<div><table class="table markers table-bordered">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Line</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>todo</td>
|
||||
<td>57</td>
|
||||
<td>Implement</td>
|
||||
</tr>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="package-contents">
|
||||
<a name="sys/db/drivers/firebird/firebird_util.php" id="sys/db/drivers/firebird/firebird_util.php"></a><h3>
|
||||
<i class="icon-file"></i>sys/db/drivers/firebird/firebird_util.php<small style="float: right;padding-right: 10px;">1</small>
|
||||
</h3>
|
||||
<div><table class="table markers table-bordered">
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Line</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>todo</td>
|
||||
<td>117</td>
|
||||
<td>Implement Backup structure function</td>
|
||||
</tr>
|
||||
</table></div>
|
||||
</div>
|
||||
<ul></ul>
|
||||
</div>
|
||||
<div id="marker-accordion"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -143,39 +140,6 @@
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="db_filter" id="db_filter"></a><div class="element clickable function db_filter" data-toggle="collapse" data-target=".db_filter .collapse">
|
||||
<h2>Filter out db rows into one array</h2>
|
||||
<pre>db_filter(array $array, mixed $index) : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$array</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$index</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="do_include" id="do_include"></a><div class="element clickable function do_include" data-toggle="collapse" data-target=".do_include .collapse">
|
||||
<h2>Bulk directory loading workaround for use
|
||||
with array_map and glob</h2>
|
||||
<pre>do_include(string $path) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$path</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="do_include" id="do_include"></a><div class="element clickable function do_include" data-toggle="collapse" data-target=".do_include .collapse">
|
||||
<h2>Array_map callback to load a folder of classes at once</h2>
|
||||
<pre>do_include(string $path) : void</pre>
|
||||
@ -351,63 +315,6 @@ display them cleanly</h2>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="DB_PDO" id="DB_PDO"></a><div class="element ajax clickable class" href="../classes/DB_PDO.html">
|
||||
<h1>DB_PDO<a href="../classes/DB_PDO.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Base Database class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_PDO.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="DB_Reg" id="DB_Reg"></a><div class="element ajax clickable class" href="../classes/DB_Reg.html">
|
||||
<h1>DB_Reg<a href="../classes/DB_Reg.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Connection registry</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_Reg.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="DB_SQL" id="DB_SQL"></a><div class="element ajax clickable class" href="../classes/DB_SQL.html">
|
||||
<h1>DB_SQL<a href="../classes/DB_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Abstract parent for database manipulation subclasses</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="DB_Util" id="DB_Util"></a><div class="element ajax clickable class" href="../classes/DB_Util.html">
|
||||
<h1>DB_Util<a href="../classes/DB_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Abstract class defining database / table creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird" id="Firebird"></a><div class="element ajax clickable class" href="../classes/Firebird.html">
|
||||
<h1>Firebird<a href="../classes/Firebird.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird Database class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_Result" id="Firebird_Result"></a><div class="element ajax clickable class" href="../classes/Firebird_Result.html">
|
||||
<h1>Firebird_Result<a href="../classes/Firebird_Result.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
|
||||
data-fetching methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_Result.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_SQL" id="Firebird_SQL"></a><div class="element ajax clickable class" href="../classes/Firebird_SQL.html">
|
||||
<h1>Firebird_SQL<a href="../classes/Firebird_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird Specific SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_Util" id="Firebird_Util"></a><div class="element ajax clickable class" href="../classes/Firebird_Util.html">
|
||||
<h1>Firebird_Util<a href="../classes/Firebird_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MM" id="MM"></a><div class="element ajax clickable class" href="../classes/MM.html">
|
||||
<h1>MM<a href="../classes/MM.html">¶</a>
|
||||
</h1>
|
||||
@ -457,105 +364,6 @@ data-fetching methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MM_Session.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL" id="MySQL"></a><div class="element ajax clickable class" href="../classes/MySQL.html">
|
||||
<h1>MySQL<a href="../classes/MySQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL specific class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL_SQL" id="MySQL_SQL"></a><div class="element ajax clickable class" href="../classes/MySQL_SQL.html">
|
||||
<h1>MySQL_SQL<a href="../classes/MySQL_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL specifc SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL_Util" id="MySQL_Util"></a><div class="element ajax clickable class" href="../classes/MySQL_Util.html">
|
||||
<h1>MySQL_Util<a href="../classes/MySQL_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC" id="ODBC"></a><div class="element ajax clickable class" href="../classes/ODBC.html">
|
||||
<h1>ODBC<a href="../classes/ODBC.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC Database Driver</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC_SQL" id="ODBC_SQL"></a><div class="element ajax clickable class" href="../classes/ODBC_SQL.html">
|
||||
<h1>ODBC_SQL<a href="../classes/ODBC_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC SQL Class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC_Util" id="ODBC_Util"></a><div class="element ajax clickable class" href="../classes/ODBC_Util.html">
|
||||
<h1>ODBC_Util<a href="../classes/ODBC_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL" id="PgSQL"></a><div class="element ajax clickable class" href="../classes/PgSQL.html">
|
||||
<h1>PgSQL<a href="../classes/PgSQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">PostgreSQL specifc class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL_SQL" id="PgSQL_SQL"></a><div class="element ajax clickable class" href="../classes/PgSQL_SQL.html">
|
||||
<h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">PostgreSQL specifc SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL_Util" id="PgSQL_Util"></a><div class="element ajax clickable class" href="../classes/PgSQL_Util.html">
|
||||
<h1>PgSQL_Util<a href="../classes/PgSQL_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Posgres-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Query_Builder" id="Query_Builder"></a><div class="element ajax clickable class" href="../classes/Query_Builder.html">
|
||||
<h1>Query_Builder<a href="../classes/Query_Builder.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Convienience class for creating sql queries - also the class that
|
||||
instantiates the specific db driver</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Query_Builder.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite" id="SQLite"></a><div class="element ajax clickable class" href="../classes/SQLite.html">
|
||||
<h1>SQLite<a href="../classes/SQLite.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite specific class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite_SQL" id="SQLite_SQL"></a><div class="element ajax clickable class" href="../classes/SQLite_SQL.html">
|
||||
<h1>SQLite_SQL<a href="../classes/SQLite_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite Specific SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite_Util" id="SQLite_Util"></a><div class="element ajax clickable class" href="../classes/SQLite_Util.html">
|
||||
<h1>SQLite_Util<a href="../classes/SQLite_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Settings" id="Settings"></a><div class="element ajax clickable class" href="../classes/Settings.html">
|
||||
<h1>Settings<a href="../classes/Settings.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Class for manipulating datbase connections, and miscellaneous settings</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Settings.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Welcome" id="Welcome"></a><div class="element ajax clickable class" href="../classes/Welcome.html">
|
||||
<h1>Welcome<a href="../classes/Welcome.html">¶</a>
|
||||
</h1>
|
||||
@ -651,18 +459,6 @@ instantiates the specific db driver</p>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="QBASE_PATH" id="QBASE_PATH"> </a><div class="element clickable constant QBASE_PATH" data-toggle="collapse" data-target=".QBASE_PATH .collapse">
|
||||
<h2>Reference to root path</h2>
|
||||
<pre>QBASE_PATH </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="QDRIVER_PATH" id="QDRIVER_PATH"> </a><div class="element clickable constant QDRIVER_PATH" data-toggle="collapse" data-target=".QDRIVER_PATH .collapse">
|
||||
<h2>Path to driver classes</h2>
|
||||
<pre>QDRIVER_PATH </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="SCRIPT_PATH" id="SCRIPT_PATH"> </a><div class="element clickable constant SCRIPT_PATH" data-toggle="collapse" data-target=".SCRIPT_PATH .collapse">
|
||||
<h2>SCRIPT_PATH</h2>
|
||||
<pre>SCRIPT_PATH </pre>
|
||||
@ -717,7 +513,7 @@ instantiates the specific db driver</p>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -69,7 +66,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -73,8 +70,6 @@
|
||||
<li class="constant "><a href="#MM_BASE_PATH" title="MM_BASE_PATH :: "><span class="description">MM_BASE_PATH</span><pre>MM_BASE_PATH</pre></a></li>
|
||||
<li class="constant "><a href="#MM_MOD_PATH" title="MM_MOD_PATH :: "><span class="description">MM_MOD_PATH</span><pre>MM_MOD_PATH</pre></a></li>
|
||||
<li class="constant "><a href="#MM_SYS_PATH" title="MM_SYS_PATH :: "><span class="description">MM_SYS_PATH</span><pre>MM_SYS_PATH</pre></a></li>
|
||||
<li class="constant "><a href="#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="#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="#SCRIPT_PATH" title="SCRIPT_PATH :: "><span class="description">SCRIPT_PATH</span><pre>SCRIPT_PATH</pre></a></li>
|
||||
<li class="constant "><a href="#STATIC_LIB_PATH" title="STATIC_LIB_PATH :: "><span class="description">STATIC_LIB_PATH</span><pre>STATIC_LIB_PATH</pre></a></li>
|
||||
<li class="constant "><a href="#STYLE_PATH" title="STYLE_PATH :: "><span class="description">STYLE_PATH</span><pre>STYLE_PATH</pre></a></li>
|
||||
@ -146,18 +141,6 @@
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="QBASE_PATH" id="QBASE_PATH"> </a><div class="element clickable constant QBASE_PATH" data-toggle="collapse" data-target=".QBASE_PATH .collapse">
|
||||
<h2>Reference to root path</h2>
|
||||
<pre>QBASE_PATH </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="QDRIVER_PATH" id="QDRIVER_PATH"> </a><div class="element clickable constant QDRIVER_PATH" data-toggle="collapse" data-target=".QDRIVER_PATH .collapse">
|
||||
<h2>Path to driver classes</h2>
|
||||
<pre>QDRIVER_PATH </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="SCRIPT_PATH" id="SCRIPT_PATH"> </a><div class="element clickable constant SCRIPT_PATH" data-toggle="collapse" data-target=".SCRIPT_PATH .collapse">
|
||||
<h2>SCRIPT_PATH</h2>
|
||||
<pre>SCRIPT_PATH </pre>
|
||||
@ -194,7 +177,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -1,219 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » Query\Drivers</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-map-marker"></i> Packages</li>
|
||||
<li>
|
||||
<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 class="nav-header">
|
||||
<i class="icon-custom icon-class"></i> Classes</li>
|
||||
<li><a href="#PgSQL_SQL" title="PostgreSQL specifc SQL">PgSQL_SQL</a></li>
|
||||
<li><a href="#PgSQL_Util" title="Posgres-specific backup, import and creation methods">PgSQL_Util</a></li>
|
||||
<li><a href="#PgSQL" title="PostgreSQL specifc class">PgSQL</a></li>
|
||||
<li><a href="#ODBC_Util" title="ODBC-specific backup, import and creation methods">ODBC_Util</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="#MySQL_Util" title="MySQL-specific backup, import and creation methods">MySQL_Util</a></li>
|
||||
<li><a href="#MySQL" title="MySQL specific class">MySQL</a></li>
|
||||
<li><a href="#MySQL_SQL" title="MySQL specifc SQL">MySQL_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_SQL" title="SQLite Specific SQL">SQLite_SQL</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
|
||||
data-fetching methods">Firebird_Result</a></li>
|
||||
<li><a href="#Firebird" title="Firebird Database class">Firebird</a></li>
|
||||
<li><a href="#Firebird_Util" title="Firebird-specific backup, import and creation methods">Firebird_Util</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8 package-contents">
|
||||
<ul class="breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
|
||||
</li>
|
||||
<li><a href="../packages/Query.html">Query</a></li>
|
||||
<span class="divider">\</span><li class="active"><a href="../packages/Query.Drivers.html">Drivers</a></li>
|
||||
</ul>
|
||||
<div class="package-indent">
|
||||
<h3>
|
||||
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||||
<a name="Firebird" id="Firebird"></a><div class="element ajax clickable class" href="../classes/Firebird.html">
|
||||
<h1>Firebird<a href="../classes/Firebird.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird Database class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_Result" id="Firebird_Result"></a><div class="element ajax clickable class" href="../classes/Firebird_Result.html">
|
||||
<h1>Firebird_Result<a href="../classes/Firebird_Result.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
|
||||
data-fetching methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_Result.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_SQL" id="Firebird_SQL"></a><div class="element ajax clickable class" href="../classes/Firebird_SQL.html">
|
||||
<h1>Firebird_SQL<a href="../classes/Firebird_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird Specific SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_Util" id="Firebird_Util"></a><div class="element ajax clickable class" href="../classes/Firebird_Util.html">
|
||||
<h1>Firebird_Util<a href="../classes/Firebird_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL" id="MySQL"></a><div class="element ajax clickable class" href="../classes/MySQL.html">
|
||||
<h1>MySQL<a href="../classes/MySQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL specific class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL_SQL" id="MySQL_SQL"></a><div class="element ajax clickable class" href="../classes/MySQL_SQL.html">
|
||||
<h1>MySQL_SQL<a href="../classes/MySQL_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL specifc SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL_Util" id="MySQL_Util"></a><div class="element ajax clickable class" href="../classes/MySQL_Util.html">
|
||||
<h1>MySQL_Util<a href="../classes/MySQL_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC" id="ODBC"></a><div class="element ajax clickable class" href="../classes/ODBC.html">
|
||||
<h1>ODBC<a href="../classes/ODBC.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC Database Driver</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC_SQL" id="ODBC_SQL"></a><div class="element ajax clickable class" href="../classes/ODBC_SQL.html">
|
||||
<h1>ODBC_SQL<a href="../classes/ODBC_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC SQL Class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC_Util" id="ODBC_Util"></a><div class="element ajax clickable class" href="../classes/ODBC_Util.html">
|
||||
<h1>ODBC_Util<a href="../classes/ODBC_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL" id="PgSQL"></a><div class="element ajax clickable class" href="../classes/PgSQL.html">
|
||||
<h1>PgSQL<a href="../classes/PgSQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">PostgreSQL specifc class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL_SQL" id="PgSQL_SQL"></a><div class="element ajax clickable class" href="../classes/PgSQL_SQL.html">
|
||||
<h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">PostgreSQL specifc SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL_Util" id="PgSQL_Util"></a><div class="element ajax clickable class" href="../classes/PgSQL_Util.html">
|
||||
<h1>PgSQL_Util<a href="../classes/PgSQL_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Posgres-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite" id="SQLite"></a><div class="element ajax clickable class" href="../classes/SQLite.html">
|
||||
<h1>SQLite<a href="../classes/SQLite.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite specific class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite_SQL" id="SQLite_SQL"></a><div class="element ajax clickable class" href="../classes/SQLite_SQL.html">
|
||||
<h1>SQLite_SQL<a href="../classes/SQLite_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite Specific SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite_Util" id="SQLite_Util"></a><div class="element ajax clickable class" href="../classes/SQLite_Util.html">
|
||||
<h1>SQLite_Util<a href="../classes/SQLite_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,105 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » Query\Helper Classes</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-map-marker"></i> Packages</li>
|
||||
<li>
|
||||
<a href="../packages/Query.Helper%20Classes.html" title="Helper Classes"><i class="icon-folder-open"></i>Helper Classes</a><ul class="nav nav-list nav-packages"></ul>
|
||||
</li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-class"></i> Classes</li>
|
||||
<li><a href="#DB_Reg" title="Connection registry">DB_Reg</a></li>
|
||||
<li><a href="#Settings" title="Class for manipulating datbase connections, and miscellaneous settings">Settings</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8 package-contents">
|
||||
<ul class="breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
|
||||
</li>
|
||||
<li><a href="../packages/Query.html">Query</a></li>
|
||||
<span class="divider">\</span><li class="active"><a href="../packages/Query.Helper%20Classes.html">Helper Classes</a></li>
|
||||
</ul>
|
||||
<div class="package-indent">
|
||||
<h3>
|
||||
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||||
<a name="DB_Reg" id="DB_Reg"></a><div class="element ajax clickable class" href="../classes/DB_Reg.html">
|
||||
<h1>DB_Reg<a href="../classes/DB_Reg.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Connection registry</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_Reg.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Settings" id="Settings"></a><div class="element ajax clickable class" href="../classes/Settings.html">
|
||||
<h1>Settings<a href="../classes/Settings.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Class for manipulating datbase connections, and miscellaneous settings</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Settings.html" class="more">« More »</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,123 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » Query\Query</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-map-marker"></i> Packages</li>
|
||||
<li>
|
||||
<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 class="nav-header">
|
||||
<i class="icon-custom icon-class"></i> Classes</li>
|
||||
<li><a href="#DB_SQL" title="Abstract parent for database manipulation subclasses">DB_SQL</a></li>
|
||||
<li><a href="#DB_PDO" title="Base Database class">DB_PDO</a></li>
|
||||
<li><a href="#Query_Builder" title="Convienience class for creating sql queries - also the class that
|
||||
instantiates the specific db driver">Query_Builder</a></li>
|
||||
<li><a href="#DB_Util" title="Abstract class defining database / table creation methods">DB_Util</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8 package-contents">
|
||||
<ul class="breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
|
||||
</li>
|
||||
<li><a href="../packages/Query.html">Query</a></li>
|
||||
<span class="divider">\</span><li class="active"><a href="../packages/Query.Query.html">Query</a></li>
|
||||
</ul>
|
||||
<div class="package-indent">
|
||||
<h3>
|
||||
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||||
<a name="DB_PDO" id="DB_PDO"></a><div class="element ajax clickable class" href="../classes/DB_PDO.html">
|
||||
<h1>DB_PDO<a href="../classes/DB_PDO.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Base Database class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_PDO.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="DB_SQL" id="DB_SQL"></a><div class="element ajax clickable class" href="../classes/DB_SQL.html">
|
||||
<h1>DB_SQL<a href="../classes/DB_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Abstract parent for database manipulation subclasses</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="DB_Util" id="DB_Util"></a><div class="element ajax clickable class" href="../classes/DB_Util.html">
|
||||
<h1>DB_Util<a href="../classes/DB_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Abstract class defining database / table creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Query_Builder" id="Query_Builder"></a><div class="element ajax clickable class" href="../classes/Query_Builder.html">
|
||||
<h1>Query_Builder<a href="../classes/Query_Builder.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Convienience class for creating sql queries - also the class that
|
||||
instantiates the specific db driver</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Query_Builder.html" class="more">« More »</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,324 +0,0 @@
|
||||
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||||
<meta charset="utf-8">
|
||||
<title>miniMVC » Query</title>
|
||||
<meta name="author" content="Mike van Riel">
|
||||
<meta name="description" content="">
|
||||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner"><div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
|
||||
<li class="dropdown">
|
||||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div></div>
|
||||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||||
</div>
|
||||
<div id="___" class="container">
|
||||
<noscript><div class="alert alert-warning">
|
||||
Javascript is disabled; several features are only available
|
||||
if Javascript is enabled.
|
||||
</div></noscript>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||||
</div>
|
||||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">
|
||||
<i class="icon-map-marker"></i> Packages</li>
|
||||
<li>
|
||||
<a href="../packages/Query.html" title="Query"><i class="icon-folder-open"></i>Query</a><ul class="nav nav-list nav-packages">
|
||||
<li>
|
||||
<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>
|
||||
<a href="../packages/Query.Helper%20Classes.html" title="Helper Classes"><i class="icon-folder-open"></i>Helper Classes</a><ul class="nav nav-list nav-packages"></ul>
|
||||
</li>
|
||||
<li>
|
||||
<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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-header">
|
||||
<i class="icon-custom icon-function"></i> Functions</li>
|
||||
<li class="function "><a href="#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="#do_include" title="do_include :: Bulk directory loading workaround for use
|
||||
with array_map and glob"><span class="description">Bulk directory loading workaround for use
|
||||
with array_map and glob</span><pre>do_include</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8 package-contents">
|
||||
<ul class="breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
|
||||
</li>
|
||||
<li class="active"><a href="../packages/Query.html">Query</a></li>
|
||||
</ul>
|
||||
<div class="package-indent">
|
||||
<h3>
|
||||
<i class="icon-custom icon-function"></i> Functions</h3>
|
||||
<a name="db_filter" id="db_filter"></a><div class="element clickable function db_filter" data-toggle="collapse" data-target=".db_filter .collapse">
|
||||
<h2>Filter out db rows into one array</h2>
|
||||
<pre>db_filter(array $array, mixed $index) : array</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$array</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$index</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>array</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="do_include" id="do_include"></a><div class="element clickable function do_include" data-toggle="collapse" data-target=".do_include .collapse">
|
||||
<h2>Bulk directory loading workaround for use
|
||||
with array_map and glob</h2>
|
||||
<pre>do_include(string $path) : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8">
|
||||
<p class="long_description"></p>
|
||||
<h3>Parameters</h3>
|
||||
<div class="subelement argument">
|
||||
<h4>$path</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<ul class="breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
|
||||
</li>
|
||||
<li><a href="../packages/Query.html">Query</a></li>
|
||||
<span class="divider">\</span><li class="active"><a href="../packages/Query.Drivers.html">Drivers</a></li>
|
||||
</ul>
|
||||
<div class="package-indent">
|
||||
<h3>
|
||||
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||||
<a name="Firebird" id="Firebird"></a><div class="element ajax clickable class" href="../classes/Firebird.html">
|
||||
<h1>Firebird<a href="../classes/Firebird.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird Database class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_Result" id="Firebird_Result"></a><div class="element ajax clickable class" href="../classes/Firebird_Result.html">
|
||||
<h1>Firebird_Result<a href="../classes/Firebird_Result.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
|
||||
data-fetching methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_Result.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_SQL" id="Firebird_SQL"></a><div class="element ajax clickable class" href="../classes/Firebird_SQL.html">
|
||||
<h1>Firebird_SQL<a href="../classes/Firebird_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird Specific SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Firebird_Util" id="Firebird_Util"></a><div class="element ajax clickable class" href="../classes/Firebird_Util.html">
|
||||
<h1>Firebird_Util<a href="../classes/Firebird_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Firebird-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Firebird_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL" id="MySQL"></a><div class="element ajax clickable class" href="../classes/MySQL.html">
|
||||
<h1>MySQL<a href="../classes/MySQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL specific class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL_SQL" id="MySQL_SQL"></a><div class="element ajax clickable class" href="../classes/MySQL_SQL.html">
|
||||
<h1>MySQL_SQL<a href="../classes/MySQL_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL specifc SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="MySQL_Util" id="MySQL_Util"></a><div class="element ajax clickable class" href="../classes/MySQL_Util.html">
|
||||
<h1>MySQL_Util<a href="../classes/MySQL_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">MySQL-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/MySQL_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC" id="ODBC"></a><div class="element ajax clickable class" href="../classes/ODBC.html">
|
||||
<h1>ODBC<a href="../classes/ODBC.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC Database Driver</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC_SQL" id="ODBC_SQL"></a><div class="element ajax clickable class" href="../classes/ODBC_SQL.html">
|
||||
<h1>ODBC_SQL<a href="../classes/ODBC_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC SQL Class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="ODBC_Util" id="ODBC_Util"></a><div class="element ajax clickable class" href="../classes/ODBC_Util.html">
|
||||
<h1>ODBC_Util<a href="../classes/ODBC_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">ODBC-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/ODBC_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL" id="PgSQL"></a><div class="element ajax clickable class" href="../classes/PgSQL.html">
|
||||
<h1>PgSQL<a href="../classes/PgSQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">PostgreSQL specifc class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL_SQL" id="PgSQL_SQL"></a><div class="element ajax clickable class" href="../classes/PgSQL_SQL.html">
|
||||
<h1>PgSQL_SQL<a href="../classes/PgSQL_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">PostgreSQL specifc SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="PgSQL_Util" id="PgSQL_Util"></a><div class="element ajax clickable class" href="../classes/PgSQL_Util.html">
|
||||
<h1>PgSQL_Util<a href="../classes/PgSQL_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Posgres-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/PgSQL_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite" id="SQLite"></a><div class="element ajax clickable class" href="../classes/SQLite.html">
|
||||
<h1>SQLite<a href="../classes/SQLite.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite specific class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite_SQL" id="SQLite_SQL"></a><div class="element ajax clickable class" href="../classes/SQLite_SQL.html">
|
||||
<h1>SQLite_SQL<a href="../classes/SQLite_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite Specific SQL</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="SQLite_Util" id="SQLite_Util"></a><div class="element ajax clickable class" href="../classes/SQLite_Util.html">
|
||||
<h1>SQLite_Util<a href="../classes/SQLite_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">SQLite-specific backup, import and creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/SQLite_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
</div>
|
||||
<ul class="breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
|
||||
</li>
|
||||
<li><a href="../packages/Query.html">Query</a></li>
|
||||
<span class="divider">\</span><li class="active"><a href="../packages/Query.Helper%20Classes.html">Helper Classes</a></li>
|
||||
</ul>
|
||||
<div class="package-indent">
|
||||
<h3>
|
||||
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||||
<a name="DB_Reg" id="DB_Reg"></a><div class="element ajax clickable class" href="../classes/DB_Reg.html">
|
||||
<h1>DB_Reg<a href="../classes/DB_Reg.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Connection registry</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_Reg.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Settings" id="Settings"></a><div class="element ajax clickable class" href="../classes/Settings.html">
|
||||
<h1>Settings<a href="../classes/Settings.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Class for manipulating datbase connections, and miscellaneous settings</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Settings.html" class="more">« More »</a>
|
||||
</div>
|
||||
</div>
|
||||
<ul class="breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html"><i class="icon-folder-open"></i></a><span class="divider">\</span>
|
||||
</li>
|
||||
<li><a href="../packages/Query.html">Query</a></li>
|
||||
<span class="divider">\</span><li class="active"><a href="../packages/Query.Query.html">Query</a></li>
|
||||
</ul>
|
||||
<div class="package-indent">
|
||||
<h3>
|
||||
<i class="icon-custom icon-class"></i> Classes and interfaces</h3>
|
||||
<a name="DB_PDO" id="DB_PDO"></a><div class="element ajax clickable class" href="../classes/DB_PDO.html">
|
||||
<h1>DB_PDO<a href="../classes/DB_PDO.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Base Database class</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_PDO.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="DB_SQL" id="DB_SQL"></a><div class="element ajax clickable class" href="../classes/DB_SQL.html">
|
||||
<h1>DB_SQL<a href="../classes/DB_SQL.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Abstract parent for database manipulation subclasses</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_SQL.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="DB_Util" id="DB_Util"></a><div class="element ajax clickable class" href="../classes/DB_Util.html">
|
||||
<h1>DB_Util<a href="../classes/DB_Util.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Abstract class defining database / table creation methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_Util.html" class="more">« More »</a>
|
||||
</div>
|
||||
<a name="Query_Builder" id="Query_Builder"></a><div class="element ajax clickable class" href="../classes/Query_Builder.html">
|
||||
<h1>Query_Builder<a href="../classes/Query_Builder.html">¶</a>
|
||||
</h1>
|
||||
<p class="short_description">Convienience class for creating sql queries - also the class that
|
||||
instantiates the specific db driver</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Query_Builder.html" class="more">« More »</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -141,7 +138,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -99,7 +96,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -139,7 +136,7 @@
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -21,7 +21,6 @@
|
||||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -35,9 +34,7 @@
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><li>todo
|
||||
<span class="label label-info">6</span>
|
||||
</li></ul></a></li>
|
||||
<ul></ul></a></li>
|
||||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||||
<span class="label label-info">0</span></a></li>
|
||||
</ul>
|
||||
@ -497,7 +494,7 @@ display them cleanly</h2>
|
||||
<div class="row"><footer class="span12">
|
||||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
|
||||
generated on 2012-05-15T10:23:19-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:38:56-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
5459
docs/structure.xml
5459
docs/structure.xml
File diff suppressed because it is too large
Load Diff
@ -16,10 +16,10 @@
|
||||
<directory>assets</directory>
|
||||
<directory>app/views</directory>
|
||||
<directory>app/errors</directory>
|
||||
<directory>sys/db/tests</directory>
|
||||
<directory>sys/db</directory>
|
||||
<ignore>tests/*</ignore>
|
||||
<ignore>assets/*</ignore>
|
||||
<ignore>sys/db/tests/*</ignore>
|
||||
<ignore>sys/db/*</ignore>
|
||||
<ignore>app/views/*</ignore>
|
||||
<ignore>app/errors/*</ignore>
|
||||
</files>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user