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
2012-05-30 07:44:38 -04:00

607 lines
28 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="OpenSQLManager">
<file path="OpenSQLManager.php" hash="df1762723295300ad0aa65aa5bdbb90c" 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.1.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="162" package="OpenSQLManager">
<name>OpenSQLManager</name>
<full_name>\OpenSQLManager\OpenSQLManager</full_name>
<extends>\wxApp</extends>
<docblock line="157">
<description><![CDATA[Class for the app itself]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="157" name="package" description="OpenSQLManager"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="169" package="">
<name>OnInit</name>
<type>function</type>
<docblock line="164">
<description><![CDATA[Initialize the app]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="164" 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="182" package="">
<name>OnExit</name>
<type>function</type>
<docblock line="177">
<description><![CDATA[Return exit code]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="177" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/common/functions.php" hash="e3c7cffd53464a25da5606046104064d" 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="87" package="OpenSQLManager">
<name>confirm</name>
<type>function</type>
<docblock line="81">
<description><![CDATA[Creates a binary confirmation dialog]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="81" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="81" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="87">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
</file>
<file path="sys/widgets/connection_sidebar.php" hash="28ec3ba5675b59b1b46b00bb0018e159" 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>\wxWindow</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>
<property final="false" static="false" visibility="protected" line="31" package="Default">
<name>$settings</name>
<default><![CDATA[]]></default>
<docblock line="26">
<description><![CDATA[Reference to Settings instance]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="var" description="" type="\OpenSQLManager\Settings">
<type by_reference="false">\OpenSQLManager\Settings</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="38" package="Default">
<name>$menu</name>
<default><![CDATA[]]></default>
<docblock line="33">
<description><![CDATA[Reference to popup menu]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="33" name="var" description="" type="\OpenSQLManager\GtkMenu">
<type by_reference="false">\OpenSQLManager\GtkMenu</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="45" package="Default">
<name>$treeview</name>
<default><![CDATA[]]></default>
<docblock line="40">
<description><![CDATA[Treeview for displaying connections]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="40" name="var" description="" type="\OpenSQLManager\GtkTreeView">
<type by_reference="false">\OpenSQLManager\GtkTreeView</type>
</tag>
</docblock>
</property>
<property final="false" static="true" visibility="private" line="52" package="Default">
<name>$instance</name>
<default><![CDATA[]]></default>
<docblock line="47">
<description><![CDATA[Singleton instance]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="47" 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="59" package="Default">
<name>$conn_name</name>
<default><![CDATA[]]></default>
<docblock line="54">
<description><![CDATA[Name of current db connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="54" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="true" visibility="public" namespace="OpenSQLManager" line="66" package="">
<name>get_instance</name>
<type>function</type>
<docblock line="61">
<description><![CDATA[Return the current instance of the class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="61" name="return" description="" type="\OpenSQLManager\Connection_Sidebar">
<type by_reference="false">\OpenSQLManager\Connection_Sidebar</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="82" package="">
<name>__construct</name>
<type>function</type>
<docblock line="79">
<description><![CDATA[Constructor method]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="protected" namespace="OpenSQLManager" line="96" package="">
<name>_render</name>
<type>function</type>
<docblock line="91">
<description><![CDATA[Renders the connection sidebar widget]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="91" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/widgets/data_grid.php" hash="93a4b05d199375729c63996432845086" 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>
<property final="false" static="false" visibility="protected" line="31" package="Default">
<name>$model</name>
<default><![CDATA[]]></default>
<docblock line="26">
<description><![CDATA[GtkTreeStore object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="var" description="" type="\OpenSQLManager\wxGridTableBase">
<type by_reference="false">\OpenSQLManager\wxGridTableBase</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="38" package="">
<name>__construct</name>
<type>function</type>
<docblock line="33">
<description><![CDATA[Create the object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="33" name="param" description="" type="object" variable="$model">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="38">
<name>$model</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/main.php" hash="b323188d605a81ba9bc9ef4166306d02" 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>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="45" package="">
<name>__construct</name>
<type>function</type>
<docblock line="42">
<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="69" package="">
<name>__destruct</name>
<type>function</type>
<docblock line="64">
<description><![CDATA[Some cleanup for when the main window is closed]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="64" 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="81" package="">
<name>quit</name>
<type>function</type>
<docblock line="76">
<description><![CDATA[Exits the wx loop]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="76" 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="93" package="">
<name>about</name>
<type>function</type>
<docblock line="88">
<description><![CDATA[Display About menu with version information]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="88" 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="121" package="">
<name>_main_layout</name>
<type>function</type>
<docblock line="115">
<description><![CDATA[Layout the main interface
Create menus, hboxes, vboxs and other widgets]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="115" 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="152" package="">
<name>_create_menu</name>
<type>function</type>
<docblock line="147">
<description><![CDATA[Create the menu for the program]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="147" 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>
<namespace name="OpenSQLManager" full_name="OpenSQLManager"/>
<marker count="0">todo</marker>
<marker count="0">fixme</marker>
<deprecated count="0"/>
</project>