This repository has been archived on 2018-10-12. You can view files and clone it, but cannot push or open issues or pull requests.
OpenSQLManager/docs/structure.xml

1085 lines
50 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="OpenSQLManager">
<file path="OpenSQLManager.php" hash="4db6254972a0df0a829ee7bc331d7f96" package="OpenSQLManager">
<docblock line="3">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="3" name="package" description="OpenSQLManager"/>
<tag line="3" name="author" description="Timothy J. Warren"/>
<tag line="3" name="copyright" description="Copyright (c) 2012"/>
<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>
<constant namespace="OpenSQLManager" line="35" package="Default">
<name>BASE_DIR</name>
<value><![CDATA[__DIR__.'/sys']]></value>
</constant>
<constant namespace="OpenSQLManager" line="36" package="Default">
<name>SETTINGS_DIR</name>
<value><![CDATA[__DIR__]]></value>
</constant>
<constant namespace="OpenSQLManager" line="37" package="Default">
<name>PROGRAM_NAME</name>
<value><![CDATA['OpenSQLManager']]></value>
</constant>
<constant namespace="OpenSQLManager" line="38" package="Default">
<name>VERSION</name>
<value><![CDATA['0.2.0pre']]></value>
</constant>
<function namespace="OpenSQLManager" line="45" package="OpenSQLManager">
<name>log_fatal</name>
<type>function</type>
<docblock line="42">
<description><![CDATA[Log fatal errors]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</function>
<function namespace="OpenSQLManager" line="89" package="OpenSQLManager">
<name>exception_error_handler</name>
<type>function</type>
<docblock line="80">
<description><![CDATA[Error handler to convert errors to exceptions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="80" name="param" description="" type="int" variable="$errno">
<type by_reference="false">int</type>
</tag>
<tag line="80" name="param" description="" type="string" variable="$errstr">
<type by_reference="false">string</type>
</tag>
<tag line="80" name="param" description="" type="string" variable="$errfile">
<type by_reference="false">string</type>
</tag>
<tag line="80" name="param" description="" type="int" variable="$errline">
<type by_reference="false">int</type>
</tag>
<tag line="80" name="throws" description="" type="\OpenSQLManager\ErrorException">
<type by_reference="false">\OpenSQLManager\ErrorException</type>
</tag>
</docblock>
<argument line="89">
<name>$errno</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="89">
<name>$errstr</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="89">
<name>$errfile</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="89">
<name>$errline</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="OpenSQLManager" line="109" package="OpenSQLManager">
<name>do_include</name>
<type>function</type>
<docblock line="102">
<description><![CDATA[Bulk directory loading workaround for use
with array_map and glob]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="102" name="param" description="" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
<tag line="102" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="109">
<name>$path</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="OpenSQLManager" line="122" package="OpenSQLManager">
<name>osm_autoload</name>
<type>function</type>
<docblock line="117">
<description><![CDATA[Autoloader for OpenSQLManager]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="117" name="param" description="" type="string" variable="$class">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="122">
<name>$class</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<class final="false" abstract="false" namespace="OpenSQLManager" line="159" package="OpenSQLManager">
<name>OpenSQLManager</name>
<full_name>\OpenSQLManager\OpenSQLManager</full_name>
<extends>\wxApp</extends>
<docblock line="154">
<description><![CDATA[Class for the app itself]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="154" name="package" description="OpenSQLManager"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="166" package="">
<name>OnInit</name>
<type>function</type>
<docblock line="161">
<description><![CDATA[Initialize the app]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="161" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="180" package="">
<name>OnExit</name>
<type>function</type>
<docblock line="175">
<description><![CDATA[Return exit code]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="175" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/common/db_reg.php" hash="3598ba0fed487d36dfd11ba0c8d7c839" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="2" name="package" description="OpenSQLManager"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="OpenSQLManager" line="27" package="Query\Helper Classes">
<name>DB_Reg</name>
<full_name>\OpenSQLManager\DB_Reg</full_name>
<extends/>
<docblock line="18">
<description><![CDATA[Connection registry]]></description>
<long-description><![CDATA[<p>Decouples the Settings class from the query builder
and organizes database connections</p>]]></long-description>
<tag line="18" name="package" description="Query"/>
<tag line="18" name="subpackage" description="Helper Classes"/>
</docblock>
<property final="false" static="true" visibility="private" line="32" package="Default">
<name>$instance</name>
<default><![CDATA[array()]]></default>
<docblock line="29">
<description><![CDATA[Static array of connections]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" namespace="OpenSQLManager" line="40" package="">
<name>get_db</name>
<type>function</type>
<docblock line="34">
<description><![CDATA[Registry access method]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="34" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="34" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="40">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="58" package="">
<name>__construct</name>
<type>function</type>
<docblock line="53">
<description><![CDATA[Private constructor]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="53" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="58">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="true" visibility="public" namespace="OpenSQLManager" line="74" package="">
<name>get_connections</name>
<type>function</type>
<docblock line="69">
<description><![CDATA[Return exiting connections]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="69" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="true" visibility="public" namespace="OpenSQLManager" line="87" package="">
<name>remove_db</name>
<type>function</type>
<docblock line="81">
<description><![CDATA[Remove a database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="81" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="81" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="87">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/common/settings.php" hash="7859abd7375d83a20a253c5d0cbf9498" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="2" name="package" description="OpenSQLManager"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="OpenSQLManager" line="24" package="Query\Helper Classes">
<name>Settings</name>
<full_name>\OpenSQLManager\Settings</full_name>
<extends/>
<docblock line="18">
<description><![CDATA[Class for manipulating datbase connections, and miscellaneous settings]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="Query"/>
<tag line="18" name="subpackage" description="Helper Classes"/>
</docblock>
<property final="false" static="false" visibility="private" line="29" package="Default">
<name>$current</name>
<default><![CDATA[]]></default>
<docblock line="26">
<description><![CDATA[Settings object represented by the currently loaded JSON file]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="34" package="Default">
<name>$instance</name>
<default><![CDATA[]]></default>
<docblock line="31">
<description><![CDATA[Singleton instance]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" namespace="OpenSQLManager" line="42" package="">
<name>get_instance</name>
<type>function</type>
<docblock line="36">
<description><![CDATA[Static method to retreive current instance
of the singleton]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="36" name="return" description="" type="\OpenSQLManager\Settings">
<type by_reference="false">\OpenSQLManager\Settings</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="57" package="">
<name>__construct</name>
<type>function</type>
<docblock line="53">
<description><![CDATA[Load the settings file - private so it can't be loaded
directly - the settings should be safe!]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="92" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="89">
<description><![CDATA[Output the settings on destruct]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="109" package="">
<name>__get</name>
<type>function</type>
<docblock line="103">
<description><![CDATA[Magic method to simplify isset checking for config options]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="103" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="103" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="109">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="124" package="">
<name>__set</name>
<type>function</type>
<docblock line="118">
<description><![CDATA[Magic method to simplify setting config options]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="118" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="118" name="param" description="mixed" type="" variable="$val"/>
</docblock>
<argument line="124">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="124">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="143" package="">
<name>add_db</name>
<type>function</type>
<docblock line="137">
<description><![CDATA[Add a database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="137" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="137" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="143">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="143">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="175" package="">
<name>edit_db</name>
<type>function</type>
<docblock line="169">
<description><![CDATA[Edit a database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="169" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="169" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="175">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="175">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="218" package="">
<name>remove_db</name>
<type>function</type>
<docblock line="213">
<description><![CDATA[Remove a database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="213" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="218">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="239" package="">
<name>get_dbs</name>
<type>function</type>
<docblock line="234">
<description><![CDATA[Retreive all db connections]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="234" 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="">
<name>get_db</name>
<type>function</type>
<docblock line="246">
<description><![CDATA[Retreive a specific database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="246" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="246" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="252">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/common/functions.php" hash="68d4a7cd2278329346ce123e87bc12dc" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="2" name="package" description="OpenSQLManager"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<function namespace="OpenSQLManager" line="26" package="OpenSQLManager">
<name>array_to_object</name>
<type>function</type>
<docblock line="20">
<description><![CDATA[Convert an array to an object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="20" name="param" description="" type="array" variable="$array">
<type by_reference="false">array</type>
</tag>
<tag line="20" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="26">
<name>$array</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="OpenSQLManager" line="51" package="OpenSQLManager">
<name>alert</name>
<type>function</type>
<docblock line="45">
<description><![CDATA[Create info dialog to return an informational message]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="45" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="45" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="51">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="OpenSQLManager" line="64" package="OpenSQLManager">
<name>error</name>
<type>function</type>
<docblock line="58">
<description><![CDATA[Create info dialog to retun an informational message]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="58" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="58" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="64">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="OpenSQLManager" line="77" package="OpenSQLManager">
<name>confirm</name>
<type>function</type>
<docblock line="71">
<description><![CDATA[Creates a binary confirmation dialog]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="71" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="71" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="77">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
</file>
<file path="sys/widgets/connection_sidebar.php" hash="8b5543265b9ba9ddbfcc860485908511" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="2" name="package" description="OpenSQLManager"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="OpenSQLManager" line="24" package="OpenSQLManager\Widgets">
<name>Connection_Sidebar</name>
<full_name>\OpenSQLManager\Connection_Sidebar</full_name>
<extends>\wxPanel</extends>
<docblock line="18">
<description><![CDATA[Widget managing saved database connections]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="OpenSQLManager"/>
<tag line="18" name="subpackage" description="Widgets"/>
</docblock>
<constant namespace="OpenSQLManager" line="26" package="Default">
<name>MENU_CONNECT</name>
<value><![CDATA[1]]></value>
</constant>
<constant namespace="OpenSQLManager" line="27" package="Default">
<name>MENU_DISCONNECT</name>
<value><![CDATA[2]]></value>
</constant>
<constant namespace="OpenSQLManager" line="28" package="Default">
<name>MENU_EDIT_CONNECT</name>
<value><![CDATA[3]]></value>
</constant>
<constant namespace="OpenSQLManager" line="29" package="Default">
<name>MENU_DELETE_CONNECT</name>
<value><![CDATA[4]]></value>
</constant>
<constant namespace="OpenSQLManager" line="30" package="Default">
<name>BUTTON_ADD</name>
<value><![CDATA[5]]></value>
</constant>
<property final="false" static="false" visibility="protected" line="37" package="Default">
<name>$settings</name>
<default><![CDATA[]]></default>
<docblock line="32">
<description><![CDATA[Reference to Settings instance]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="32" name="var" description="" type="\OpenSQLManager\Settings">
<type by_reference="false">\OpenSQLManager\Settings</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="44" package="Default">
<name>$menu</name>
<default><![CDATA[]]></default>
<docblock line="39">
<description><![CDATA[Reference to popup menu]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="39" name="var" description="" type="\OpenSQLManager\wxMenu">
<type by_reference="false">\OpenSQLManager\wxMenu</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="51" package="Default">
<name>$instance</name>
<default><![CDATA[]]></default>
<docblock line="46">
<description><![CDATA[Singleton instance]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="46" name="var" description="" type="\OpenSQLManager\Connection_Sidebar">
<type by_reference="false">\OpenSQLManager\Connection_Sidebar</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="58" package="Default">
<name>$conn_name</name>
<default><![CDATA[]]></default>
<docblock line="53">
<description><![CDATA[Name of current db connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="53" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="65" package="Default">
<name>$list</name>
<default><![CDATA[]]></default>
<docblock line="60">
<description><![CDATA[Reference to the list control that holds the connections]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="60" name="var" description="" type="\OpenSQLManager\wxListCtrl">
<type by_reference="false">\OpenSQLManager\wxListCtrl</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" namespace="OpenSQLManager" line="73" package="">
<name>get_instance</name>
<type>function</type>
<docblock line="67">
<description><![CDATA[Return the current instance of the class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="67" name="param" description="wxWindow" type="" variable="$parent"/>
<tag line="67" name="return" description="" type="\OpenSQLManager\Connection_Sidebar">
<type by_reference="false">\OpenSQLManager\Connection_Sidebar</type>
</tag>
</docblock>
<argument line="73">
<name>$parent</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="91" package="">
<name>__construct</name>
<type>function</type>
<docblock line="86">
<description><![CDATA[Constructor method]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="86" name="param" description="wxWindow" type="" variable="$parent"/>
</docblock>
<argument line="91">
<name>$parent</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="122" package="">
<name>menu</name>
<type>function</type>
<docblock line="116">
<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">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="122">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="147" package="">
<name>menu_event</name>
<type>function</type>
<docblock line="141">
<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">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="147">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="160" package="">
<name>add_conn</name>
<type>function</type>
<docblock line="154">
<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">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="160">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/widgets/data_grid.php" hash="5794c991a5ee3ae141b636a7fcaa3a16" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="2" name="package" description="OpenSQLManager"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="OpenSQLManager" line="24" package="OpenSQLManager\Widgets">
<name>Data_Grid</name>
<full_name>\OpenSQLManager\Data_Grid</full_name>
<extends>\wxGrid</extends>
<docblock line="18">
<description><![CDATA[Class to simplify dealing with GtkTreeView]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="OpenSQLManager"/>
<tag line="18" name="subpackage" description="Widgets"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="31" package="">
<name>__construct</name>
<type>function</type>
<docblock line="26">
<description><![CDATA[Create the object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="param" description="object" type="" variable="$parent"/>
</docblock>
<argument line="31">
<name>$parent</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/widgets/db_tabs.php" hash="d880d78b09c8a04920ed5760f26343fd" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="2" name="package" description="OpenSQLManager"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="OpenSQLManager" line="24" package="OpenSQLManager\Widgets">
<name>DB_tabs</name>
<full_name>\OpenSQLManager\DB_tabs</full_name>
<extends>\wxNotebook</extends>
<docblock line="18">
<description><![CDATA[Tabbed Container for database properties]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="OpenSQLManager"/>
<tag line="18" name="subpackage" description="Widgets"/>
</docblock>
<property final="false" static="true" visibility="private" line="31" package="Default">
<name>$instance</name>
<default><![CDATA[]]></default>
<docblock line="26">
<description><![CDATA[Current Tab Widget object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="var" description="" type="\OpenSQLManager\DB_Tabs">
<type by_reference="false">\OpenSQLManager\DB_Tabs</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="38" package="Default">
<name>$data</name>
<default><![CDATA[]]></default>
<docblock line="33">
<description><![CDATA[Db Data cache]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="33" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" namespace="OpenSQLManager" line="45" package="">
<name>get_instance</name>
<type>function</type>
<docblock line="40">
<description><![CDATA[Return the db tabs object if it exists, or create and return]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="40" name="return" description="" type="\OpenSQLManager\DB_tabs">
<type by_reference="false">\OpenSQLManager\DB_tabs</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="60" package="">
<name>__construct</name>
<type>function</type>
<docblock line="57">
<description><![CDATA[Create the object]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="75" package="">
<name>add_tab</name>
<type>function</type>
<docblock line="68">
<description><![CDATA[Add a new tab with the provided label]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="68" name="param" description="" type="string" variable="$label">
<type by_reference="false">string</type>
</tag>
<tag line="68" name="param" description="" type="\OpenSQLManager\GObject" variable="$widget">
<type by_reference="false">\OpenSQLManager\GObject</type>
</tag>
<tag line="68" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="75">
<name>$label</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="75">
<name>$widget</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/windows/connection_manager.php" hash="e651cf96a7bff92016beae719b6a8272" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="2" name="package" description="OpenSQLManager"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="OpenSQLManager" line="24" package="OpenSQLManager\Widgets">
<name>Connection_Manager</name>
<full_name>\OpenSQLManager\Connection_Manager</full_name>
<extends>\wxFrame</extends>
<docblock line="18">
<description><![CDATA[Widget for adding / Editing Connections]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="18" name="package" description="OpenSQLManager"/>
<tag line="18" name="subpackage" description="Widgets"/>
</docblock>
<constant namespace="OpenSQLManager" line="26" package="Default">
<name>TXT_CONN_NAME</name>
<value><![CDATA[1]]></value>
</constant>
<constant namespace="OpenSQLManager" line="27" package="Default">
<name>COMBO_DB_TYPE</name>
<value><![CDATA[2]]></value>
</constant>
<constant namespace="OpenSQLManager" line="28" package="Default">
<name>FILE_DB_FILE</name>
<value><![CDATA[3]]></value>
</constant>
<constant namespace="OpenSQLManager" line="29" package="Default">
<name>TXT_DB_NAME</name>
<value><![CDATA[4]]></value>
</constant>
<constant namespace="OpenSQLManager" line="30" package="Default">
<name>TXT_DB_HOST</name>
<value><![CDATA[5]]></value>
</constant>
<constant namespace="OpenSQLManager" line="31" package="Default">
<name>TXT_DB_PORT</name>
<value><![CDATA[6]]></value>
</constant>
<constant namespace="OpenSQLManager" line="32" package="Default">
<name>TXT_DB_USER</name>
<value><![CDATA[7]]></value>
</constant>
<constant namespace="OpenSQLManager" line="33" package="Default">
<name>TXT_DB_PASS</name>
<value><![CDATA[8]]></value>
</constant>
<property final="false" static="false" visibility="protected" line="40" package="Default">
<name>$fields</name>
<default><![CDATA[array()]]></default>
<docblock line="35">
<description><![CDATA[Array of fields for Connection Information manipulation]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="35" 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="">
<name>__construct</name>
<type>function</type>
<docblock line="42">
<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"/>
</docblock>
<argument line="48">
<name>$parent</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="48">
<name>$params</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" namespace="OpenSQLManager" line="63" package="">
<name>_layout</name>
<type>function</type>
<docblock line="58">
<description><![CDATA[Layout fields on the form]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="58" name="param" description="array" type="" variable="$params"/>
</docblock>
<argument line="63">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" namespace="OpenSQLManager" line="119" package="">
<name>get_available_dbs</name>
<type>function</type>
<docblock line="114">
<description><![CDATA[Get the list of available database types]]></description>
<long-description><![CDATA[<p>return array</p>]]></long-description>
</docblock>
</method>
</class>
</file>
<file path="sys/windows/main.php" hash="28ed5acc6ae1bd3153cd50f3cdd51459" package="OpenSQLManager">
<docblock line="2">
<description><![CDATA[OpenSQLManager]]></description>
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
<tag line="2" name="package" description="OpenSQLManager"/>
<tag line="2" name="author" description="Timothy J. Warren"/>
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="OpenSQLManager" line="26" package="OpenSQLManager\Windows">
<name>Main</name>
<full_name>\OpenSQLManager\Main</full_name>
<extends>\wxFrame</extends>
<docblock line="18">
<description><![CDATA[Main Window Class]]></description>
<long-description><![CDATA[<p>Creates and displays the main interface window</p>]]></long-description>
<tag line="18" name="package" description="OpenSQLManager"/>
<tag line="18" name="subpackage" description="Windows"/>
</docblock>
<property final="false" static="false" visibility="private" line="33" package="Default">
<name>$settings</name>
<default><![CDATA[]]></default>
<docblock line="28">
<description><![CDATA[Reference to settings instance]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="28" name="var" description="" type="\OpenSQLManager\Settings">
<type by_reference="false">\OpenSQLManager\Settings</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="40" package="Default">
<name>$connection_sidebar</name>
<default><![CDATA[]]></default>
<docblock line="35">
<description><![CDATA[Reference to connection sidebar instance]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="35" name="var" description="" type="\OpenSQLManager\Connection_Sidebar">
<type by_reference="false">\OpenSQLManager\Connection_Sidebar</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="47" package="Default">
<name>$split</name>
<default><![CDATA[]]></default>
<docblock line="42">
<description><![CDATA[Reference to split window]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="42" name="var" description="" type="\OpenSQLManager\wxSplitterWindow">
<type by_reference="false">\OpenSQLManager\wxSplitterWindow</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="52" package="">
<name>__construct</name>
<type>function</type>
<docblock line="49">
<description><![CDATA[Create and display the main window on startup]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="74" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="69">
<description><![CDATA[Some cleanup for when the main window is closed]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="69" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="86" package="">
<name>quit</name>
<type>function</type>
<docblock line="81">
<description><![CDATA[Exits the wx loop]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="81" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="98" package="">
<name>about</name>
<type>function</type>
<docblock line="93">
<description><![CDATA[Display About menu with version information]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="93" 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="126" package="">
<name>_main_layout</name>
<type>function</type>
<docblock line="120">
<description><![CDATA[Layout the main interface
Create menus, hboxes, vboxs and other widgets]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="120" 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="156" package="">
<name>_create_menu</name>
<type>function</type>
<docblock line="151">
<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>
</docblock>
</method>
</class>
</file>
<package name="" full_name=""/>
<package name="Default" full_name="Default"/>
<package name="OpenSQLManager" full_name="OpenSQLManager">
<package name="Widgets" full_name="OpenSQLManager\Widgets"/>
<package name="Windows" full_name="OpenSQLManager\Windows"/>
</package>
<package name="Query" full_name="Query">
<package name="Helper Classes" full_name="Query\Helper Classes"/>
</package>
<namespace name="OpenSQLManager" full_name="OpenSQLManager"/>
<marker count="0">todo</marker>
<marker count="0">fixme</marker>
<deprecated count="0"/>
</project>