timw4mail
/
OpenSQLManager
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs: 

:
;
This commit is contained in:
Timothy Warren 2012-06-05 14:59:50 -04:00
parent 7f37614b8c
commit f0ffcc577c
22 changed files with 293 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
docs/classes/OpenSQLManager.Connection_Manager.html
View File

@ -58,15 +58,25 @@
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Create the window"><span class="description">Create the window</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#add_conn" title="add_conn :: Adds a connection to the connection manager"><span class="description">Adds a connection to the connection manager</span><pre>add_conn()</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="#test_conn" title="test_conn :: Test a db connection, and display a popup with the result"><span class="description">Test a db connection, and display a popup with the result</span><pre>test_conn()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected "><a href="#_layout" title="_layout :: Layout fields on the form"><span class="description">Layout fields on the form</span><pre>_layout()</pre></a></li>
<li class="method protected "><a href="#get_available_dbs" title="get_available_dbs :: Get the list of available database types"><span class="description">Get the list of available database types</span><pre>get_available_dbs()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#_get_vals" title="_get_vals :: Get the values of the widgets in the window"><span class="description">Get the values of the widgets in the window</span><pre>_get_vals()</pre></a></li>
<li class="method private "><a href="#_hide" title="_hide :: Hides a list of elements"><span class="description">Hides a list of elements</span><pre>_hide()</pre></a></li>
<li class="method private "><a href="#_show" title="_show :: Shows a list of elements"><span class="description">Shows a list of elements</span><pre>_show()</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="#%24fields" title="$fields :: Array of fields for Connection Information manipulation"><span class="description">Array of fields for Connection Information manipulation</span><pre>$fields</pre></a></li>
<li class="property protected "><a href="#%24labels" title="$labels :: Array of labels for Connection Information manipulation"><span class="description">Array of labels for Connection Information manipulation</span><pre>$labels</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant "><a href="#BTN_ADD" title="BTN_ADD :: "><span class="description">BTN_ADD</span><pre>BTN_ADD</pre></a></li>
<li class="constant "><a href="#BTN_TEST" title="BTN_TEST :: "><span class="description">BTN_TEST</span><pre>BTN_TEST</pre></a></li>
<li class="constant "><a href="#COMBO_DB_TYPE" title="COMBO_DB_TYPE :: "><span class="description">COMBO_DB_TYPE</span><pre>COMBO_DB_TYPE</pre></a></li>
<li class="constant "><a href="#FILE_DB_FILE" title="FILE_DB_FILE :: "><span class="description">FILE_DB_FILE</span><pre>FILE_DB_FILE</pre></a></li>
<li class="constant "><a href="#TXT_CONN_NAME" title="TXT_CONN_NAME :: "><span class="description">TXT_CONN_NAME</span><pre>TXT_CONN_NAME</pre></a></li>
@ -118,6 +128,36 @@
<code></code><p>mixed</p></div>
</div></div>
</div>
<a name="add_conn" id="add_conn"></a><div class="element clickable method public add_conn" data-toggle="collapse" data-target=".add_conn .collapse">
<h2>Adds a connection to the connection manager</h2>
<pre>add_conn($event) : 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>$event</h4>
<code></code><p>wxCommandEvent</p></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($event) : 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>$event</h4>
<code></code><p>wxCommandEvent</p></div>
</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</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="_layout" id="_layout"></a><div class="element clickable method protected _layout" data-toggle="collapse" data-target="._layout .collapse">
<h2>Layout fields on the form</h2>
<pre>_layout($params) </pre>
@ -136,6 +176,40 @@
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"><p>return array</p></p></div></div>
</div>
<a name="_get_vals" id="_get_vals"></a><div class="element clickable method private _get_vals" data-toggle="collapse" data-target="._get_vals .collapse">
<h2>Get the values of the widgets in the window</h2>
<pre>_get_vals() : object</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>object</code></div>
</div></div>
</div>
<a name="_hide" id="_hide"></a><div class="element clickable method private _hide" data-toggle="collapse" data-target="._hide .collapse">
<h2>Hides a list of elements</h2>
<pre>_hide($ctrls) </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>$ctrls</h4>
<code></code><p>array</p></div>
</div></div>
</div>
<a name="_show" id="_show"></a><div class="element clickable method private _show" data-toggle="collapse" data-target="._show .collapse">
<h2>Shows a list of elements</h2>
<pre>_show($ctrls) </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>$ctrls</h4>
<code></code><p>array</p></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24fields" id="$fields"> </a><div class="element clickable property protected $fields" data-toggle="collapse" data-target=".$fields .collapse">
@ -144,8 +218,26 @@
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24labels" id="$labels"> </a><div class="element clickable property protected $labels" data-toggle="collapse" data-target=".$labels .collapse">
<h2>Array of labels for Connection Information manipulation</h2>
<pre>$labels : array</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-constant"></i> Constants</h3>
<a name="BTN_ADD" id="BTN_ADD"> </a><div class="element clickable constant BTN_ADD" data-toggle="collapse" data-target=".BTN_ADD .collapse">
<h2>BTN_ADD</h2>
<pre>BTN_ADD </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="BTN_TEST" id="BTN_TEST"> </a><div class="element clickable constant BTN_TEST" data-toggle="collapse" data-target=".BTN_TEST .collapse">
<h2>BTN_TEST</h2>
<pre>BTN_TEST </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="COMBO_DB_TYPE" id="COMBO_DB_TYPE"> </a><div class="element clickable constant COMBO_DB_TYPE" data-toggle="collapse" data-target=".COMBO_DB_TYPE .collapse">
<h2>COMBO_DB_TYPE</h2>
<pre>COMBO_DB_TYPE </pre>
@ -201,7 +293,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

18
docs/classes/OpenSQLManager.Connection_Sidebar.html
View File

@ -62,6 +62,8 @@
<li class="method public "><a href="#get_instance" title="get_instance :: Return the current instance of the class"><span class="description">Return the current instance of the class</span><pre>get_instance()</pre></a></li>
<li class="method public "><a href="#menu" title="menu :: Right-click event to create context menu"><span class="description">Right-click event to create context menu</span><pre>menu()</pre></a></li>
<li class="method public "><a href="#menu_event" title="menu_event :: Handler for context menu options"><span class="description">Handler for context menu options</span><pre>menu_event()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#_layout" title="_layout :: Add the existing items to the connection sidebar"><span class="description">Add the existing items to the connection sidebar</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>
@ -73,7 +75,7 @@
<li class="property private "><a href="#%24list" title="$list :: Reference to the list control that holds the connections"><span class="description">Reference to the list control that holds the connections</span><pre>$list</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant "><a href="#BUTTON_ADD" title="BUTTON_ADD :: "><span class="description">BUTTON_ADD</span><pre>BUTTON_ADD</pre></a></li>
<li class="constant "><a href="#BTN_ADD" title="BTN_ADD :: "><span class="description">BTN_ADD</span><pre>BTN_ADD</pre></a></li>
<li class="constant "><a href="#MENU_CONNECT" title="MENU_CONNECT :: "><span class="description">MENU_CONNECT</span><pre>MENU_CONNECT</pre></a></li>
<li class="constant "><a href="#MENU_DELETE_CONNECT" title="MENU_DELETE_CONNECT :: "><span class="description">MENU_DELETE_CONNECT</span><pre>MENU_DELETE_CONNECT</pre></a></li>
<li class="constant "><a href="#MENU_DISCONNECT" title="MENU_DISCONNECT :: "><span class="description">MENU_DISCONNECT</span><pre>MENU_DISCONNECT</pre></a></li>
@ -168,6 +170,12 @@
<code></code><p>wxEvent</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>Add the existing items to the connection sidebar</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="%24menu" id="$menu"> </a><div class="element clickable property protected $menu" data-toggle="collapse" data-target=".$menu .collapse">
@ -202,9 +210,9 @@
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a name="BUTTON_ADD" id="BUTTON_ADD"> </a><div class="element clickable constant BUTTON_ADD" data-toggle="collapse" data-target=".BUTTON_ADD .collapse">
<h2>BUTTON_ADD</h2>
<pre>BUTTON_ADD </pre>
<a name="BTN_ADD" id="BTN_ADD"> </a><div class="element clickable constant BTN_ADD" data-toggle="collapse" data-target=".BTN_ADD .collapse">
<h2>BTN_ADD</h2>
<pre>BTN_ADD </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
@ -239,7 +247,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/OpenSQLManager.DB_Reg.html
View File

@ -161,7 +161,7 @@ and organizes database connections</p></p>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-05-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/OpenSQLManager.DB_tabs.html
View File

@ -147,7 +147,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/OpenSQLManager.Data_Grid.html
View File

@ -105,7 +105,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

10
docs/classes/OpenSQLManager.Main.html
View File

@ -127,13 +127,9 @@ Create menus, hboxes, vboxs and other widgets</span><pre>_main_layout()</pre></a
</div>
<a name="_create_menu" id="_create_menu"></a><div class="element clickable method private _create_menu" data-toggle="collapse" data-target="._create_menu .collapse">
<h2>Create the menu for the program</h2>
<pre>_create_menu() : \OpenSQLManager\GtkMenuBar</pre>
<pre>_create_menu() : void</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>\OpenSQLManager\GtkMenuBar</code></div>
</div></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="_main_layout" id="_main_layout"></a><div class="element clickable method private _main_layout" data-toggle="collapse" data-target="._main_layout .collapse">
<h2>Layout the main interface
@ -169,7 +165,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/OpenSQLManager.OpenSQLManager.html
View File

@ -108,7 +108,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/classes/OpenSQLManager.Settings.html
View File

@ -253,7 +253,7 @@ directly - the settings should be safe!</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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/deprecated.html
View File

@ -67,7 +67,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/errors.html
View File

@ -79,7 +79,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/graph_class.html
View File

@ -64,7 +64,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/index.html
View File

@ -86,7 +86,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/markers.html
View File

@ -69,7 +69,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/namespaces/OpenSQLManager.html
View File

@ -281,7 +281,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/packages/.html
View File

@ -67,7 +67,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/packages/Default.html
View File

@ -108,7 +108,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/packages/OpenSQLManager.Widgets.html
View File

@ -113,7 +113,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/packages/OpenSQLManager.Windows.html
View File

@ -89,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/packages/OpenSQLManager.html
View File

@ -285,7 +285,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/packages/Query.Helper Classes.html
View File

@ -97,7 +97,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

2
docs/packages/Query.html
View File

@ -103,7 +103,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-31T09:56:04-04:00.<br></footer></div>
generated on 2012-06-05T14:38:46-04:00.<br></footer></div>
</div>
</body>
</html>

221
docs/structure.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="OpenSQLManager">
<file path="OpenSQLManager.php" hash="4db6254972a0df0a829ee7bc331d7f96" package="OpenSQLManager">
<file path="OpenSQLManager.php" hash="9536bf13a33f51b117b5e2155270d897" package="OpenSQLManager">
<docblock line="3">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
@ -10,9 +10,6 @@
<tag line="3" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="3" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<include line="142" type="Require Once" package="Default">
<name>/common/functions.php</name>
</include>
<include line="148" type="Require Once" package="Default">
<name>/db/autoload.php</name>
</include>
@ -248,7 +245,7 @@ and organizes database connections</p>]]></long-description>
</method>
</class>
</file>
<file path="sys/common/settings.php" hash="7859abd7375d83a20a253c5d0cbf9498" package="OpenSQLManager">
<file path="sys/common/settings.php" hash="b03acbc7cc392bcc41ffa9641781f6a3" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
@ -402,47 +399,47 @@ directly - the settings should be safe!]]></description>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="218" package="">
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="223" package="">
<name>remove_db</name>
<type>function</type>
<docblock line="213">
<docblock line="218">
<description><![CDATA[Remove a database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="213" name="param" description="" type="string" variable="$name">
<tag line="218" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="218">
<argument line="223">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="239" package="">
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="244" package="">
<name>get_dbs</name>
<type>function</type>
<docblock line="234">
<docblock line="239">
<description><![CDATA[Retreive all db connections]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="234" name="return" description="" type="array">
<tag line="239" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="252" package="">
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="257" package="">
<name>get_db</name>
<type>function</type>
<docblock line="246">
<docblock line="251">
<description><![CDATA[Retreive a specific database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="246" name="param" description="" type="string" variable="$name">
<tag line="251" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="246" name="return" description="" type="object">
<tag line="251" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="252">
<argument line="257">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
@ -537,7 +534,7 @@ directly - the settings should be safe!]]></description>
</argument>
</function>
</file>
<file path="sys/widgets/connection_sidebar.php" hash="8b5543265b9ba9ddbfcc860485908511" package="OpenSQLManager">
<file path="sys/widgets/connection_sidebar.php" hash="161d728ba9ec9759bd449f4d9cdcd2c2" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
@ -574,7 +571,7 @@ directly - the settings should be safe!]]></description>
<value><![CDATA[4]]></value>
</constant>
<constant namespace="OpenSQLManager" line="30" package="Default">
<name>BUTTON_ADD</name>
<name>BTN_ADD</name>
<value><![CDATA[5]]></value>
</constant>
<property final="false" static="false" visibility="protected" line="37" package="Default">
@ -663,57 +660,68 @@ directly - the settings should be safe!]]></description>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="122" package="">
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="125" package="">
<name>menu</name>
<type>function</type>
<docblock line="116">
<docblock line="119">
<description><![CDATA[Right-click event to create context menu]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="116" name="param" description="wxEvent" type="" variable="$event"/>
<tag line="116" name="return" description="" type="void">
<tag line="119" name="param" description="wxEvent" type="" variable="$event"/>
<tag line="119" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="122">
<argument line="125">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="147" package="">
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="150" package="">
<name>menu_event</name>
<type>function</type>
<docblock line="141">
<docblock line="144">
<description><![CDATA[Handler for context menu options]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="141" name="param" description="wxEvent" type="" variable="$event"/>
<tag line="141" name="return" description="" type="void">
<tag line="144" name="param" description="wxEvent" type="" variable="$event"/>
<tag line="144" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="147">
<argument line="150">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="160" package="">
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="163" package="">
<name>add_conn</name>
<type>function</type>
<docblock line="154">
<docblock line="157">
<description><![CDATA[Handles an event for adding a connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="154" name="param" description="wxEvent" type="" variable="$event"/>
<tag line="154" name="return" description="" type="void">
<tag line="157" name="param" description="wxEvent" type="" variable="$event"/>
<tag line="157" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="160">
<argument line="163">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="176" package="">
<name>_layout</name>
<type>function</type>
<docblock line="171">
<description><![CDATA[Add the existing items to the connection sidebar]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="171" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/widgets/data_grid.php" hash="5794c991a5ee3ae141b636a7fcaa3a16" package="OpenSQLManager">
@ -842,7 +850,7 @@ directly - the settings should be safe!]]></description>
</method>
</class>
</file>
<file path="sys/windows/connection_manager.php" hash="e651cf96a7bff92016beae719b6a8272" package="OpenSQLManager">
<file path="sys/windows/connection_manager.php" hash="716f909cd41a331f5f25b637cf2dfe3e" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
@ -894,62 +902,165 @@ directly - the settings should be safe!]]></description>
<name>TXT_DB_PASS</name>
<value><![CDATA[8]]></value>
</constant>
<property final="false" static="false" visibility="protected" line="40" package="Default">
<constant namespace="OpenSQLManager" line="34" package="Default">
<name>BTN_TEST</name>
<value><![CDATA[9]]></value>
</constant>
<constant namespace="OpenSQLManager" line="35" package="Default">
<name>BTN_ADD</name>
<value><![CDATA[10]]></value>
</constant>
<property final="false" static="false" visibility="protected" line="42" package="Default">
<name>$fields</name>
<default><![CDATA[array()]]></default>
<docblock line="35">
<docblock line="37">
<description><![CDATA[Array of fields for Connection Information manipulation]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="35" name="var" description="" type="array">
<tag line="37" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="48" package="">
<property final="false" static="false" visibility="protected" line="49" package="Default">
<name>$labels</name>
<default><![CDATA[array()]]></default>
<docblock line="44">
<description><![CDATA[Array of labels for Connection Information manipulation]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="44" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="57" package="">
<name>__construct</name>
<type>function</type>
<docblock line="42">
<docblock line="51">
<description><![CDATA[Create the window]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="42" name="param" description="wxWindow" type="" variable="$parent"/>
<tag line="42" name="param" description="mixed" type="" variable="$params"/>
<tag line="51" name="param" description="wxWindow" type="" variable="$parent"/>
<tag line="51" name="param" description="mixed" type="" variable="$params"/>
</docblock>
<argument line="48">
<argument line="57">
<name>$parent</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="48">
<argument line="57">
<name>$params</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" namespace="OpenSQLManager" line="63" package="">
<method final="false" abstract="false" static="false" visibility="protected" namespace="OpenSQLManager" line="75" package="">
<name>_layout</name>
<type>function</type>
<docblock line="58">
<docblock line="70">
<description><![CDATA[Layout fields on the form]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="58" name="param" description="array" type="" variable="$params"/>
<tag line="70" name="param" description="array" type="" variable="$params"/>
</docblock>
<argument line="63">
<argument line="75">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" namespace="OpenSQLManager" line="119" package="">
<method final="false" abstract="false" static="false" visibility="protected" namespace="OpenSQLManager" line="156" package="">
<name>get_available_dbs</name>
<type>function</type>
<docblock line="114">
<docblock line="151">
<description><![CDATA[Get the list of available database types]]></description>
<long-description><![CDATA[<p>return array</p>]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="205" package="">
<name>add_conn</name>
<type>function</type>
<docblock line="199">
<description><![CDATA[Adds a connection to the connection manager]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="199" name="param" description="wxCommandEvent" type="" variable="$event"/>
<tag line="199" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="205">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="226" package="">
<name>change_db</name>
<type>function</type>
<docblock line="220">
<description><![CDATA[Set defaults for new database type]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="220" name="param" description="wxCommandEvent" type="" variable="$event"/>
<tag line="220" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="226">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="292" package="">
<name>test_conn</name>
<type>function</type>
<docblock line="287">
<description><![CDATA[Test a db connection, and display a popup with the result]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="287" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="330" package="">
<name>_get_vals</name>
<type>function</type>
<docblock line="325">
<description><![CDATA[Get the values of the widgets in the window]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="325" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="360" package="">
<name>_hide</name>
<type>function</type>
<docblock line="355">
<description><![CDATA[Hides a list of elements]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="355" name="param" description="array" type="" variable="$ctrls"/>
</docblock>
<argument line="360">
<name>$ctrls</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="379" package="">
<name>_show</name>
<type>function</type>
<docblock line="374">
<description><![CDATA[Shows a list of elements]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="374" name="param" description="array" type="" variable="$ctrls"/>
</docblock>
<argument line="379">
<name>$ctrls</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/windows/main.php" hash="28ed5acc6ae1bd3153cd50f3cdd51459" package="OpenSQLManager">
<file path="sys/windows/main.php" hash="8c4da4a09cf8166f849152a3d48bd3fd" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
@ -1055,14 +1166,14 @@ Create menus, hboxes, vboxs and other widgets]]></description>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="156" package="">
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="154" package="">
<name>_create_menu</name>
<type>function</type>
<docblock line="151">
<docblock line="149">
<description><![CDATA[Create the menu for the program]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="151" name="return" description="" type="\OpenSQLManager\GtkMenuBar">
<type by_reference="false">\OpenSQLManager\GtkMenuBar</type>
<tag line="149" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>