Remove Query from generated docs
This commit is contained in:
parent
c169a3a1db
commit
827dcd69da
432
docs/classes.svg
432
docs/classes.svg
@ -4,422 +4,170 @@
|
||||
<!-- Generated by graphviz version 2.26.3 (20100126.1600)
|
||||
-->
|
||||
<!-- Title: G Pages: 1 -->
|
||||
<svg width="554pt" height="1948pt"
|
||||
viewBox="0.00 0.00 554.00 1948.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 1944)">
|
||||
<svg width="394pt" height="562pt"
|
||||
viewBox="0.00 0.00 394.00 562.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 558)">
|
||||
<title>G</title>
|
||||
<polygon fill="white" stroke="white" points="-4,5 -4,-1944 551,-1944 551,5 -4,5"/>
|
||||
<polygon fill="white" stroke="white" points="-4,5 -4,-558 391,-558 391,5 -4,5"/>
|
||||
<g id="graph2" class="cluster"><title>cluster_default</title>
|
||||
<polyline fill="none" stroke="none" points="190,-368 526,-368 "/>
|
||||
<path fill="none" stroke="none" d="M526,-368C532,-368 538,-374 538,-380"/>
|
||||
<polyline fill="none" stroke="none" points="538,-380 538,-1920 "/>
|
||||
<path fill="none" stroke="none" d="M538,-1920C538,-1926 532,-1932 526,-1932"/>
|
||||
<polyline fill="none" stroke="none" points="526,-1932 190,-1932 "/>
|
||||
<path fill="none" stroke="none" d="M190,-1932C184,-1932 178,-1926 178,-1920"/>
|
||||
<polyline fill="none" stroke="none" points="178,-1920 178,-380 "/>
|
||||
<path fill="none" stroke="none" d="M178,-380C178,-374 184,-368 190,-368"/>
|
||||
</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="486,-1924 430,-1924 430,-1888 486,-1888 486,-1924"/>
|
||||
<text text-anchor="middle" x="458" y="-1902.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="493,-1870 423,-1870 423,-1834 493,-1834 493,-1870"/>
|
||||
<text text-anchor="middle" x="458" y="-1848.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="271,-1384 187,-1384 187,-1348 271,-1348 271,-1384"/>
|
||||
<text text-anchor="start" x="195" y="-1371.43" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
|
||||
<text text-anchor="start" x="208.5" y="-1358.23" 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="271,-1114 187,-1114 187,-1078 271,-1078 271,-1114"/>
|
||||
<text text-anchor="start" x="195" y="-1101.43" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
|
||||
<text text-anchor="start" x="208.5" y="-1088.23" font-family="Courier,monospace" font-size="11.00">DB_PDO</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\PDO -->
|
||||
<g id="node35" class="node"><title>\\PDO</title>
|
||||
<ellipse fill="none" stroke="black" cx="36" cy="-1096" rx="35.0527" ry="18"/>
|
||||
<text text-anchor="middle" x="36" y="-1091.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="M186.167,-1096C155.237,-1096 113.521,-1096 81.907,-1096"/>
|
||||
<polygon fill="none" stroke="black" points="81.603,-1092.5 71.603,-1096 81.603,-1099.5 81.603,-1092.5"/>
|
||||
</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="510,-1816 406,-1816 406,-1780 510,-1780 510,-1816"/>
|
||||
<text text-anchor="middle" x="458" y="-1794.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="271,-1654 187,-1654 187,-1618 271,-1618 271,-1654"/>
|
||||
<text text-anchor="start" x="195" y="-1641.43" font-family="Courier,monospace" font-size="11.00">«abstract»</text>
|
||||
<text text-anchor="start" x="205" y="-1628.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="496,-1492 420,-1492 420,-1456 496,-1456 496,-1492"/>
|
||||
<text text-anchor="middle" x="458" y="-1470.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="M419.175,-1460.39C408.333,-1456.34 396.617,-1451.71 386,-1447 345.811,-1429.17 301.402,-1405.91 270.101,-1388.89"/>
|
||||
<polygon fill="none" stroke="black" points="271.685,-1385.77 261.231,-1384.05 268.329,-1391.91 271.685,-1385.77"/>
|
||||
</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="500,-1762 416,-1762 416,-1726 500,-1726 500,-1762"/>
|
||||
<text text-anchor="middle" x="458" y="-1740.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="M415.784,-1729.12C405.921,-1725.38 395.518,-1721.22 386,-1717 345.811,-1699.17 301.402,-1675.91 270.101,-1658.89"/>
|
||||
<polygon fill="none" stroke="black" points="271.685,-1655.77 261.231,-1654.05 268.329,-1661.91 271.685,-1655.77"/>
|
||||
</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="485,-1222 431,-1222 431,-1186 485,-1186 485,-1222"/>
|
||||
<text text-anchor="middle" x="458" y="-1200.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="M430.686,-1194.61C417.1,-1189.73 400.522,-1183.44 386,-1177 345.811,-1159.17 301.402,-1135.91 270.101,-1118.89"/>
|
||||
<polygon fill="none" stroke="black" points="271.685,-1115.77 261.231,-1114.05 268.329,-1121.91 271.685,-1115.77"/>
|
||||
</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="496,-1708 420,-1708 420,-1672 496,-1672 496,-1708"/>
|
||||
<text text-anchor="middle" x="458" y="-1686.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="M419.412,-1680.9C381.532,-1671.97 323.477,-1658.28 281.428,-1648.36"/>
|
||||
<polygon fill="none" stroke="black" points="282.179,-1644.94 271.643,-1646.06 280.572,-1651.76 282.179,-1644.94"/>
|
||||
</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="493,-1438 423,-1438 423,-1402 493,-1402 493,-1438"/>
|
||||
<text text-anchor="middle" x="458" y="-1416.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="M422.721,-1411.68C385.009,-1402.79 324.808,-1388.59 281.522,-1378.39"/>
|
||||
<polygon fill="none" stroke="black" points="282.27,-1374.97 271.733,-1376.08 280.663,-1381.78 282.27,-1374.97"/>
|
||||
</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="485,-1168 431,-1168 431,-1132 485,-1132 485,-1168"/>
|
||||
<text text-anchor="middle" x="458" y="-1146.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="M430.831,-1143.59C394.186,-1134.95 328.158,-1119.38 281.622,-1108.41"/>
|
||||
<polygon fill="none" stroke="black" points="282.249,-1104.96 271.712,-1106.07 280.642,-1111.77 282.249,-1104.96"/>
|
||||
</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="500,-1654 416,-1654 416,-1618 500,-1618 500,-1654"/>
|
||||
<text text-anchor="middle" x="458" y="-1632.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="M415.464,-1636C377.744,-1636 322.503,-1636 281.936,-1636"/>
|
||||
<polygon fill="none" stroke="black" points="281.697,-1632.5 271.697,-1636 281.697,-1639.5 281.697,-1632.5"/>
|
||||
</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="485,-1114 431,-1114 431,-1078 485,-1078 485,-1114"/>
|
||||
<text text-anchor="middle" x="458" y="-1092.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="M430.831,-1096C394.263,-1096 328.435,-1096 281.915,-1096"/>
|
||||
<polygon fill="none" stroke="black" points="281.712,-1092.5 271.712,-1096 281.712,-1099.5 281.712,-1092.5"/>
|
||||
</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="497,-1384 419,-1384 419,-1348 497,-1348 497,-1384"/>
|
||||
<text text-anchor="middle" x="458" y="-1362.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="M418.894,-1366C381.129,-1366 323.667,-1366 281.845,-1366"/>
|
||||
<polygon fill="none" stroke="black" points="281.838,-1362.5 271.838,-1366 281.838,-1369.5 281.838,-1362.5"/>
|
||||
</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="503,-1600 413,-1600 413,-1564 503,-1564 503,-1600"/>
|
||||
<text text-anchor="middle" x="458" y="-1578.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="M412.483,-1592.73C374.726,-1601.64 321.013,-1614.3 281.456,-1623.63"/>
|
||||
<polygon fill="none" stroke="black" points="280.651,-1620.22 271.722,-1625.93 282.258,-1627.04 280.651,-1620.22"/>
|
||||
</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="486,-1060 430,-1060 430,-1024 486,-1024 486,-1060"/>
|
||||
<text text-anchor="middle" x="458" y="-1038.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="M429.46,-1048.73C392.487,-1057.45 327.333,-1072.81 281.357,-1083.65"/>
|
||||
<polygon fill="none" stroke="black" points="280.494,-1080.26 271.565,-1085.96 282.101,-1087.07 280.494,-1080.26"/>
|
||||
</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="500,-1330 416,-1330 416,-1294 500,-1294 500,-1330"/>
|
||||
<text text-anchor="middle" x="458" y="-1308.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="M415.998,-1321.9C378.065,-1330.85 322.098,-1344.05 281.28,-1353.67"/>
|
||||
<polygon fill="none" stroke="black" points="280.441,-1350.27 271.511,-1355.98 282.048,-1357.09 280.441,-1350.27"/>
|
||||
</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="506,-1276 410,-1276 410,-1240 506,-1240 506,-1276"/>
|
||||
<text text-anchor="middle" x="458" y="-1254.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="M409.273,-1275.38C401.428,-1278.44 393.444,-1281.7 386,-1285 345.811,-1302.83 301.402,-1326.09 270.101,-1343.11"/>
|
||||
<polygon fill="none" stroke="black" points="268.329,-1340.09 261.231,-1347.95 271.685,-1346.23 268.329,-1340.09"/>
|
||||
</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="516,-952 400,-952 400,-916 516,-916 516,-952"/>
|
||||
<text text-anchor="middle" x="458" y="-930.6" font-family="Courier,monospace" font-size="11.00">Firebird_Result</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\PDOStatement -->
|
||||
<g id="node50" class="node"><title>\\PDOStatement</title>
|
||||
<ellipse fill="none" stroke="black" cx="229" cy="-342" rx="85.1942" ry="18"/>
|
||||
<text text-anchor="middle" x="229" y="-337.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="M399.173,-918.577C394.183,-915.412 389.657,-911.597 386,-907 234.456,-716.474 475.379,-546.271 314,-364 312.011,-361.753 309.825,-359.722 307.484,-357.886"/>
|
||||
<polygon fill="none" stroke="black" points="309.283,-354.881 298.99,-352.369 305.47,-360.751 309.283,-354.881"/>
|
||||
</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="493,-1006 423,-1006 423,-970 493,-970 493,-1006"/>
|
||||
<text text-anchor="middle" x="458" y="-984.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="M422.897,-998.566C410.815,-1002.87 397.452,-1008.4 386,-1015 350.151,-1035.65 350.888,-1055.27 314,-1074 304.01,-1079.07 292.75,-1083.05 281.773,-1086.13"/>
|
||||
<polygon fill="none" stroke="black" points="280.611,-1082.82 271.815,-1088.73 282.375,-1089.59 280.611,-1082.82"/>
|
||||
</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="510,-1546 406,-1546 406,-1510 510,-1510 510,-1546"/>
|
||||
<text text-anchor="middle" x="458" y="-1524.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="M407.342,-1546.14C400.123,-1548.97 392.834,-1551.97 386,-1555 345.811,-1572.83 301.402,-1596.09 270.101,-1613.11"/>
|
||||
<polygon fill="none" stroke="black" points="268.329,-1610.09 261.231,-1617.95 271.685,-1616.23 268.329,-1610.09"/>
|
||||
<polyline fill="none" stroke="none" points="230,-8 366,-8 "/>
|
||||
<path fill="none" stroke="none" d="M366,-8C372,-8 378,-14 378,-20"/>
|
||||
<polyline fill="none" stroke="none" points="378,-20 378,-534 "/>
|
||||
<path fill="none" stroke="none" d="M378,-534C378,-540 372,-546 366,-546"/>
|
||||
<polyline fill="none" stroke="none" points="366,-546 230,-546 "/>
|
||||
<path fill="none" stroke="none" d="M230,-546C224,-546 218,-540 218,-534"/>
|
||||
<polyline fill="none" stroke="none" points="218,-534 218,-20 "/>
|
||||
<path fill="none" stroke="none" d="M218,-20C218,-14 224,-8 230,-8"/>
|
||||
</g>
|
||||
<!-- \\Connection_Sidebar -->
|
||||
<g id="node24" class="node"><title>\\Connection_Sidebar</title>
|
||||
<g id="node2" class="node"><title>\\Connection_Sidebar</title>
|
||||
<a xlink:href="sys.widgets.connection_sidebar.html" xlink:title="Connection_Sidebar" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="527,-898 389,-898 389,-862 527,-862 527,-898"/>
|
||||
<text text-anchor="middle" x="458" y="-876.6" font-family="Courier,monospace" font-size="11.00">Connection_Sidebar</text>
|
||||
<polygon fill="none" stroke="black" points="367,-538 229,-538 229,-502 367,-502 367,-538"/>
|
||||
<text text-anchor="middle" x="298" y="-516.6" font-family="Courier,monospace" font-size="11.00">Connection_Sidebar</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\GtkVBox -->
|
||||
<g id="node54" class="node"><title>\\GtkVBox</title>
|
||||
<ellipse fill="none" stroke="black" cx="229" cy="-288" rx="55.0073" ry="18"/>
|
||||
<text text-anchor="middle" x="229" y="-283.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkVBox</text>
|
||||
<g id="node13" class="node"><title>\\GtkVBox</title>
|
||||
<ellipse fill="none" stroke="black" cx="77" cy="-520" rx="55.0073" ry="18"/>
|
||||
<text text-anchor="middle" x="77" y="-515.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkVBox</text>
|
||||
</g>
|
||||
<!-- \\Connection_Sidebar->\\GtkVBox -->
|
||||
<g id="edge37" class="edge"><title>\\Connection_Sidebar->\\GtkVBox</title>
|
||||
<path fill="none" stroke="black" d="M395.206,-861.836C391.782,-859.27 388.661,-856.342 386,-853 235.713,-664.289 469.068,-499.802 314,-315 307.721,-307.517 299.375,-302.083 290.362,-298.142"/>
|
||||
<polygon fill="none" stroke="black" points="291.379,-294.785 280.787,-294.552 288.921,-301.34 291.379,-294.785"/>
|
||||
<g id="edge3" class="edge"><title>\\Connection_Sidebar->\\GtkVBox</title>
|
||||
<path fill="none" stroke="black" d="M228.983,-520C201.357,-520 169.684,-520 142.427,-520"/>
|
||||
<polygon fill="none" stroke="black" points="142.214,-516.5 132.214,-520 142.214,-523.5 142.214,-516.5"/>
|
||||
</g>
|
||||
<!-- \\Data_Grid -->
|
||||
<g id="node25" class="node"><title>\\Data_Grid</title>
|
||||
<g id="node3" class="node"><title>\\Data_Grid</title>
|
||||
<a xlink:href="sys.widgets.data_grid.html" xlink:title="Data_Grid" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="496,-844 420,-844 420,-808 496,-808 496,-844"/>
|
||||
<text text-anchor="middle" x="458" y="-822.6" font-family="Courier,monospace" font-size="11.00">Data_Grid</text>
|
||||
<polygon fill="none" stroke="black" points="336,-484 260,-484 260,-448 336,-448 336,-484"/>
|
||||
<text text-anchor="middle" x="298" y="-462.6" font-family="Courier,monospace" font-size="11.00">Data_Grid</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\GtkTreeView -->
|
||||
<g id="node56" class="node"><title>\\GtkTreeView</title>
|
||||
<ellipse fill="none" stroke="black" cx="229" cy="-234" rx="73.1194" ry="18"/>
|
||||
<text text-anchor="middle" x="229" y="-229.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkTreeView</text>
|
||||
<g id="node15" class="node"><title>\\GtkTreeView</title>
|
||||
<ellipse fill="none" stroke="black" cx="77" cy="-466" rx="73.1194" ry="18"/>
|
||||
<text text-anchor="middle" x="77" y="-461.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkTreeView</text>
|
||||
</g>
|
||||
<!-- \\Data_Grid->\\GtkTreeView -->
|
||||
<g id="edge39" class="edge"><title>\\Data_Grid->\\GtkTreeView</title>
|
||||
<path fill="none" stroke="black" d="M419.265,-819.656C406.867,-815.719 394.233,-809.339 386,-799 235.713,-610.289 469.068,-445.802 314,-261 309.82,-256.018 304.723,-251.945 299.124,-248.615"/>
|
||||
<polygon fill="none" stroke="black" points="300.471,-245.374 289.97,-243.971 297.305,-251.617 300.471,-245.374"/>
|
||||
<g id="edge5" class="edge"><title>\\Data_Grid->\\GtkTreeView</title>
|
||||
<path fill="none" stroke="black" d="M259.252,-466C231.99,-466 194.464,-466 160.546,-466"/>
|
||||
<polygon fill="none" stroke="black" points="160.15,-462.5 150.15,-466 160.15,-469.5 160.15,-462.5"/>
|
||||
</g>
|
||||
<!-- \\DB_Structure_Widget -->
|
||||
<g id="node26" class="node"><title>\\DB_Structure_Widget</title>
|
||||
<g id="node4" class="node"><title>\\DB_Structure_Widget</title>
|
||||
<a xlink:href="sys.widgets.db_structure_widget.html" xlink:title="DB_Structure_Widget" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="530,-790 386,-790 386,-754 530,-754 530,-790"/>
|
||||
<text text-anchor="middle" x="458" y="-768.6" font-family="Courier,monospace" font-size="11.00">DB_Structure_Widget</text>
|
||||
<polygon fill="none" stroke="black" points="370,-430 226,-430 226,-394 370,-394 370,-430"/>
|
||||
<text text-anchor="middle" x="298" y="-408.6" font-family="Courier,monospace" font-size="11.00">DB_Structure_Widget</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\GTKTable -->
|
||||
<g id="node58" class="node"><title>\\GTKTable</title>
|
||||
<ellipse fill="none" stroke="black" cx="229" cy="-180" rx="57.0197" ry="18"/>
|
||||
<text text-anchor="middle" x="229" y="-175.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GTKTable</text>
|
||||
<g id="node17" class="node"><title>\\GTKTable</title>
|
||||
<ellipse fill="none" stroke="black" cx="77" cy="-412" rx="57.0197" ry="18"/>
|
||||
<text text-anchor="middle" x="77" y="-407.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GTKTable</text>
|
||||
</g>
|
||||
<!-- \\DB_Structure_Widget->\\GTKTable -->
|
||||
<g id="edge41" class="edge"><title>\\DB_Structure_Widget->\\GTKTable</title>
|
||||
<path fill="none" stroke="black" d="M395.206,-753.836C391.782,-751.27 388.661,-748.342 386,-745 235.713,-556.289 469.068,-391.802 314,-207 308.007,-199.857 300.13,-194.581 291.587,-190.688"/>
|
||||
<polygon fill="none" stroke="black" points="292.701,-187.366 282.113,-186.984 290.152,-193.886 292.701,-187.366"/>
|
||||
<g id="edge7" class="edge"><title>\\DB_Structure_Widget->\\GTKTable</title>
|
||||
<path fill="none" stroke="black" d="M225.942,-412C199.699,-412 170.151,-412 144.333,-412"/>
|
||||
<polygon fill="none" stroke="black" points="144.266,-408.5 134.266,-412 144.266,-415.5 144.266,-408.5"/>
|
||||
</g>
|
||||
<!-- \\DB_tabs -->
|
||||
<g id="node27" class="node"><title>\\DB_tabs</title>
|
||||
<g id="node5" class="node"><title>\\DB_tabs</title>
|
||||
<a xlink:href="sys.widgets.db_tabs.html" xlink:title="DB_tabs" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="490,-736 426,-736 426,-700 490,-700 490,-736"/>
|
||||
<text text-anchor="middle" x="458" y="-714.6" font-family="Courier,monospace" font-size="11.00">DB_tabs</text>
|
||||
<polygon fill="none" stroke="black" points="330,-376 266,-376 266,-340 330,-340 330,-376"/>
|
||||
<text text-anchor="middle" x="298" y="-354.6" font-family="Courier,monospace" font-size="11.00">DB_tabs</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\GtkNotebook -->
|
||||
<g id="node60" class="node"><title>\\GtkNotebook</title>
|
||||
<ellipse fill="none" stroke="black" cx="229" cy="-126" rx="75.9737" ry="18"/>
|
||||
<text text-anchor="middle" x="229" y="-121.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkNotebook</text>
|
||||
<g id="node19" class="node"><title>\\GtkNotebook</title>
|
||||
<ellipse fill="none" stroke="black" cx="77" cy="-358" rx="75.9737" ry="18"/>
|
||||
<text text-anchor="middle" x="77" y="-353.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkNotebook</text>
|
||||
</g>
|
||||
<!-- \\DB_tabs->\\GtkNotebook -->
|
||||
<g id="edge43" class="edge"><title>\\DB_tabs->\\GtkNotebook</title>
|
||||
<path fill="none" stroke="black" d="M425.977,-713.57C411.606,-709.908 395.73,-703.218 386,-691 235.713,-502.289 469.068,-337.802 314,-153 310.111,-148.365 305.428,-144.516 300.285,-141.321"/>
|
||||
<polygon fill="none" stroke="black" points="301.729,-138.125 291.254,-136.538 298.453,-144.311 301.729,-138.125"/>
|
||||
<g id="edge9" class="edge"><title>\\DB_tabs->\\GtkNotebook</title>
|
||||
<path fill="none" stroke="black" d="M265.865,-358C239.055,-358 199.566,-358 163.618,-358"/>
|
||||
<polygon fill="none" stroke="black" points="163.587,-354.5 153.586,-358 163.586,-361.5 163.587,-354.5"/>
|
||||
</g>
|
||||
<!-- \\DB_Info_Widget -->
|
||||
<g id="node28" class="node"><title>\\DB_Info_Widget</title>
|
||||
<g id="node6" class="node"><title>\\DB_Info_Widget</title>
|
||||
<a xlink:href="sys.widgets.db_info_widget.html" xlink:title="DB_Info_Widget" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="513,-682 403,-682 403,-646 513,-646 513,-682"/>
|
||||
<text text-anchor="middle" x="458" y="-660.6" font-family="Courier,monospace" font-size="11.00">DB_Info_Widget</text>
|
||||
<polygon fill="none" stroke="black" points="353,-322 243,-322 243,-286 353,-286 353,-322"/>
|
||||
<text text-anchor="middle" x="298" y="-300.6" font-family="Courier,monospace" font-size="11.00">DB_Info_Widget</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\GtkTable -->
|
||||
<g id="node62" class="node"><title>\\GtkTable</title>
|
||||
<ellipse fill="none" stroke="black" cx="229" cy="-72" rx="55.1765" ry="18"/>
|
||||
<text text-anchor="middle" x="229" y="-67.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkTable</text>
|
||||
<g id="node21" class="node"><title>\\GtkTable</title>
|
||||
<ellipse fill="none" stroke="black" cx="77" cy="-304" rx="55.1765" ry="18"/>
|
||||
<text text-anchor="middle" x="77" y="-299.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkTable</text>
|
||||
</g>
|
||||
<!-- \\DB_Info_Widget->\\GtkTable -->
|
||||
<g id="edge45" class="edge"><title>\\DB_Info_Widget->\\GtkTable</title>
|
||||
<path fill="none" stroke="black" d="M402.295,-650.433C396.077,-646.935 390.408,-642.535 386,-637 235.713,-448.289 469.068,-283.802 314,-99 307.721,-91.5173 299.375,-86.0829 290.362,-82.1417"/>
|
||||
<polygon fill="none" stroke="black" points="291.379,-78.7851 280.787,-78.5517 288.921,-85.3396 291.379,-78.7851"/>
|
||||
<g id="edge11" class="edge"><title>\\DB_Info_Widget->\\GtkTable</title>
|
||||
<path fill="none" stroke="black" d="M242.232,-304C212.002,-304 174.46,-304 142.804,-304"/>
|
||||
<polygon fill="none" stroke="black" points="142.75,-300.5 132.75,-304 142.75,-307.5 142.75,-300.5"/>
|
||||
</g>
|
||||
<!-- \\Add_DB -->
|
||||
<g id="node29" class="node"><title>\\Add_DB</title>
|
||||
<g id="node7" class="node"><title>\\Add_DB</title>
|
||||
<a xlink:href="sys.windows.add_db.html" xlink:title="Add_DB" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="487,-628 429,-628 429,-592 487,-592 487,-628"/>
|
||||
<text text-anchor="middle" x="458" y="-606.6" font-family="Courier,monospace" font-size="11.00">Add_DB</text>
|
||||
<polygon fill="none" stroke="black" points="327,-268 269,-268 269,-232 327,-232 327,-268"/>
|
||||
<text text-anchor="middle" x="298" y="-246.6" font-family="Courier,monospace" font-size="11.00">Add_DB</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\GtkWindow -->
|
||||
<g id="node64" class="node"><title>\\GtkWindow</title>
|
||||
<ellipse fill="none" stroke="black" cx="229" cy="-18" rx="67.9242" ry="18"/>
|
||||
<text text-anchor="middle" x="229" y="-13.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkWindow</text>
|
||||
<g id="node23" class="node"><title>\\GtkWindow</title>
|
||||
<ellipse fill="none" stroke="black" cx="77" cy="-142" rx="67.9242" ry="18"/>
|
||||
<text text-anchor="middle" x="77" y="-137.4" font-family="Times Roman,serif" font-size="14.00" fill="gray">\GtkWindow</text>
|
||||
</g>
|
||||
<!-- \\Add_DB->\\GtkWindow -->
|
||||
<g id="edge47" class="edge"><title>\\Add_DB->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M428.901,-606.28C413.806,-602.797 396.396,-596.054 386,-583 235.713,-394.289 469.068,-229.802 314,-45 309.453,-39.581 303.821,-35.2362 297.638,-31.7549"/>
|
||||
<polygon fill="none" stroke="black" points="298.774,-28.4183 288.244,-27.2476 295.746,-34.7293 298.774,-28.4183"/>
|
||||
<g id="edge13" class="edge"><title>\\Add_DB->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M268.967,-241.709C253.548,-236.931 234.437,-230.409 218,-223 180.145,-205.937 139.245,-181.743 111.295,-164.245"/>
|
||||
<polygon fill="none" stroke="black" points="113.02,-161.195 102.695,-158.816 109.283,-167.114 113.02,-161.195"/>
|
||||
</g>
|
||||
<!-- \\Edit_DB -->
|
||||
<g id="node30" class="node"><title>\\Edit_DB</title>
|
||||
<g id="node8" class="node"><title>\\Edit_DB</title>
|
||||
<a xlink:href="sys.windows.edit_db.html" xlink:title="Edit_DB" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="490,-574 426,-574 426,-538 490,-538 490,-574"/>
|
||||
<text text-anchor="middle" x="458" y="-552.6" font-family="Courier,monospace" font-size="11.00">Edit_DB</text>
|
||||
<polygon fill="none" stroke="black" points="330,-214 266,-214 266,-178 330,-178 330,-214"/>
|
||||
<text text-anchor="middle" x="298" y="-192.6" font-family="Courier,monospace" font-size="11.00">Edit_DB</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Edit_DB->\\GtkWindow -->
|
||||
<g id="edge49" class="edge"><title>\\Edit_DB->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M425.687,-551.412C411.432,-547.716 395.736,-541.043 386,-529 249.276,-359.875 455.008,-210.57 314,-45 309.413,-39.6144 303.757,-35.2911 297.558,-31.8226"/>
|
||||
<polygon fill="none" stroke="black" points="298.681,-28.4805 288.149,-27.3281 295.664,-34.7968 298.681,-28.4805"/>
|
||||
<g id="edge15" class="edge"><title>\\Edit_DB->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M265.865,-188.148C232.173,-179.915 178.455,-166.79 136.907,-156.638"/>
|
||||
<polygon fill="none" stroke="black" points="137.711,-153.231 127.166,-154.258 136.049,-160.031 137.711,-153.231"/>
|
||||
</g>
|
||||
<!-- \\Edit_Table -->
|
||||
<g id="node31" class="node"><title>\\Edit_Table</title>
|
||||
<g id="node9" class="node"><title>\\Edit_Table</title>
|
||||
<a xlink:href="sys.windows.edit_table.html" xlink:title="Edit_Table" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="500,-520 416,-520 416,-484 500,-484 500,-520"/>
|
||||
<text text-anchor="middle" x="458" y="-498.6" font-family="Courier,monospace" font-size="11.00">Edit_Table</text>
|
||||
<polygon fill="none" stroke="black" points="340,-160 256,-160 256,-124 340,-124 340,-160"/>
|
||||
<text text-anchor="middle" x="298" y="-138.6" font-family="Courier,monospace" font-size="11.00">Edit_Table</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Edit_Table->\\GtkWindow -->
|
||||
<g id="edge51" class="edge"><title>\\Edit_Table->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M415.699,-494.23C404.557,-490.229 393.554,-484.171 386,-475 262.812,-325.427 440.977,-191.371 314,-45 309.364,-39.6564 303.676,-35.3602 297.459,-31.9077"/>
|
||||
<polygon fill="none" stroke="black" points="298.566,-28.5588 288.031,-27.4293 295.562,-34.8817 298.566,-28.5588"/>
|
||||
<g id="edge17" class="edge"><title>\\Edit_Table->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M255.911,-142C227.764,-142 189.854,-142 156.176,-142"/>
|
||||
<polygon fill="none" stroke="black" points="155.875,-138.5 145.875,-142 155.875,-145.5 155.875,-138.5"/>
|
||||
</g>
|
||||
<!-- \\DB_Table_Data -->
|
||||
<g id="node32" class="node"><title>\\DB_Table_Data</title>
|
||||
<g id="node10" class="node"><title>\\DB_Table_Data</title>
|
||||
<a xlink:href="sys.windows.db_table_data.html" xlink:title="DB_Table_Data" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="510,-466 406,-466 406,-430 510,-430 510,-466"/>
|
||||
<text text-anchor="middle" x="458" y="-444.6" font-family="Courier,monospace" font-size="11.00">DB_Table_Data</text>
|
||||
<polygon fill="none" stroke="black" points="350,-106 246,-106 246,-70 350,-70 350,-106"/>
|
||||
<text text-anchor="middle" x="298" y="-84.6" font-family="Courier,monospace" font-size="11.00">DB_Table_Data</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\DB_Table_Data->\\GtkWindow -->
|
||||
<g id="edge53" class="edge"><title>\\DB_Table_Data->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M405.817,-435.885C398.311,-432.174 391.336,-427.327 386,-421 276.308,-290.931 426.985,-172.218 314,-45 309.303,-39.7108 303.574,-35.4495 297.333,-32.0177"/>
|
||||
<polygon fill="none" stroke="black" points="298.42,-28.6605 287.882,-27.5602 295.434,-34.9916 298.42,-28.6605"/>
|
||||
<g id="edge19" class="edge"><title>\\DB_Table_Data->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M245.906,-100.729C213.269,-108.704 171.092,-119.009 137.05,-127.327"/>
|
||||
<polygon fill="none" stroke="black" points="136.107,-123.955 127.223,-129.728 137.768,-130.755 136.107,-123.955"/>
|
||||
</g>
|
||||
<!-- \\Main -->
|
||||
<g id="node33" class="node"><title>\\Main</title>
|
||||
<g id="node11" class="node"><title>\\Main</title>
|
||||
<a xlink:href="sys.windows.main.html" xlink:title="Main" target="_parent">
|
||||
<polygon fill="none" stroke="black" points="485,-412 431,-412 431,-376 485,-376 485,-412"/>
|
||||
<text text-anchor="middle" x="458" y="-390.6" font-family="Courier,monospace" font-size="11.00">Main</text>
|
||||
<polygon fill="none" stroke="black" points="325,-52 271,-52 271,-16 325,-16 325,-52"/>
|
||||
<text text-anchor="middle" x="298" y="-30.6" font-family="Courier,monospace" font-size="11.00">Main</text>
|
||||
</a>
|
||||
</g>
|
||||
<!-- \\Main->\\GtkWindow -->
|
||||
<g id="edge55" class="edge"><title>\\Main->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M455.875,-375.767C448.211,-318.351 416.767,-139.5 314,-45 308.437,-39.8842 301.905,-35.7377 294.976,-32.3768"/>
|
||||
<polygon fill="none" stroke="black" points="295.906,-28.9684 285.334,-28.2634 293.159,-35.4069 295.906,-28.9684"/>
|
||||
<g id="edge21" class="edge"><title>\\Main->\\GtkWindow</title>
|
||||
<path fill="none" stroke="black" d="M270.829,-41.7174C255.106,-46.5399 235.106,-53.2899 218,-61 180.145,-78.0625 139.245,-102.257 111.295,-119.755"/>
|
||||
<polygon fill="none" stroke="black" points="109.283,-116.886 102.695,-125.184 113.02,-122.805 109.283,-116.886"/>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 9.9 KiB |
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -92,7 +89,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -294,7 +291,7 @@
|
||||
</div>
|
||||
<a name="%24settings" id="$settings"> </a><div class="element clickable property protected $settings" data-toggle="collapse" data-target=".$settings .collapse">
|
||||
<h2>Reference to Settings instance</h2>
|
||||
<pre>$settings : <a href="../classes/Settings.html">\Settings</a></pre>
|
||||
<pre>$settings : \Settings</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
@ -323,7 +320,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -1,317 +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>OpenSQLManager » \DB_Info_Widget</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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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 :: No params = add, params = edit"><span class="description">No params = add, params = edit</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public "><a href="#change_db" title="change_db :: Set defaults for new database type"><span class="description">Set defaults for new database type</span><pre>change_db()</pre></a></li>
|
||||
<li class="method public "><a href="#db_add" title="db_add :: Adds the database to the settings file"><span class="description">Adds the database to the settings file</span><pre>db_add()</pre></a></li>
|
||||
<li class="method public "><a href="#db_edit" title="db_edit :: Edit an existing database connection"><span class="description">Edit an existing database connection</span><pre>db_edit()</pre></a></li>
|
||||
<li class="method public "><a href="#get_available_dbs" title="get_available_dbs :: Checks what database drivers are available"><span class="description">Checks what database drivers are available</span><pre>get_available_dbs()</pre></a></li>
|
||||
<li class="method public "><a href="#set_db" title="set_db :: Like change_db function, but save current values"><span class="description">Like change_db function, but save current values</span><pre>set_db()</pre></a></li>
|
||||
<li class="method public "><a href="#test_conn" title="test_conn :: Test a db connection, and display a popup with the result of the test"><span class="description">Test a db connection, and display a popup with the result of the test</span><pre>test_conn()</pre></a></li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="method private "><a href="#_add_row" title="_add_row :: Simple helper function for adding a row to the GtkTable"><span class="description">Simple helper function for adding a row to the GtkTable</span><pre>_add_row()</pre></a></li>
|
||||
<li class="method private "><a href="#_layout" title="_layout :: Table layout"><span class="description">Table layout</span><pre>_layout()</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="#%24conn" title="$conn :: Connection name"><span class="description">Connection name</span><pre>$conn</pre></a></li>
|
||||
<li class="property protected "><a href="#%24conn_db" title="$conn_db :: Connection database name"><span class="description">Connection database name</span><pre>$conn_db</pre></a></li>
|
||||
<li class="property protected "><a href="#%24db_file" title="$db_file :: Connection database file"><span class="description">Connection database file</span><pre>$db_file</pre></a></li>
|
||||
<li class="property protected "><a href="#%24dbtype" title="$dbtype :: Connection database type"><span class="description">Connection database type</span><pre>$dbtype</pre></a></li>
|
||||
<li class="property protected "><a href="#%24host" title="$host :: Connection database host"><span class="description">Connection database host</span><pre>$host</pre></a></li>
|
||||
<li class="property protected "><a href="#%24lblconn" title="$lblconn :: Label for connection name"><span class="description">Label for connection name</span><pre>$lblconn</pre></a></li>
|
||||
<li class="property protected "><a href="#%24lblconn_db" title="$lblconn_db :: Label for connection database name"><span class="description">Label for connection database name</span><pre>$lblconn_db</pre></a></li>
|
||||
<li class="property protected "><a href="#%24lbldb_file" title="$lbldb_file :: Label for database file"><span class="description">Label for database file</span><pre>$lbldb_file</pre></a></li>
|
||||
<li class="property protected "><a href="#%24lbldbtype" title="$lbldbtype :: Label for database type"><span class="description">Label for database type</span><pre>$lbldbtype</pre></a></li>
|
||||
<li class="property protected "><a href="#%24lblhost" title="$lblhost :: Label for database host"><span class="description">Label for database host</span><pre>$lblhost</pre></a></li>
|
||||
<li class="property protected "><a href="#%24lblpass" title="$lblpass :: Label for database connection password"><span class="description">Label for database connection password</span><pre>$lblpass</pre></a></li>
|
||||
<li class="property protected "><a href="#%24lblport" title="$lblport :: Label for database connection port"><span class="description">Label for database connection port</span><pre>$lblport</pre></a></li>
|
||||
<li class="property protected "><a href="#%24lbluser" title="$lbluser :: Label for database connection user"><span class="description">Label for database connection user</span><pre>$lbluser</pre></a></li>
|
||||
<li class="property protected "><a href="#%24old_conn" title="$old_conn :: Reference to last connection name"><span class="description">Reference to last connection name</span><pre>$old_conn</pre></a></li>
|
||||
<li class="property protected "><a href="#%24pass" title="$pass :: Connection password"><span class="description">Connection password</span><pre>$pass</pre></a></li>
|
||||
<li class="property protected "><a href="#%24port" title="$port :: Connection port"><span class="description">Connection port</span><pre>$port</pre></a></li>
|
||||
<li class="property protected "><a href="#%24user" title="$user :: Connection user name"><span class="description">Connection user name</span><pre>$user</pre></a></li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="property private "><a href="#%24settings" title="$settings :: Alias to Settings::get_instance"><span class="description">Alias to Settings::get_instance</span><pre>$settings</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CDB_Info_Widget" id="\DB_Info_Widget"></a><div href="../classes/DB_Info_Widget.html" class="element class">
|
||||
<p class="short_description">Widget for adding / editing database connections</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/OpenSQLManager.Widgets.html">OpenSQLManager</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Widgets</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>No params = add, params = edit</h2>
|
||||
<pre>__construct(object $db) : 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>$db</h4>
|
||||
<code>object</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="change_db" id="change_db"></a><div class="element clickable method public change_db" data-toggle="collapse" data-target=".change_db .collapse">
|
||||
<h2>Set defaults for new database type</h2>
|
||||
<pre>change_db() : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="db_add" id="db_add"></a><div class="element clickable method public db_add" data-toggle="collapse" data-target=".db_add .collapse">
|
||||
<h2>Adds the database to the settings file</h2>
|
||||
<pre>db_add() : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="db_edit" id="db_edit"></a><div class="element clickable method public db_edit" data-toggle="collapse" data-target=".db_edit .collapse">
|
||||
<h2>Edit an existing database connection</h2>
|
||||
<pre>db_edit() : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="get_available_dbs" id="get_available_dbs"></a><div class="element clickable method public get_available_dbs" data-toggle="collapse" data-target=".get_available_dbs .collapse">
|
||||
<h2>Checks what database drivers are available</h2>
|
||||
<pre>get_available_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="set_db" id="set_db"></a><div class="element clickable method public set_db" data-toggle="collapse" data-target=".set_db .collapse">
|
||||
<h2>Like change_db function, but save current values</h2>
|
||||
<pre>set_db() : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="test_conn" id="test_conn"></a><div class="element clickable method public test_conn" data-toggle="collapse" data-target=".test_conn .collapse">
|
||||
<h2>Test a db connection, and display a popup with the result of the test</h2>
|
||||
<pre>test_conn() : void</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="_add_row" id="_add_row"></a><div class="element clickable method private _add_row" data-toggle="collapse" data-target="._add_row .collapse">
|
||||
<h2>Simple helper function for adding a row to the GtkTable</h2>
|
||||
<pre>_add_row(string $label, string $vname, int $y1, int $y2) : 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>$label</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$vname</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$y1</h4>
|
||||
<code>int</code><p>&$y1</p>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$y2</h4>
|
||||
<code>int</code><p>&$y2</p>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_layout" id="_layout"></a><div class="element clickable method private _layout" data-toggle="collapse" data-target="._layout .collapse">
|
||||
<h2>Table layout</h2>
|
||||
<pre>_layout() : void</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="%24conn" id="$conn"> </a><div class="element clickable property protected $conn" data-toggle="collapse" data-target=".$conn .collapse">
|
||||
<h2>Connection name</h2>
|
||||
<pre>$conn : \GtkEntry</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24conn_db" id="$conn_db"> </a><div class="element clickable property protected $conn_db" data-toggle="collapse" data-target=".$conn_db .collapse">
|
||||
<h2>Connection database name</h2>
|
||||
<pre>$conn_db : \GtkEntry</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24db_file" id="$db_file"> </a><div class="element clickable property protected $db_file" data-toggle="collapse" data-target=".$db_file .collapse">
|
||||
<h2>Connection database file</h2>
|
||||
<pre>$db_file : \GtkFileChooserButton</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24dbtype" id="$dbtype"> </a><div class="element clickable property protected $dbtype" data-toggle="collapse" data-target=".$dbtype .collapse">
|
||||
<h2>Connection database type</h2>
|
||||
<pre>$dbtype : \GtkComboBox</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24host" id="$host"> </a><div class="element clickable property protected $host" data-toggle="collapse" data-target=".$host .collapse">
|
||||
<h2>Connection database host</h2>
|
||||
<pre>$host : \GtkEntry</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24lblconn" id="$lblconn"> </a><div class="element clickable property protected $lblconn" data-toggle="collapse" data-target=".$lblconn .collapse">
|
||||
<h2>Label for connection name</h2>
|
||||
<pre>$lblconn : \GtkLabel</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24lblconn_db" id="$lblconn_db"> </a><div class="element clickable property protected $lblconn_db" data-toggle="collapse" data-target=".$lblconn_db .collapse">
|
||||
<h2>Label for connection database name</h2>
|
||||
<pre>$lblconn_db : \Gtklabel</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24lbldb_file" id="$lbldb_file"> </a><div class="element clickable property protected $lbldb_file" data-toggle="collapse" data-target=".$lbldb_file .collapse">
|
||||
<h2>Label for database file</h2>
|
||||
<pre>$lbldb_file : \GtkLabel</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24lbldbtype" id="$lbldbtype"> </a><div class="element clickable property protected $lbldbtype" data-toggle="collapse" data-target=".$lbldbtype .collapse">
|
||||
<h2>Label for database type</h2>
|
||||
<pre>$lbldbtype : \Gtklabel</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24lblhost" id="$lblhost"> </a><div class="element clickable property protected $lblhost" data-toggle="collapse" data-target=".$lblhost .collapse">
|
||||
<h2>Label for database host</h2>
|
||||
<pre>$lblhost : \Gtklabel</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24lblpass" id="$lblpass"> </a><div class="element clickable property protected $lblpass" data-toggle="collapse" data-target=".$lblpass .collapse">
|
||||
<h2>Label for database connection password</h2>
|
||||
<pre>$lblpass : \GtkLabel</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24lblport" id="$lblport"> </a><div class="element clickable property protected $lblport" data-toggle="collapse" data-target=".$lblport .collapse">
|
||||
<h2>Label for database connection port</h2>
|
||||
<pre>$lblport : \GtkLabel</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24lbluser" id="$lbluser"> </a><div class="element clickable property protected $lbluser" data-toggle="collapse" data-target=".$lbluser .collapse">
|
||||
<h2>Label for database connection user</h2>
|
||||
<pre>$lbluser : \GtkLabel</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24old_conn" id="$old_conn"> </a><div class="element clickable property protected $old_conn" data-toggle="collapse" data-target=".$old_conn .collapse">
|
||||
<h2>Reference to last connection name</h2>
|
||||
<pre>$old_conn : string</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24pass" id="$pass"> </a><div class="element clickable property protected $pass" data-toggle="collapse" data-target=".$pass .collapse">
|
||||
<h2>Connection password</h2>
|
||||
<pre>$pass : \GtkEntry</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24port" id="$port"> </a><div class="element clickable property protected $port" data-toggle="collapse" data-target=".$port .collapse">
|
||||
<h2>Connection port</h2>
|
||||
<pre>$port : \GtkEntry</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24user" id="$user"> </a><div class="element clickable property protected $user" data-toggle="collapse" data-target=".$user .collapse">
|
||||
<h2>Connection user name</h2>
|
||||
<pre>$user : \GtkEntry</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="%24settings" id="$settings"> </a><div class="element clickable property private $settings" data-toggle="collapse" data-target=".$settings .collapse">
|
||||
<h2>Alias to Settings::get_instance</h2>
|
||||
<pre>$settings : <a href="../classes/Settings.html">\Settings</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-14T13:25:16-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,98 +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>OpenSQLManager » \DB_Structure_Widget</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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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 :: Initialize the class"><span class="description">Initialize the class</span><pre>__construct()</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CDB_Structure_Widget" id="\DB_Structure_Widget"></a><div href="../classes/DB_Structure_Widget.html" class="element class">
|
||||
<p class="short_description">Class for generating db-structure editing views</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/OpenSQLManager.Widgets.html">OpenSQLManager</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Widgets</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>Initialize the class</h2>
|
||||
<pre>__construct() </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-14T13:25:16-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,117 +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>OpenSQLManager » \DB_Table_Data</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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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 and populate the window"><span class="description">Create and populate the window</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="#%24win" title="$win :: Reference to the scrolled window"><span class="description">Reference to the scrolled window</span><pre>$win</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CDB_Table_Data" id="\DB_Table_Data"></a><div href="../classes/DB_Table_Data.html" class="element class">
|
||||
<p class="short_description">Popup window to display database table data</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/OpenSQLManager.Windows.html">OpenSQLManager</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Windows</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 and populate the window</h2>
|
||||
<pre>__construct(array $data) : 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>$data</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24win" id="$win"> </a><div class="element clickable property protected $win" data-toggle="collapse" data-target=".$win .collapse">
|
||||
<h2>Reference to the scrolled window</h2>
|
||||
<pre>$win : \GtkScrolledWindow</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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,295 +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>OpenSQLManager » \DB_tabs</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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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"><span class="description">Create the object</span><pre>__construct()</pre></a></li>
|
||||
<li class="method public "><a href="#add_tab" title="add_tab :: Add a new tab with the provided label"><span class="description">Add a new tab with the provided label</span><pre>add_tab()</pre></a></li>
|
||||
<li class="method public "><a href="#get_db_tabs" title="get_db_tabs :: Create tabs for database aspects"><span class="description">Create tabs for database aspects</span><pre>get_db_tabs()</pre></a></li>
|
||||
<li class="method public "><a href="#get_instance" title="get_instance :: Return the db tabs object if it exists, or create and return"><span class="description">Return the db tabs object if it exists, or create and return</span><pre>get_instance()</pre></a></li>
|
||||
<li class="method public "><a href="#reset" title="reset :: Remove current tabs"><span class="description">Remove current tabs</span><pre>reset()</pre></a></li>
|
||||
<li class="method public "><a href="#show_table_data" title="show_table_data :: Create popup window with table data"><span class="description">Create popup window with table data</span><pre>show_table_data()</pre></a></li>
|
||||
<li class="nav-header private">» Private</li>
|
||||
<li class="method private "><a href="#_add_row_tab" title="_add_row_tab :: Add a multidimensional array to a tab"><span class="description">Add a multidimensional array to a tab</span><pre>_add_row_tab()</pre></a></li>
|
||||
<li class="method private "><a href="#_add_tab" title="_add_tab :: Simplify adding tabs to the Notebook object"><span class="description">Simplify adding tabs to the Notebook object</span><pre>_add_tab()</pre></a></li>
|
||||
<li class="method private "><a href="#_get_db_info" title="_get_db_info :: Returns cached database data for the tab and connection specified"><span class="description">Returns cached database data for the tab and connection specified</span><pre>_get_db_info()</pre></a></li>
|
||||
<li class="method private "><a href="#_set_db_info" title="_set_db_info :: Sets cached database data for the tab and connection specified"><span class="description">Sets cached database data for the tab and connection specified</span><pre>_set_db_info()</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="#%24data" title="$data :: Db Data cache"><span class="description">Db Data cache</span><pre>$data</pre></a></li>
|
||||
<li class="property private "><a href="#%24instance" title="$instance :: Current Tab Widget object"><span class="description">Current Tab Widget object</span><pre>$instance</pre></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a name="%5CDB_tabs" id="\DB_tabs"></a><div href="../classes/DB_tabs.html" class="element class">
|
||||
<p class="short_description">Tabbed Container for database properties</p>
|
||||
<div class="details">
|
||||
<p class="long_description"></p>
|
||||
<table class="table table-bordered">
|
||||
<tr>
|
||||
<th>package</th>
|
||||
<td><a href="..//packages/OpenSQLManager.Widgets.html">OpenSQLManager</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>subpackage</th>
|
||||
<td>Widgets</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</h2>
|
||||
<pre>__construct() </pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
<a name="add_tab" id="add_tab"></a><div class="element clickable method public add_tab" data-toggle="collapse" data-target=".add_tab .collapse">
|
||||
<h2>Add a new tab with the provided label</h2>
|
||||
<pre>add_tab(string $label, \GObject $widget) : 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>$label</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$widget</h4>
|
||||
<code>\GObject</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="get_db_tabs" id="get_db_tabs"></a><div class="element clickable method public get_db_tabs" data-toggle="collapse" data-target=".get_db_tabs .collapse">
|
||||
<h2>Create tabs for database aspects</h2>
|
||||
<pre>get_db_tabs(<a href="../classes/Query_Builder.html">\Query_Builder</a> $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><a href="../classes/Query_Builder.html">\Query_Builder</a></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>Return the db tabs object if it exists, or create and return</h2>
|
||||
<pre>get_instance() : <a href="../classes/DB_tabs.html">\DB_tabs</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/DB_tabs.html">\DB_tabs</a></code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="reset" id="reset"></a><div class="element clickable method public reset" data-toggle="collapse" data-target=".reset .collapse">
|
||||
<h2>Remove current tabs</h2>
|
||||
<pre>reset(string $conn_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>$conn_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="show_table_data" id="show_table_data"></a><div class="element clickable method public show_table_data" data-toggle="collapse" data-target=".show_table_data .collapse">
|
||||
<h2>Create popup window with table data</h2>
|
||||
<pre>show_table_data(\GTKTreeView $view, array $path, \GtkTreeviewColumn $col, <a href="../classes/Query_Builder.html">\Query_Builder</a> $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>$view</h4>
|
||||
<code>\GTKTreeView</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$path</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$col</h4>
|
||||
<code>\GtkTreeviewColumn</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$conn</h4>
|
||||
<code><a href="../classes/Query_Builder.html">\Query_Builder</a></code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_add_row_tab" id="_add_row_tab"></a><div class="element clickable method private _add_row_tab" data-toggle="collapse" data-target="._add_row_tab .collapse">
|
||||
<h2>Add a multidimensional array to a tab</h2>
|
||||
<pre>_add_row_tab(object $conn, string $tab_name, string $method) : 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>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$tab_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$method</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_add_tab" id="_add_tab"></a><div class="element clickable method private _add_tab" data-toggle="collapse" data-target="._add_tab .collapse">
|
||||
<h2>Simplify adding tabs to the Notebook object</h2>
|
||||
<pre>_add_tab(object $conn, string $tab_name, string $col_name, string $method, array $events) : 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>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$tab_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$col_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$method</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$events</h4>
|
||||
<code>array</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_get_db_info" id="_get_db_info"></a><div class="element clickable method private _get_db_info" data-toggle="collapse" data-target="._get_db_info .collapse">
|
||||
<h2>Returns cached database data for the tab and connection specified</h2>
|
||||
<pre>_get_db_info(string $conn_name, string $tab_name) : 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>$conn_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$tab_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<h3>Returns</h3>
|
||||
<div class="subelement response"><code>mixed</code></div>
|
||||
</div></div>
|
||||
</div>
|
||||
<a name="_set_db_info" id="_set_db_info"></a><div class="element clickable method private _set_db_info" data-toggle="collapse" data-target="._set_db_info .collapse">
|
||||
<h2>Sets cached database data for the tab and connection specified</h2>
|
||||
<pre>_set_db_info(string $conn_name, string $tab_name, mixed $data) </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_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$tab_name</h4>
|
||||
<code>string</code>
|
||||
</div>
|
||||
<div class="subelement argument">
|
||||
<h4>$data</h4>
|
||||
<code>mixed</code>
|
||||
</div>
|
||||
</div></div>
|
||||
</div>
|
||||
<h3>
|
||||
<i class="icon-custom icon-property"></i> Properties</h3>
|
||||
<a name="%24data" id="$data"> </a><div class="element clickable property private $data" data-toggle="collapse" data-target=".$data .collapse">
|
||||
<h2>Db Data cache</h2>
|
||||
<pre>$data : array</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>Current Tab Widget object</h2>
|
||||
<pre>$instance : \DB_Tabs</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-14T13:25:16-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -181,7 +178,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -115,7 +112,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -136,7 +133,7 @@ Create menus, hboxes, vboxs and other widgets</h2>
|
||||
</div>
|
||||
<a name="%24settings" id="$settings"> </a><div class="element clickable property private $settings" data-toggle="collapse" data-target=".$settings .collapse">
|
||||
<h2>Reference to settings instance</h2>
|
||||
<pre>$settings : <a href="../classes/Settings.html">\Settings</a></pre>
|
||||
<pre>$settings : \Settings</pre>
|
||||
<div class="labels"></div>
|
||||
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
|
||||
</div>
|
||||
@ -147,7 +144,7 @@ Create menus, hboxes, vboxs and other widgets</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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » \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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -79,35 +76,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -60,7 +57,6 @@
|
||||
<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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul></div></div>
|
||||
<div class="span5">
|
||||
<div class="well"><ul class="nav nav-list">
|
||||
@ -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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:08-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:09-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -123,39 +120,6 @@
|
||||
<div class="subelement response"><code>bool</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>Bulk directory loading workaround for use
|
||||
with array_map and glob</h2>
|
||||
@ -242,27 +206,6 @@ with array_map and glob</h2>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_Info_Widget.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_Structure_Widget" id="DB_Structure_Widget"></a><div class="element ajax clickable class" href="../classes/DB_Structure_Widget.html">
|
||||
<h1>DB_Structure_Widget<a href="../classes/DB_Structure_Widget.html">¶</a>
|
||||
</h1>
|
||||
@ -277,13 +220,6 @@ with array_map and glob</h2>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/DB_Table_Data.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="DB_tabs" id="DB_tabs"></a><div class="element ajax clickable class" href="../classes/DB_tabs.html">
|
||||
<h1>DB_tabs<a href="../classes/DB_tabs.html">¶</a>
|
||||
</h1>
|
||||
@ -312,35 +248,6 @@ with array_map and glob</h2>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Edit_Table.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="Main" id="Main"></a><div class="element ajax clickable class" href="../classes/Main.html">
|
||||
<h1>Main<a href="../classes/Main.html">¶</a>
|
||||
</h1>
|
||||
@ -348,105 +255,6 @@ data-fetching methods</p>
|
||||
<div class="details collapse"></div>
|
||||
<a href="../classes/Main.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>
|
||||
<h3>
|
||||
<i class="icon-custom icon-constant"></i> Constants</h3>
|
||||
<a name="BASE_DIR" id="BASE_DIR"> </a><div class="element clickable constant BASE_DIR" data-toggle="collapse" data-target=".BASE_DIR .collapse">
|
||||
@ -461,18 +269,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="SETTINGS_DIR" id="SETTINGS_DIR"> </a><div class="element clickable constant SETTINGS_DIR" data-toggle="collapse" data-target=".SETTINGS_DIR .collapse">
|
||||
<h2>SETTINGS_DIR</h2>
|
||||
<pre>SETTINGS_DIR </pre>
|
||||
@ -491,7 +287,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:08-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:08-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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,8 +63,6 @@
|
||||
<i class="icon-custom icon-constant"></i> Constants</li>
|
||||
<li class="constant "><a href="#BASE_DIR" title="BASE_DIR :: "><span class="description">BASE_DIR</span><pre>BASE_DIR</pre></a></li>
|
||||
<li class="constant "><a href="#PROGRAM_NAME" title="PROGRAM_NAME :: "><span class="description">PROGRAM_NAME</span><pre>PROGRAM_NAME</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="#SETTINGS_DIR" title="SETTINGS_DIR :: "><span class="description">SETTINGS_DIR</span><pre>SETTINGS_DIR</pre></a></li>
|
||||
<li class="constant "><a href="#VERSION" title="VERSION :: "><span class="description">VERSION</span><pre>VERSION</pre></a></li>
|
||||
</ul>
|
||||
@ -94,18 +89,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="SETTINGS_DIR" id="SETTINGS_DIR"> </a><div class="element clickable constant SETTINGS_DIR" data-toggle="collapse" data-target=".SETTINGS_DIR .collapse">
|
||||
<h2>SETTINGS_DIR</h2>
|
||||
<pre>SETTINGS_DIR </pre>
|
||||
@ -124,7 +107,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:08-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -123,7 +120,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:08-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -123,7 +120,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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:08-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -22,7 +22,6 @@
|
||||
<li><a>Packages</a></li>
|
||||
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
|
||||
<li><a href="../packages/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
@ -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>
|
||||
@ -303,7 +300,7 @@ with array_map and glob</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-14T13:25:16-04:00.<br></footer></div>
|
||||
generated on 2012-05-15T12:45:08-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>OpenSQLManager » 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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » 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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » 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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-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>OpenSQLManager » 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">OpenSQLManager</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/OpenSQLManager.html"><i class="icon-folder-open"></i> OpenSQLManager</a></li>
|
||||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||||
<span class="label label-info">0</span></a></li>
|
||||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||||
<ul><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-14T13:25:16-04:00.<br></footer></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
5423
docs/structure.xml
5423
docs/structure.xml
File diff suppressed because it is too large
Load Diff
@ -13,8 +13,8 @@
|
||||
<files>
|
||||
<directory>.</directory>
|
||||
<directory>tests</directory>
|
||||
<directory>sys/db/tests</directory>
|
||||
<directory>sys/db</directory>
|
||||
<ignore>tests/*</ignore>
|
||||
<ignore>sys/db/tests/*</ignore>
|
||||
<ignore>sys/db/*</ignore>
|
||||
</files>
|
||||
</phpdoc>
|
||||
Reference in New Issue
Block a user