318 lines
21 KiB
HTML
318 lines
21 KiB
HTML
<!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>
|