timw4mail/OpenSQLManager
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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.
40d923ee03
OpenSQLManager/docs/structure.xml
Timothy Warren 13593cb848 Update docs
2012-06-06 16:47:57 -04:00

6339 lines
281 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="OpenSQLManager">
<file path="OpenSQLManager.php" hash="99f6f055fc58bda8e851d0eb37b3012d" 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>
<include line="148" type="Require Once" package="Default">
<name>/db/autoload.php</name>
</include>
<constant namespace="OpenSQLManager" line="34" package="Default">
<name>BASE_DIR</name>
<value><![CDATA[__DIR__.'/sys']]></value>
</constant>
<constant namespace="OpenSQLManager" line="35" package="Default">
<name>RESOURCE_DIR</name>
<value><![CDATA[__DIR__.'/resources']]></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>
<constant namespace="OpenSQLManager" line="194" package="Default">
<name>PLATFORM</name>
<value><![CDATA[$platform->GetOperatingSystemId()]]></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/db/classes/db_sql.php" hash="14cb2bdd5a651d09acb10a4f583d4927" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
<tag line="2" name="package" description="Query"/>
</docblock>
<class final="false" abstract="true" namespace="default" line="22" package="Query\Query">
<name>DB_SQL</name>
<full_name>\DB_SQL</full_name>
<extends/>
<docblock line="16">
<description><![CDATA[Abstract parent for database manipulation subclasses]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Query"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="33" package="">
<name>max</name>
<type>function</type>
<docblock line="28">
<description><![CDATA[Get the max keyword sql]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="28" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="45" package="">
<name>min</name>
<type>function</type>
<docblock line="40">
<description><![CDATA[Get the min keyword sql]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="40" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="57" package="">
<name>distinct</name>
<type>function</type>
<docblock line="52">
<description><![CDATA[Get the 'distinct' keyword]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="52" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
<name>avg</name>
<type>function</type>
<docblock line="64">
<description><![CDATA[Get the 'average' keyword]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="64" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
<name>sum</name>
<type>function</type>
<docblock line="76">
<description><![CDATA[Get the 'sum' keyword]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="76" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="99" package="">
<name>limit</name>
<type>function</type>
<docblock line="90">
<description><![CDATA[Get database specific sql for limit clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="90" name="abstract" description=""/>
<tag line="90" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="90" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="90" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="90" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="99">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="99">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="99">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="107" package="">
<name>random</name>
<type>function</type>
<docblock line="101">
<description><![CDATA[Get the sql for random ordering]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="101" name="abstract" description=""/>
<tag line="101" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="114" package="">
<name>db_list</name>
<type>function</type>
<docblock line="109">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="109" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="121" package="">
<name>table_list</name>
<type>function</type>
<docblock line="116">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="116" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="128" package="">
<name>system_table_list</name>
<type>function</type>
<docblock line="123">
<description><![CDATA[Returns sql to list system tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="123" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="135" package="">
<name>view_list</name>
<type>function</type>
<docblock line="130">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="130" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="142" package="">
<name>trigger_list</name>
<type>function</type>
<docblock line="137">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="137" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="149" package="">
<name>function_list</name>
<type>function</type>
<docblock line="144">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="144" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="156" package="">
<name>procedure_list</name>
<type>function</type>
<docblock line="151">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="151" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="163" package="">
<name>sequence_list</name>
<type>function</type>
<docblock line="158">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="158" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="170" package="">
<name>type_list</name>
<type>function</type>
<docblock line="165">
<description><![CDATA[Return sql to list database field types]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="165" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="179" package="">
<name>column_list</name>
<type>function</type>
<docblock line="172">
<description><![CDATA[Get information about the columns in the
specified table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="172" name="param" description="string" type="" variable="$table"/>
<tag line="172" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="179">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/classes/db_pdo.php" hash="0938453e3e9c073bd1a90396db729de6" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="true" namespace="default" line="24" package="Query\Query">
<name>DB_PDO</name>
<full_name>\DB_PDO</full_name>
<extends>\PDO</extends>
<docblock line="16">
<description><![CDATA[Base Database class]]></description>
<long-description><![CDATA[<p>Extends PDO to simplify cross-database issues</p>]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Query"/>
</docblock>
<property final="false" static="false" visibility="protected" line="31" package="Default">
<name>$statement</name>
<default><![CDATA[]]></default>
<docblock line="26">
<description><![CDATA[Reference to the last executed query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="var" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="38" package="Default">
<name>$escape_char</name>
<default><![CDATA['"']]></default>
<docblock line="33">
<description><![CDATA[Character to escape identifiers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="33" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="public" line="45" package="Default">
<name>$sql</name>
<default><![CDATA[]]></default>
<docblock line="40">
<description><![CDATA[Reference to sql sub class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="40" name="var" description="" type="Object">
<type by_reference="false">Object</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="public" line="52" package="Default">
<name>$util</name>
<default><![CDATA[]]></default>
<docblock line="47">
<description><![CDATA[Reference to util sub class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="47" name="var" description="" type="Object">
<type by_reference="false">Object</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
<name>__construct</name>
<type>function</type>
<docblock line="54">
<description><![CDATA[PDO constructor wrapper]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="54" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
<tag line="54" name="param" description="" type="string" variable="$username">
<type by_reference="false">string</type>
</tag>
<tag line="54" name="param" description="" type="string" variable="$password">
<type by_reference="false">string</type>
</tag>
<tag line="54" name="param" description="" type="array" variable="$driver_options">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="62">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="62">
<name>$username</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="62">
<name>$password</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="62">
<name>$driver_options</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="88" package="">
<name>prepare_query</name>
<type>function</type>
<docblock line="81">
<description><![CDATA[Simplifies prepared statements for database queries]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="81" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="81" name="param" description="" type="array" variable="$data">
<type by_reference="false">array</type>
</tag>
<tag line="81" name="return" description="PDOStatement / FALSE" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="88">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="88">
<name>$data</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="139" package="">
<name>prepare_execute</name>
<type>function</type>
<docblock line="132">
<description><![CDATA[Create and execute a prepared statement with the provided parameters]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="132" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="132" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="132" name="return" description="" type="\PDOStatement">
<type by_reference="false">\PDOStatement</type>
</tag>
</docblock>
<argument line="139">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="139">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="155" package="">
<name>get_query_data</name>
<type>function</type>
<docblock line="149">
<description><![CDATA[Retreives the data from a select query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="149" name="param" description="" type="\PDOStatement" variable="$statement">
<type by_reference="false">\PDOStatement</type>
</tag>
<tag line="149" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="155">
<name>$statement</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="174" package="">
<name>affected_rows</name>
<type>function</type>
<docblock line="168">
<description><![CDATA[Returns number of rows affected by an INSERT, UPDATE, DELETE type query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="168" name="param" description="" type="\PDOStatement" variable="$statement">
<type by_reference="false">\PDOStatement</type>
</tag>
<tag line="168" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="174">
<name>$statement</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="192" package="">
<name>get_last_error</name>
<type>function</type>
<docblock line="187">
<description><![CDATA[Return the last error for the current database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="187" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="207" package="">
<name>quote_ident</name>
<type>function</type>
<docblock line="201">
<description><![CDATA[Surrounds the string with the databases identifier escape characters]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="201" name="param" description="" type="mixed" variable="$ident">
<type by_reference="false">mixed</type>
</tag>
<tag line="201" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="207">
<name>$ident</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="235" package="">
<name>_quote</name>
<type>function</type>
<docblock line="229">
<description><![CDATA[Helper method for quote_ident]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="229" name="param" description="" type="mixed" variable="$str">
<type by_reference="false">mixed</type>
</tag>
<tag line="229" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="235">
<name>$str</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="254" package="">
<name>empty_table</name>
<type>function</type>
<docblock line="247">
<description><![CDATA[Deletes all the rows from a table. Does the same as the truncate
method if the database does not support 'TRUNCATE';]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="247" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="247" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="254">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="268" package="">
<name>get_schemas</name>
<type>function</type>
<docblock line="263">
<description><![CDATA[Return schemas for databases that list them]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="263" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="280" package="">
<name>get_tables</name>
<type>function</type>
<docblock line="275">
<description><![CDATA[Return list of tables for the current database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="275" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="292" package="">
<name>get_dbs</name>
<type>function</type>
<docblock line="287">
<description><![CDATA[Return list of dbs for the current connection, if possible]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="287" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="304" package="">
<name>get_views</name>
<type>function</type>
<docblock line="299">
<description><![CDATA[Return list of views for the current database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="299" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="316" package="">
<name>get_sequences</name>
<type>function</type>
<docblock line="311">
<description><![CDATA[Return list of sequences for the current database, if they exist]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="311" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="328" package="">
<name>get_functions</name>
<type>function</type>
<docblock line="323">
<description><![CDATA[Return list of function for the current database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="323" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="340" package="">
<name>get_procedures</name>
<type>function</type>
<docblock line="335">
<description><![CDATA[Return list of stored procedures for the current database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="335" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="352" package="">
<name>get_triggers</name>
<type>function</type>
<docblock line="347">
<description><![CDATA[Return list of triggers for the current database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="347" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="365" package="">
<name>get_system_tables</name>
<type>function</type>
<docblock line="359">
<description><![CDATA[Retreives an array of non-user-created tables for
the connection/database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="359" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="378" package="">
<name>get_columns</name>
<type>function</type>
<docblock line="372">
<description><![CDATA[Retrieve column information for the current database table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="372" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="372" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="378">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="390" package="">
<name>get_types</name>
<type>function</type>
<docblock line="385">
<description><![CDATA[Retrieve list of data types for the database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="385" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="404" package="">
<name>driver_query</name>
<type>function</type>
<docblock line="397">
<description><![CDATA[Method to simplify retreiving db results for meta-data queries]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="397" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="397" name="param" description="" type="bool" variable="$filtered_index">
<type by_reference="false">bool</type>
</tag>
<tag line="397" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="404">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="404">
<name>$filtered_index</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="433" package="">
<name>num_rows</name>
<type>function</type>
<docblock line="428">
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="428" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="451" package="">
<name>truncate</name>
<type>function</type>
<docblock line="444">
<description><![CDATA[Empty the passed table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="444" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="444" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="451">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="459" package="">
<name>switch_db</name>
<type>function</type>
<docblock line="453">
<description><![CDATA[Connect to a different database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="453" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="453" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="459">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/classes/query_builder.php" hash="2cc609a7a6aec8cccb54daae849d5b0a" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<markers>
<todo line="805">make able to handle operators without spaces</todo>
</markers>
<class final="false" abstract="false" namespace="default" line="23" package="Query\Query">
<name>Query_Builder</name>
<full_name>\Query_Builder</full_name>
<extends/>
<docblock line="16">
<description><![CDATA[Convienience class for creating sql queries - also the class that
instantiates the specific db driver]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Query"/>
</docblock>
<property final="false" static="false" visibility="private" line="34" package="Default">
<name>$select_string</name>
<default><![CDATA[]]></default>
<docblock line="29">
<description><![CDATA[Compiled 'select' clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="29" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="41" package="Default">
<name>$from_string</name>
<default><![CDATA[]]></default>
<docblock line="36">
<description><![CDATA[Compiled 'from' clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="36" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="48" package="Default">
<name>$set_string</name>
<default><![CDATA[]]></default>
<docblock line="43">
<description><![CDATA[Compiled arguments for insert / update]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="43" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="55" package="Default">
<name>$order_string</name>
<default><![CDATA[]]></default>
<docblock line="50">
<description><![CDATA[Order by clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="50" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="62" package="Default">
<name>$group_string</name>
<default><![CDATA[]]></default>
<docblock line="57">
<description><![CDATA[Group by clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="57" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="73" package="Default">
<name>$set_array_keys</name>
<default><![CDATA[]]></default>
<docblock line="68">
<description><![CDATA[Keys for insert/update statement]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="68" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="80" package="Default">
<name>$order_array</name>
<default><![CDATA[]]></default>
<docblock line="75">
<description><![CDATA[Key/val pairs for order by clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="75" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="87" package="Default">
<name>$group_array</name>
<default><![CDATA[]]></default>
<docblock line="82">
<description><![CDATA[Key/val pairs for group by clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="82" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="98" package="Default">
<name>$values</name>
<default><![CDATA[]]></default>
<docblock line="93">
<description><![CDATA[Values to apply to prepared statements]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="93" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="105" package="Default">
<name>$limit</name>
<default><![CDATA[]]></default>
<docblock line="100">
<description><![CDATA[Value for limit string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="100" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="112" package="Default">
<name>$offset</name>
<default><![CDATA[]]></default>
<docblock line="107">
<description><![CDATA[Value for offset in limit string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="107" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="public" line="119" package="Default">
<name>$sql</name>
<default><![CDATA[]]></default>
<docblock line="114">
<description><![CDATA[Alias to $this->db->sql]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="114" name="var" description="" type="\DB_PDO">
<type by_reference="false">\DB_PDO</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="135" package="Default">
<name>$query_map</name>
<default><![CDATA[]]></default>
<docblock line="121">
<description><![CDATA[Query component order mapping
for complex select queries]]></description>
<long-description><![CDATA[<p>Format:</p>
<p>array(
'type' => 'where',
'conjunction' => ' AND ',
'string' => 'k=?'
)</p>]]></long-description>
<tag line="121" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="142" package="Default">
<name>$having_map</name>
<default><![CDATA[]]></default>
<docblock line="137">
<description><![CDATA[Map for having clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="137" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="public" line="149" package="Default">
<name>$conn_name</name>
<default><![CDATA[""]]></default>
<docblock line="144">
<description><![CDATA[Convenience property for connection management]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="144" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="156" package="">
<name>__construct</name>
<type>function</type>
<docblock line="151">
<description><![CDATA[Constructor]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="151" name="param" description="- the connection parametere" type="object" variable="$params">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="156">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="233" package="">
<name>select</name>
<type>function</type>
<docblock line="227">
<description><![CDATA[Specifies rows to select in a query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="227" name="param" description="" type="string" variable="$fields">
<type by_reference="false">string</type>
</tag>
<tag line="227" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="233">
<name>$fields</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="279" package="">
<name>_select</name>
<type>function</type>
<docblock line="272">
<description><![CDATA[Method to simplify select_ methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="272" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="272" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
<tag line="272" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="279">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="279">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="300" package="">
<name>select_max</name>
<type>function</type>
<docblock line="293">
<description><![CDATA[Selects the maximum value of a field from a query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="293" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="293" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
<tag line="293" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="300">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="300">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="316" package="">
<name>select_min</name>
<type>function</type>
<docblock line="309">
<description><![CDATA[Selects the minimum value of a field from a query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="309" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="309" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
<tag line="309" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="316">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="316">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="332" package="">
<name>select_avg</name>
<type>function</type>
<docblock line="325">
<description><![CDATA[Selects the average value of a field from a query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="325" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="325" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
<tag line="325" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="332">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="332">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="348" package="">
<name>select_sum</name>
<type>function</type>
<docblock line="341">
<description><![CDATA[Selects the sum of a field from a query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="341" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="341" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
<tag line="341" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="348">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="348">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="362" package="">
<name>distinct</name>
<type>function</type>
<docblock line="357">
<description><![CDATA[Adds the 'distinct' keyword to a query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="357" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="377" package="">
<name>from</name>
<type>function</type>
<docblock line="371">
<description><![CDATA[Specify the database table to select from]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="371" name="param" description="" type="string" variable="$dbname">
<type by_reference="false">string</type>
</tag>
<tag line="371" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="377">
<name>$dbname</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="406" package="">
<name>_like</name>
<type>function</type>
<docblock line="396">
<description><![CDATA[Simplify 'like' methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="396" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="396" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="396" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
<tag line="396" name="param" description="" type="string" variable="$like">
<type by_reference="false">string</type>
</tag>
<tag line="396" name="param" description="" type="string" variable="$conj">
<type by_reference="false">string</type>
</tag>
<tag line="396" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="406">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="406">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="406">
<name>$pos</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="406">
<name>$like</name>
<default><![CDATA['LIKE']]></default>
<type/>
</argument>
<argument line="406">
<name>$conj</name>
<default><![CDATA['AND']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="448" package="">
<name>like</name>
<type>function</type>
<docblock line="440">
<description><![CDATA[Creates a Like clause in the sql statement]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="440" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="440" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="440" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
<tag line="440" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="448">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="448">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="448">
<name>$pos</name>
<default><![CDATA['both']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="463" package="">
<name>or_like</name>
<type>function</type>
<docblock line="455">
<description><![CDATA[Generates an OR Like clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="455" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="455" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="455" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
<tag line="455" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="463">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="463">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="463">
<name>$pos</name>
<default><![CDATA['both']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="478" package="">
<name>not_like</name>
<type>function</type>
<docblock line="470">
<description><![CDATA[Generates a NOT LIKE clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="470" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="470" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="470" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
<tag line="470" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="478">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="478">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="478">
<name>$pos</name>
<default><![CDATA['both']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="493" package="">
<name>or_not_like</name>
<type>function</type>
<docblock line="485">
<description><![CDATA[Generates a OR NOT LIKE clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="485" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="485" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="485" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
<tag line="485" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="493">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="493">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="493">
<name>$pos</name>
<default><![CDATA['both']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="510" package="">
<name>_having</name>
<type>function</type>
<docblock line="502">
<description><![CDATA[Simplify building having clauses]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="502" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
<tag line="502" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="502" name="param" description="" type="string" variable="$conj">
<type by_reference="false">string</type>
</tag>
<tag line="502" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="510">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="510">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
<argument line="510">
<name>$conj</name>
<default><![CDATA['AND']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="545" package="">
<name>having</name>
<type>function</type>
<docblock line="538">
<description><![CDATA[Generates a 'Having' clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="538" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
<tag line="538" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="538" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="545">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="545">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="559" package="">
<name>or_having</name>
<type>function</type>
<docblock line="552">
<description><![CDATA[Generates a 'Having' clause prefixed with 'OR']]></description>
<long-description><![CDATA[]]></long-description>
<tag line="552" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
<tag line="552" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="552" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="559">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="559">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="575" package="">
<name>_where</name>
<type>function</type>
<docblock line="568">
<description><![CDATA[Do all the repeditive stuff for where/having type methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="568" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
<tag line="568" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="568" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="575">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="575">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="608" package="">
<name>_where_string</name>
<type>function</type>
<docblock line="600">
<description><![CDATA[Simplify generating where string]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="600" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
<tag line="600" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="600" name="param" description="" type="string" variable="$conj">
<type by_reference="false">string</type>
</tag>
<tag line="600" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="608">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="608">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
<argument line="608">
<name>$conj</name>
<default><![CDATA['AND']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="646" package="">
<name>_where_in</name>
<type>function</type>
<docblock line="637">
<description><![CDATA[Simplify where_in methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="637" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
<tag line="637" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="637" name="param" description="string" type="" variable="$in"/>
<tag line="637" name="param" description="string" type="" variable="$conj"/>
<tag line="637" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="646">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="646">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
<argument line="646">
<name>$in</name>
<default><![CDATA['IN']]></default>
<type/>
</argument>
<argument line="646">
<name>$conj</name>
<default><![CDATA['AND']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="678" package="">
<name>where</name>
<type>function</type>
<docblock line="669">
<description><![CDATA[Specify condition(s) in the where clause of a query
Note: this function works with key / value, or a
passed array with key / value pairs]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="669" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
<tag line="669" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="669" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="678">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="678">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="692" package="">
<name>or_where</name>
<type>function</type>
<docblock line="685">
<description><![CDATA[Where clause prefixed with "OR"]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="685" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
<tag line="685" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="685" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="692">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="692">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="706" package="">
<name>where_in</name>
<type>function</type>
<docblock line="699">
<description><![CDATA[Where clause with 'IN' statement]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="699" name="param" description="" type="mixed" variable="$field">
<type by_reference="false">mixed</type>
</tag>
<tag line="699" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="699" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="706">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="706">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="720" package="">
<name>or_where_in</name>
<type>function</type>
<docblock line="713">
<description><![CDATA[Where in statement prefixed with "or"]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="713" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="713" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="713" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="720">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="720">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="734" package="">
<name>where_not_in</name>
<type>function</type>
<docblock line="727">
<description><![CDATA[WHERE NOT IN (FOO) clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="727" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="727" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="727" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="734">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="734">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="748" package="">
<name>or_where_not_in</name>
<type>function</type>
<docblock line="741">
<description><![CDATA[OR WHERE NOT IN (FOO) clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="741" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="741" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="741" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="748">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="748">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="764" package="">
<name>set</name>
<type>function</type>
<docblock line="757">
<description><![CDATA[Sets values for inserts / updates / deletes]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="757" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
<tag line="757" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
<tag line="757" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="764">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="764">
<name>$val</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="803" package="">
<name>join</name>
<type>function</type>
<docblock line="795">
<description><![CDATA[Creates a join phrase in a compiled query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="795" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="795" name="param" description="" type="string" variable="$condition">
<type by_reference="false">string</type>
</tag>
<tag line="795" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
<tag line="795" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="803">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="803">
<name>$condition</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="803">
<name>$type</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="832" package="">
<name>group_by</name>
<type>function</type>
<docblock line="826">
<description><![CDATA[Group the results by the selected field(s)]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="826" name="param" description="" type="mixed" variable="$field">
<type by_reference="false">mixed</type>
</tag>
<tag line="826" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="832">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="857" package="">
<name>order_by</name>
<type>function</type>
<docblock line="850">
<description><![CDATA[Order the results by the selected field(s)]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="850" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
<tag line="850" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
<tag line="850" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="857">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="857">
<name>$type</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="894" package="">
<name>limit</name>
<type>function</type>
<docblock line="887">
<description><![CDATA[Set a limit on the current sql statement]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="887" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="887" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="887" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="894">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="894">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="911" package="">
<name>group_start</name>
<type>function</type>
<docblock line="906">
<description><![CDATA[Adds a paren to the current query for query grouping]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="906" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="930" package="">
<name>or_group_start</name>
<type>function</type>
<docblock line="924">
<description><![CDATA[Adds a paren to the current query for query grouping,
prefixed with 'OR']]></description>
<long-description><![CDATA[]]></long-description>
<tag line="924" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="949" package="">
<name>or_not_group_start</name>
<type>function</type>
<docblock line="943">
<description><![CDATA[Adds a paren to the current query for query grouping,
prefixed with 'OR NOT']]></description>
<long-description><![CDATA[]]></long-description>
<tag line="943" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="967" package="">
<name>group_end</name>
<type>function</type>
<docblock line="962">
<description><![CDATA[Ends a query group]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="962" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="991" package="">
<name>get</name>
<type>function</type>
<docblock line="982">
<description><![CDATA[Select and retrieve all records from the current table, and/or
execute current compiled query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="982" name="param" description="" type="" variable="$table"/>
<tag line="982" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="982" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="982" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="991">
<name>$table</name>
<default><![CDATA['']]></default>
<type/>
</argument>
<argument line="991">
<name>$limit</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
<argument line="991">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1035" package="">
<name>get_where</name>
<type>function</type>
<docblock line="1026">
<description><![CDATA[Convience method for get() with a where clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1026" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="1026" name="param" description="" type="array" variable="$where">
<type by_reference="false">array</type>
</tag>
<tag line="1026" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="1026" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="1026" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="1035">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="1035">
<name>$where</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
<argument line="1035">
<name>$limit</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
<argument line="1035">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1052" package="">
<name>count_all</name>
<type>function</type>
<docblock line="1046">
<description><![CDATA[Retreive the number of rows in the selected table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1046" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="1046" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="1052">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1068" package="">
<name>count_all_results</name>
<type>function</type>
<docblock line="1061">
<description><![CDATA[Retrieve the number of results for the generated query - used
in place of the get() method]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1061" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="1061" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
<argument line="1068">
<name>$table</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1106" package="">
<name>insert</name>
<type>function</type>
<docblock line="1099">
<description><![CDATA[Creates an insert clause, and executes it]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1099" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="1099" name="param" description="" type="mixed" variable="$data">
<type by_reference="false">mixed</type>
</tag>
<tag line="1099" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="1106">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="1106">
<name>$data</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1132" package="">
<name>update</name>
<type>function</type>
<docblock line="1125">
<description><![CDATA[Creates an update clause, and executes it]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1125" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="1125" name="param" description="" type="mixed" variable="$data">
<type by_reference="false">mixed</type>
</tag>
<tag line="1125" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="1132">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="1132">
<name>$data</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1159" package="">
<name>delete</name>
<type>function</type>
<docblock line="1152">
<description><![CDATA[Deletes data from a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1152" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="1152" name="param" description="" type="mixed" variable="$where">
<type by_reference="false">mixed</type>
</tag>
<tag line="1152" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="1159">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="1159">
<name>$where</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1190" package="">
<name>__call</name>
<type>function</type>
<docblock line="1183">
<description><![CDATA[Calls a function further down the inheritence chain]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1183" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="1183" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="1183" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="1190">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="1190">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="1207" package="">
<name>_reset</name>
<type>function</type>
<docblock line="1202">
<description><![CDATA[Clear out the class variables, so the next query can be run]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1202" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="1247" package="">
<name>_compile</name>
<type>function</type>
<docblock line="1240">
<description><![CDATA[String together the sql statements for sending to the db]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="1240" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
<tag line="1240" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="1240" name="return" description="" type="\$string">
<type by_reference="false">\$string</type>
</tag>
</docblock>
<argument line="1247">
<name>$type</name>
<default><![CDATA['']]></default>
<type/>
</argument>
<argument line="1247">
<name>$table</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/classes/db_util.php" hash="1a56d6f40af0e6860d9ae0dbcde8451c" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="true" namespace="default" line="22" package="Query\Query">
<name>DB_Util</name>
<full_name>\DB_Util</full_name>
<extends/>
<docblock line="16">
<description><![CDATA[Abstract class defining database / table creation methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Query"/>
</docblock>
<property final="false" static="false" visibility="private" line="27" package="Default">
<name>$conn</name>
<default><![CDATA[]]></default>
<docblock line="24">
<description><![CDATA[Reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="34" package="">
<name>__construct</name>
<type>function</type>
<docblock line="29">
<description><![CDATA[Save a reference to the connection object for later use]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="29" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="34">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
<name>__call</name>
<type>function</type>
<docblock line="41">
<description><![CDATA[Enable calling driver methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="41" name="param" description="" type="string" variable="$method">
<type by_reference="false">string</type>
</tag>
<tag line="41" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="47">
<name>$method</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="47">
<name>$args</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="71" package="">
<name>create_table</name>
<type>function</type>
<docblock line="61">
<description><![CDATA[Get database-specific sql to create a new table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="61" name="abstract" description=""/>
<tag line="61" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="61" name="param" description="" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
<tag line="61" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
<tag line="61" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
<tag line="61" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="71">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="71">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="71">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
<argument line="71">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="80" package="">
<name>delete_table</name>
<type>function</type>
<docblock line="73">
<description><![CDATA[Get database-specific sql to drop a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="73" name="abstract" description=""/>
<tag line="73" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="73" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="80">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="88" package="">
<name>backup_structure</name>
<type>function</type>
<docblock line="82">
<description><![CDATA[Return an SQL file with the database table structure]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="82" name="abstract" description=""/>
<tag line="82" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="96" package="">
<name>backup_data</name>
<type>function</type>
<docblock line="90">
<description><![CDATA[Return an SQL file with the database data as insert statements]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="90" name="abstract" description=""/>
<tag line="90" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/db/autoload.php" hash="97d18851c6b630eb798cae8da19e1a22" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<constant namespace="default" line="23" package="Default">
<name>QBASE_PATH</name>
<value><![CDATA[dirname(__FILE__).'/']]></value>
<docblock line="20">
<description><![CDATA[Reference to root path]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</constant>
<constant namespace="default" line="28" package="Default">
<name>QDRIVER_PATH</name>
<value><![CDATA[QBASE_PATH.'drivers/']]></value>
<docblock line="25">
<description><![CDATA[Path to driver classes]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</constant>
<function namespace="default" line="39" package="Query">
<name>do_include</name>
<type>function</type>
<docblock line="32">
<description><![CDATA[Bulk directory loading workaround for use
with array_map and glob]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="32" name="param" description="" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
<tag line="32" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="39">
<name>$path</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="50" package="Query">
<name>query_autoload</name>
<type>function</type>
<docblock line="45">
<description><![CDATA[Load a Query class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="45" name="param" description="" type="string" variable="$class">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="50">
<name>$class</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="default" line="90" package="Query">
<name>db_filter</name>
<type>function</type>
<docblock line="83">
<description><![CDATA[Filter out db rows into one array]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="83" name="param" description="" type="array" variable="$array">
<type by_reference="false">array</type>
</tag>
<tag line="83" name="param" description="" type="mixed" variable="$index">
<type by_reference="false">mixed</type>
</tag>
<tag line="83" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="90">
<name>$array</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="90">
<name>$index</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
</file>
<file path="sys/db/drivers/pgsql/pgsql_sql.php" hash="637ace0f653c651090b0521b38687a51" package="Default">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="21" package="Query\Drivers">
<name>PgSQL_SQL</name>
<full_name>\PgSQL_SQL</full_name>
<extends>\DB_SQL</extends>
<docblock line="15">
<description><![CDATA[PostgreSQL specifc SQL]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="15" name="package" description="Query"/>
<tag line="15" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="31" package="">
<name>limit</name>
<type>function</type>
<docblock line="23">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="23" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="23" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="23" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="23" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="31">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="31">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="31">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="50" package="">
<name>random</name>
<type>function</type>
<docblock line="45">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="45" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
<name>db_list</name>
<type>function</type>
<docblock line="57">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="57" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="78" package="">
<name>table_list</name>
<type>function</type>
<docblock line="73">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="73" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="96" package="">
<name>system_table_list</name>
<type>function</type>
<docblock line="91">
<description><![CDATA[Returns sql to list system tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="91" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="114" package="">
<name>view_list</name>
<type>function</type>
<docblock line="109">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="109" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="132" package="">
<name>trigger_list</name>
<type>function</type>
<docblock line="127">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="127" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="149" package="">
<name>function_list</name>
<type>function</type>
<docblock line="144">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="144" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="161" package="">
<name>procedure_list</name>
<type>function</type>
<docblock line="156">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="156" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
<name>sequence_list</name>
<type>function</type>
<docblock line="174">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="174" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="197" package="">
<name>column_list</name>
<type>function</type>
<docblock line="191">
<description><![CDATA[Return sql to list columns of the specified table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="191" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="191" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="197">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="220" package="">
<name>type_list</name>
<type>function</type>
<docblock line="215">
<description><![CDATA[SQL to show list of field types]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="215" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/db/drivers/pgsql/pgsql_util.php" hash="816ab084697ad27d38ec2b93bac0cbc5" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<markers>
<todo line="114">Implement Backup function</todo>
</markers>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>PgSQL_Util</name>
<full_name>\PgSQL_Util</full_name>
<extends>\DB_Util</extends>
<docblock line="16">
<description><![CDATA[Posgres-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
<name>create_table</name>
<type>function</type>
<docblock line="35">
<description><![CDATA[Database-specific method to create a new table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="35" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="35" name="param" description="" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
<tag line="35" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
<tag line="35" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
<tag line="35" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="44">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="44">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="44">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
<argument line="44">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="100" package="">
<name>delete_table</name>
<type>function</type>
<docblock line="94">
<description><![CDATA[Database-specific SQL for dropping a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="94" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="94" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="100">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="112" package="">
<name>backup_structure</name>
<type>function</type>
<docblock line="107">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="107" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="126" package="">
<name>backup_data</name>
<type>function</type>
<docblock line="120">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="120" name="param" description="" type="array" variable="$exclude">
<type by_reference="false">array</type>
</tag>
<tag line="120" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="126">
<name>$exclude</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/pgsql/pgsql_driver.php" hash="6cbbd383739c820989af52047834617e" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<markers>
<todo line="46">Implement</todo>
</markers>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>PgSQL</name>
<full_name>\PgSQL</full_name>
<extends>\DB_PDO</extends>
<docblock line="16">
<description><![CDATA[PostgreSQL specifc class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Connect to a PosgreSQL database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
<tag line="24" name="param" description="" type="string" variable="$username">
<type by_reference="false">string</type>
</tag>
<tag line="24" name="param" description="" type="string" variable="$password">
<type by_reference="false">string</type>
</tag>
<tag line="24" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="32">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$username</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
<argument line="32">
<name>$password</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
<argument line="32">
<name>$options</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
<name>switch_db</name>
<type>function</type>
<docblock line="39">
<description><![CDATA[Connect to a different database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="39" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="44">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="57" package="">
<name>truncate</name>
<type>function</type>
<docblock line="52">
<description><![CDATA[Empty a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="52" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="57">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="70" package="">
<name>get_schemas</name>
<type>function</type>
<docblock line="65">
<description><![CDATA[Get a list of schemas for the current connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="65" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/db/drivers/odbc/odbc_util.php" hash="e3254c43700cf53c79566c0590e5ca29" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>ODBC_Util</name>
<full_name>\ODBC_Util</full_name>
<extends>\DB_Util</extends>
<docblock line="16">
<description><![CDATA[ODBC-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="46" package="">
<name>create_table</name>
<type>function</type>
<docblock line="37">
<description><![CDATA[Database-specific method to create a new table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="37" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="46">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="46">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="46">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
<argument line="46">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="60" package="">
<name>delete_table</name>
<type>function</type>
<docblock line="54">
<description><![CDATA[Remove a table from the database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="54" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="54" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="60">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="72" package="">
<name>backup_structure</name>
<type>function</type>
<docblock line="67">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="67" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="85" package="">
<name>backup_data</name>
<type>function</type>
<docblock line="80">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="80" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/db/drivers/odbc/odbc_sql.php" hash="ce667d48c43316e23bafb10a23b9353d" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>ODBC_SQL</name>
<full_name>\ODBC_SQL</full_name>
<extends>\DB_SQL</extends>
<docblock line="16">
<description><![CDATA[ODBC SQL Class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>limit</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="24" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="32">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
<name>random</name>
<type>function</type>
<docblock line="39">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="39" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
<name>db_list</name>
<type>function</type>
<docblock line="51">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="51" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
<name>table_list</name>
<type>function</type>
<docblock line="63">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="63" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="80" package="">
<name>system_table_list</name>
<type>function</type>
<docblock line="75">
<description><![CDATA[Returns sql to list system tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="75" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="92" package="">
<name>view_list</name>
<type>function</type>
<docblock line="87">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="87" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="104" package="">
<name>trigger_list</name>
<type>function</type>
<docblock line="99">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="99" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
<name>function_list</name>
<type>function</type>
<docblock line="111">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="111" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
<name>procedure_list</name>
<type>function</type>
<docblock line="123">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="123" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="140" package="">
<name>sequence_list</name>
<type>function</type>
<docblock line="135">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="135" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="152" package="">
<name>type_list</name>
<type>function</type>
<docblock line="147">
<description><![CDATA[SQL to show list of field types]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="147" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="165" package="">
<name>column_list</name>
<type>function</type>
<docblock line="159">
<description><![CDATA[SQL to show infromation about columns in a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="159" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="159" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
<argument line="165">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/odbc/odbc_driver.php" hash="345f3b133f34abb5ffaa785e058b1178" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="24" package="Query\Drivers">
<name>ODBC</name>
<full_name>\ODBC</full_name>
<extends>\DB_PDO</extends>
<docblock line="16">
<description><![CDATA[ODBC Database Driver]]></description>
<long-description><![CDATA[<p>For general database access for databases not specified by the main drivers</p>]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<property final="false" static="false" visibility="protected" line="29" package="Default">
<name>$escape_char</name>
<default><![CDATA['']]></default>
<docblock line="26">
<description><![CDATA[Don't define the escape char - or define it in sub-drivers in a refactor]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
<name>__construct</name>
<type>function</type>
<docblock line="31">
<description><![CDATA[Use ODBC to connect to a database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="31" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
<tag line="31" name="param" description="" type="string" variable="$username">
<type by_reference="false">string</type>
</tag>
<tag line="31" name="param" description="" type="string" variable="$password">
<type by_reference="false">string</type>
</tag>
<tag line="31" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="39">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="39">
<name>$username</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
<argument line="39">
<name>$password</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
<argument line="39">
<name>$options</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
<name>switch_db</name>
<type>function</type>
<docblock line="46">
<description><![CDATA[Doesn't apply to ODBC]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="46" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="46" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="52">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="65" package="">
<name>truncate</name>
<type>function</type>
<docblock line="59">
<description><![CDATA[Empty the current database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="59" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="59" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="65">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/mysql/mysql_util.php" hash="1a1574382ec8d888d096a55d5ebb613b" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>MySQL_Util</name>
<full_name>\MySQL_Util</full_name>
<extends>\DB_Util</extends>
<docblock line="16">
<description><![CDATA[MySQL-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
<name>create_table</name>
<type>function</type>
<docblock line="37">
<description><![CDATA[Convienience public function for creating a new MySQL table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="37" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="47">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="47">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="47">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
<argument line="47">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="113" package="">
<name>delete_table</name>
<type>function</type>
<docblock line="107">
<description><![CDATA[Convience public function for droping a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="107" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="107" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="113">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="125" package="">
<name>backup_structure</name>
<type>function</type>
<docblock line="120">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="120" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="161" package="">
<name>backup_data</name>
<type>function</type>
<docblock line="155">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="155" name="param" description="" type="array" variable="$exclude">
<type by_reference="false">array</type>
</tag>
<tag line="155" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="161">
<name>$exclude</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/mysql/mysql_driver.php" hash="b86b87f0278035fcd5ea4b7c40891a89" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<markers>
<todo line="57">Implement</todo>
</markers>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>MySQL</name>
<full_name>\MySQL</full_name>
<extends>\DB_PDO</extends>
<docblock line="16">
<description><![CDATA[MySQL specific class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<property final="false" static="false" visibility="protected" line="29" package="Default">
<name>$escape_char</name>
<default><![CDATA['`']]></default>
<docblock line="24">
<description><![CDATA[Set the backtick as the MySQL escape character]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
<name>__construct</name>
<type>function</type>
<docblock line="31">
<description><![CDATA[Connect to MySQL Database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="31" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
<tag line="31" name="param" description="" type="string" variable="$username">
<type by_reference="false">string</type>
</tag>
<tag line="31" name="param" description="" type="string" variable="$password">
<type by_reference="false">string</type>
</tag>
<tag line="31" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
</docblock>
<argument line="39">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="39">
<name>$username</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
<argument line="39">
<name>$password</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
<argument line="39">
<name>$options</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="55" package="">
<name>switch_db</name>
<type>function</type>
<docblock line="50">
<description><![CDATA[Connect to a different database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="50" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="55">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
<name>truncate</name>
<type>function</type>
<docblock line="63">
<description><![CDATA[Empty a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="63" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="68">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/mysql/mysql_sql.php" hash="a9adb838d5b3f69f076199d198a54d73" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>MySQL_SQL</name>
<full_name>\MySQL_SQL</full_name>
<extends>\DB_SQL</extends>
<docblock line="16">
<description><![CDATA[MySQL specifc SQL]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>limit</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="24" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="32">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
<name>random</name>
<type>function</type>
<docblock line="44">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="44" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
<name>db_list</name>
<type>function</type>
<docblock line="56">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="56" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="74" package="">
<name>table_list</name>
<type>function</type>
<docblock line="68">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="68" name="param" description="" type="string" variable="$database">
<type by_reference="false">string</type>
</tag>
<tag line="68" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="74">
<name>$database</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
<name>system_table_list</name>
<type>function</type>
<docblock line="85">
<description><![CDATA[Overridden in MySQL class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="85" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="103" package="">
<name>view_list</name>
<type>function</type>
<docblock line="98">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="98" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>trigger_list</name>
<type>function</type>
<docblock line="110">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="110" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="127" package="">
<name>function_list</name>
<type>function</type>
<docblock line="122">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="122" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="139" package="">
<name>procedure_list</name>
<type>function</type>
<docblock line="134">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="134" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="151" package="">
<name>sequence_list</name>
<type>function</type>
<docblock line="146">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="146" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="163" package="">
<name>type_list</name>
<type>function</type>
<docblock line="158">
<description><![CDATA[SQL to show list of field types]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="158" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="176" package="">
<name>column_list</name>
<type>function</type>
<docblock line="170">
<description><![CDATA[SQL to show infromation about columns in a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="170" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="170" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="176">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/sqlite/sqlite_util.php" hash="18cd637365896dd9cf94066e517cdaa8" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>SQLite_Util</name>
<full_name>\SQLite_Util</full_name>
<extends>\DB_Util</extends>
<docblock line="16">
<description><![CDATA[SQLite-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="46" package="">
<name>create_table</name>
<type>function</type>
<docblock line="37">
<description><![CDATA[Convenience public function to create a new table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="37" name="param" description="//Name of the table" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="37" name="param" description="//columns as straight array and/or column =&gt; type pairs" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="param" description="// column =&gt; constraint pairs" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="param" description="// column =&gt; index pairs" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="46">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="46">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="46">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
<argument line="46">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
<name>delete_table</name>
<type>function</type>
<docblock line="96">
<description><![CDATA[SQL to drop the specified table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="96" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="96" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="102">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>backup_data</name>
<type>function</type>
<docblock line="109">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="109" name="param" description="" type="array" variable="$excluded">
<type by_reference="false">array</type>
</tag>
<tag line="109" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="115">
<name>$excluded</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
<name>backup_structure</name>
<type>function</type>
<docblock line="174">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="174" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/db/drivers/sqlite/sqlite_driver.php" hash="d32d8a174c1770f558b6810f47ea8869" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>SQLite</name>
<full_name>\SQLite</full_name>
<extends>\DB_PDO</extends>
<docblock line="16">
<description><![CDATA[SQLite specific class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<property final="false" static="false" visibility="protected" line="29" package="Default">
<name>$statement</name>
<default><![CDATA[]]></default>
<docblock line="24">
<description><![CDATA[Reference to the last executed sql query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="var" description="" type="\PDOStatement">
<type by_reference="false">\PDOStatement</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="38" package="">
<name>__construct</name>
<type>function</type>
<docblock line="31">
<description><![CDATA[Open SQLite Database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="31" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
<tag line="31" name="param" description="" type="string" variable="$user">
<type by_reference="false">string</type>
</tag>
<tag line="31" name="param" description="" type="string" variable="$pass">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="38">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="38">
<name>$user</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="38">
<name>$pass</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="51" package="">
<name>switch_db</name>
<type>function</type>
<docblock line="46">
<description><![CDATA[Doesn't apply to sqlite]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="46" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="51">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="63" package="">
<name>truncate</name>
<type>function</type>
<docblock line="58">
<description><![CDATA[Empty a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="58" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="63">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
<name>get_tables</name>
<type>function</type>
<docblock line="76">
<description><![CDATA[List tables for the current database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="76" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
<name>get_system_tables</name>
<type>function</type>
<docblock line="97">
<description><![CDATA[List system tables for the current database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="97" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="117" package="">
<name>load_database</name>
<type>function</type>
<docblock line="111">
<description><![CDATA[Load a database for the current connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="111" name="param" description="" type="string" variable="$db">
<type by_reference="false">string</type>
</tag>
<tag line="111" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="117">
<name>$db</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="117">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
<name>unload_database</name>
<type>function</type>
<docblock line="125">
<description><![CDATA[Unload a database from the current connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="125" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="130">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/sqlite/sqlite_sql.php" hash="dbd517cd93d82fdac7c3d545f40fc74c" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>SQLite_SQL</name>
<full_name>\SQLite_SQL</full_name>
<extends>\DB_SQL</extends>
<docblock line="16">
<description><![CDATA[SQLite Specific SQL]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>limit</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="24" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="32">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
<name>random</name>
<type>function</type>
<docblock line="44">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="44" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
<name>db_list</name>
<type>function</type>
<docblock line="56">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="56" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
<name>table_list</name>
<type>function</type>
<docblock line="68">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="68" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
<name>system_table_list</name>
<type>function</type>
<docblock line="85">
<description><![CDATA[Overridden in SQLite class]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="85" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
<name>view_list</name>
<type>function</type>
<docblock line="97">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="97" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
<name>trigger_list</name>
<type>function</type>
<docblock line="111">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="111" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
<name>function_list</name>
<type>function</type>
<docblock line="123">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="123" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="140" package="">
<name>procedure_list</name>
<type>function</type>
<docblock line="135">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="135" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="152" package="">
<name>sequence_list</name>
<type>function</type>
<docblock line="147">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="147" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="164" package="">
<name>type_list</name>
<type>function</type>
<docblock line="159">
<description><![CDATA[SQL to show list of field types]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="159" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="177" package="">
<name>column_list</name>
<type>function</type>
<docblock line="171">
<description><![CDATA[SQL to show infromation about columns in a table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="171" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="171" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="177">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/firebird/firebird_sql.php" hash="dc695a690f4e2fa8a8748156b04091bb" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>Firebird_SQL</name>
<full_name>\Firebird_SQL</full_name>
<extends>\DB_SQL</extends>
<docblock line="16">
<description><![CDATA[Firebird Specific SQL]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>limit</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="24" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="32">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="32">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
<name>random</name>
<type>function</type>
<docblock line="51">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="51" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
<name>db_list</name>
<type>function</type>
<docblock line="64">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="64" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
<name>table_list</name>
<type>function</type>
<docblock line="76">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="76" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="98" package="">
<name>system_table_list</name>
<type>function</type>
<docblock line="93">
<description><![CDATA[Returns sql to list system tables]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="93" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>view_list</name>
<type>function</type>
<docblock line="110">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="110" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
<name>trigger_list</name>
<type>function</type>
<docblock line="125">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="125" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="145" package="">
<name>function_list</name>
<type>function</type>
<docblock line="140">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="140" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="157" package="">
<name>procedure_list</name>
<type>function</type>
<docblock line="152">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="152" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="185" package="">
<name>sequence_list</name>
<type>function</type>
<docblock line="180">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="180" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="202" package="">
<name>column_list</name>
<type>function</type>
<docblock line="196">
<description><![CDATA[Return sql to list columns of the specified table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="196" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="196" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="202">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="248" package="">
<name>type_list</name>
<type>function</type>
<docblock line="243">
<description><![CDATA[SQL to show list of field types]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="243" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/db/drivers/firebird/firebird_result.php" hash="d713425d6dc82a16618de449f0ef39f9" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="23" package="Query\Drivers">
<name>Firebird_Result</name>
<full_name>\Firebird_Result</full_name>
<extends>\PDOStatement</extends>
<docblock line="16">
<description><![CDATA[Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<property final="false" static="false" visibility="private" line="30" package="Default">
<name>$statement</name>
<default><![CDATA[]]></default>
<docblock line="25">
<description><![CDATA[Reference to fbird resource]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="25" name="var" description="" type="resource">
<type by_reference="false">resource</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="37" package="Default">
<name>$row</name>
<default><![CDATA[]]></default>
<docblock line="32">
<description><![CDATA[Current row in result array]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="32" name="var" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="private" line="44" package="Default">
<name>$result</name>
<default><![CDATA[array()]]></default>
<docblock line="39">
<description><![CDATA[Data pulled from query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="39" name="param" description="mixed" type="" variable=""/>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
<name>__construct</name>
<type>function</type>
<docblock line="46">
<description><![CDATA[Create the object by passing the resource for
the query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="46" name="param" description="" type="resource" variable="$link">
<type by_reference="false">resource</type>
</tag>
</docblock>
<argument line="52">
<name>$link</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="83" package="">
<name>bindColumn</name>
<type>function</type>
<docblock line="73">
<description><![CDATA[Invalidate method for data consistency]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="73" name="param" description="" type="mixed" variable="$column">
<type by_reference="false">mixed</type>
</tag>
<tag line="73" name="param" description="&amp;$param" type="mixed" variable="$param">
<type by_reference="false">mixed</type>
</tag>
<tag line="73" name="param" description="" type="int" variable="$type">
<type by_reference="false">int</type>
</tag>
<tag line="73" name="param" description="" type="mixed" variable="$maxlen">
<type by_reference="false">mixed</type>
</tag>
<tag line="73" name="param" description="" type="array" variable="$driverdata">
<type by_reference="false">array</type>
</tag>
<tag line="73" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
<argument line="83">
<name>$column</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="83">
<name>$param</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="83">
<name>$type</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="83">
<name>$maxlen</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="83">
<name>$driverdata</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="100" package="">
<name>bindParam</name>
<type>function</type>
<docblock line="90">
<description><![CDATA[Invalidate method for data consistency]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="90" name="param" description="" type="mixed" variable="$parameter">
<type by_reference="false">mixed</type>
</tag>
<tag line="90" name="param" description="&amp;$variable" type="mixed" variable="$variable">
<type by_reference="false">mixed</type>
</tag>
<tag line="90" name="param" description="" type="int" variable="$data_type">
<type by_reference="false">int</type>
</tag>
<tag line="90" name="param" description="" type="mixed" variable="$maxlen">
<type by_reference="false">mixed</type>
</tag>
<tag line="90" name="param" description="" type="array" variable="$driverdata">
<type by_reference="false">array</type>
</tag>
<tag line="90" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
<argument line="100">
<name>$parameter</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="100">
<name>$variable</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="100">
<name>$data_type</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="100">
<name>$maxlen</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="100">
<name>$driverdata</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>bindValue</name>
<type>function</type>
<docblock line="107">
<description><![CDATA[Invalidate method for data consistency]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="107" name="param" description="" type="mixed" variable="$parameter">
<type by_reference="false">mixed</type>
</tag>
<tag line="107" name="param" description="&amp;$variable" type="mixed" variable="$variable">
<type by_reference="false">mixed</type>
</tag>
<tag line="107" name="param" description="" type="int" variable="$data_type">
<type by_reference="false">int</type>
</tag>
<tag line="107" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
<argument line="115">
<name>$parameter</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="115">
<name>$variable</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="115">
<name>$data_type</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
<name>execute</name>
<type>function</type>
<docblock line="122">
<description><![CDATA[Run a prepared statement query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="122" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
<tag line="122" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="128">
<name>$args</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="151" package="">
<name>fetch</name>
<type>function</type>
<docblock line="143">
<description><![CDATA[Emulate PDO fetch public function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="143" name="param" description="" type="int" variable="$fetch_style">
<type by_reference="false">int</type>
</tag>
<tag line="143" name="param" description="" type="mixed" variable="$statement">
<type by_reference="false">mixed</type>
</tag>
<tag line="143" name="param" description="" type="mixed" variable="$offset">
<type by_reference="false">mixed</type>
</tag>
<tag line="143" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="151">
<name>$fetch_style</name>
<default><![CDATA[PDO::FETCH_ASSOC]]></default>
<type/>
</argument>
<argument line="151">
<name>$statement</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="151">
<name>$offset</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="201" package="">
<name>fetchAll</name>
<type>function</type>
<docblock line="193">
<description><![CDATA[Emulate PDO fetchAll public function]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="193" name="param" description="" type="int" variable="$fetch_style">
<type by_reference="false">int</type>
</tag>
<tag line="193" name="param" description="" type="mixed" variable="$statement">
<type by_reference="false">mixed</type>
</tag>
<tag line="193" name="param" description="" type="mixed" variable="$ctor_args">
<type by_reference="false">mixed</type>
</tag>
<tag line="193" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="201">
<name>$fetch_style</name>
<default><![CDATA[PDO::FETCH_ASSOC]]></default>
<type/>
</argument>
<argument line="201">
<name>$statement</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
<argument line="201">
<name>$ctor_args</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="223" package="">
<name>fetchColumn</name>
<type>function</type>
<docblock line="217">
<description><![CDATA[Emulate PDOStatement::fetchColumn]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="217" name="param" description="" type="int" variable="$column_num">
<type by_reference="false">int</type>
</tag>
<tag line="217" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
<argument line="223">
<name>$column_num</name>
<default><![CDATA[0]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="238" package="">
<name>fetchObject</name>
<type>function</type>
<docblock line="231">
<description><![CDATA[Emulate PDOStatement::fetchObject, but only for the default use]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="231" name="param" description="" type="string" variable="$class_name">
<type by_reference="false">string</type>
</tag>
<tag line="231" name="param" description="" type="array" variable="$ctor_args">
<type by_reference="false">array</type>
</tag>
<tag line="231" name="return" description="" type="\stdClass">
<type by_reference="false">\stdClass</type>
</tag>
</docblock>
<argument line="238">
<name>$class_name</name>
<default><![CDATA['stdClass']]></default>
<type/>
</argument>
<argument line="238">
<name>$ctor_args</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="250" package="">
<name>rowCount</name>
<type>function</type>
<docblock line="245">
<description><![CDATA[Return the number of rows affected by the previous query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="245" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="270" package="">
<name>errorCode</name>
<type>function</type>
<docblock line="265">
<description><![CDATA[Method to emulate PDOStatement->errorCode]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="265" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="282" package="">
<name>errorInfo</name>
<type>function</type>
<docblock line="277">
<description><![CDATA[Method to emulate PDO->errorInfo / PDOStatement->errorInfo]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="277" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="sys/db/drivers/firebird/firebird_driver.php" hash="4f7e9df014cc1df6b92f09f815b9837d" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<class final="false" abstract="false" namespace="default" line="24" package="Query\Drivers">
<name>Firebird</name>
<full_name>\Firebird</full_name>
<extends>\DB_PDO</extends>
<docblock line="16">
<description><![CDATA[Firebird Database class]]></description>
<long-description><![CDATA[<p>PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.</p>]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<property final="false" static="false" visibility="protected" line="31" package="Default">
<name>$statement</name>
<default><![CDATA[]]></default>
<docblock line="26">
<description><![CDATA[Reference to the last query executed]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="26" name="var" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="39" package="Default">
<name>$statement_link</name>
<default><![CDATA[]]></default>
<docblock line="33">
<description><![CDATA[Reference to the resource returned by
the last query executed]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="33" name="var" description="" type="resource">
<type by_reference="false">resource</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="46" package="Default">
<name>$trans</name>
<default><![CDATA[]]></default>
<docblock line="41">
<description><![CDATA[Reference to the current transaction]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="41" name="var" description="" type="resource">
<type by_reference="false">resource</type>
</tag>
</docblock>
</property>
<property final="false" static="false" visibility="protected" line="53" package="Default">
<name>$conn</name>
<default><![CDATA[]]></default>
<docblock line="48">
<description><![CDATA[Reference to the connection resource]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="48" name="var" description="" type="resource">
<type by_reference="false">resource</type>
</tag>
</docblock>
</property>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
<name>__construct</name>
<type>function</type>
<docblock line="55">
<description><![CDATA[Open the link to the database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="55" name="param" description="" type="string" variable="$dbpath">
<type by_reference="false">string</type>
</tag>
<tag line="55" name="param" description="" type="string" variable="$user">
<type by_reference="false">string</type>
</tag>
<tag line="55" name="param" description="" type="string" variable="$pass">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="62">
<name>$dbpath</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="62">
<name>$user</name>
<default><![CDATA['sysdba']]></default>
<type/>
</argument>
<argument line="62">
<name>$pass</name>
<default><![CDATA['masterkey']]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="95" package="">
<name>switch_db</name>
<type>function</type>
<docblock line="89">
<description><![CDATA[Doesn't apply to Firebird]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="89" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="89" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
<argument line="95">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="107" package="">
<name>truncate</name>
<type>function</type>
<docblock line="102">
<description><![CDATA[Empty a database table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="102" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="107">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="122" package="">
<name>query</name>
<type>function</type>
<docblock line="116">
<description><![CDATA[Wrapper public function to better match PDO]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="116" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="116" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="122">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="148" package="">
<name>prepare</name>
<type>function</type>
<docblock line="141">
<description><![CDATA[Emulate PDO prepare]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="141" name="param" description="" type="string" variable="$query">
<type by_reference="false">string</type>
</tag>
<tag line="141" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
<tag line="141" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
<argument line="148">
<name>$query</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="148">
<name>$options</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="170" package="">
<name>beginTransaction</name>
<type>function</type>
<docblock line="165">
<description><![CDATA[Start a database transaction]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="165" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="187" package="">
<name>commit</name>
<type>function</type>
<docblock line="182">
<description><![CDATA[Commit a database transaction]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="182" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="199" package="">
<name>rollBack</name>
<type>function</type>
<docblock line="194">
<description><![CDATA[Rollback a transaction]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="194" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="213" package="">
<name>prepare_execute</name>
<type>function</type>
<docblock line="206">
<description><![CDATA[Prepare and execute a query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="206" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="206" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
<tag line="206" name="return" description="" type="resource">
<type by_reference="false">resource</type>
</tag>
</docblock>
<argument line="213">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="213">
<name>$args</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="232" package="">
<name>quote</name>
<type>function</type>
<docblock line="225">
<description><![CDATA[Method to emulate PDO->quote]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="225" name="param" description="" type="string" variable="$str">
<type by_reference="false">string</type>
</tag>
<tag line="225" name="param" description="" type="int" variable="$param_type">
<type by_reference="false">int</type>
</tag>
<tag line="225" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="232">
<name>$str</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="232">
<name>$param_type</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="249" package="">
<name>errorInfo</name>
<type>function</type>
<docblock line="244">
<description><![CDATA[Method to emulate PDO->errorInfo / PDOStatement->errorInfo]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="244" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="264" package="">
<name>errorCode</name>
<type>function</type>
<docblock line="259">
<description><![CDATA[Method to emulate PDO->errorCode]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="259" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="278" package="">
<name>prepare_query</name>
<type>function</type>
<docblock line="271">
<description><![CDATA[Bind a prepared query with arguments for executing]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="271" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
<tag line="271" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
<tag line="271" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
<argument line="278">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="278">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/db/drivers/firebird/firebird_util.php" hash="a3d7c263c45909cc13e414913fcb9b68" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
<tag line="2" name="package" description="Query"/>
<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/Query" link="https://github.com/aviat4ion/Query"/>
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
</docblock>
<markers>
<todo line="117">Implement Backup structure function</todo>
</markers>
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>Firebird_Util</name>
<full_name>\Firebird_Util</full_name>
<extends>\DB_Util</extends>
<docblock line="16">
<description><![CDATA[Firebird-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
<name>create_table</name>
<type>function</type>
<docblock line="37">
<description><![CDATA[Convienience public function to generate sql for creating a db table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="37" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$fields">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
<tag line="37" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="47">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="47">
<name>$fields</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<argument line="47">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
<argument line="47">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="103" package="">
<name>delete_table</name>
<type>function</type>
<docblock line="97">
<description><![CDATA[Drop the selected table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="97" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="97" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="103">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>backup_structure</name>
<type>function</type>
<docblock line="110">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="110" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
<name>backup_data</name>
<type>function</type>
<docblock line="123">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="123" name="param" description="" type="array" variable="$exclude">
<type by_reference="false">array</type>
</tag>
<tag line="123" name="param" description="" type="bool" variable="$system_tables">
<type by_reference="false">bool</type>
</tag>
<tag line="123" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="130">
<name>$exclude</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
<argument line="130">
<name>$system_tables</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/common/db_reg.php" hash="6046533d53604ee733dad12fb74ef419" 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="OpenSQLManager\Common">
<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="OpenSQLManager"/>
<tag line="18" name="subpackage" description="Common"/>
</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="d3240cb9e4ebc4ed3d2d8f558b1ff234" 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\Common">
<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="OpenSQLManager"/>
<tag line="18" name="subpackage" description="Common"/>
</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="223" package="">
<name>remove_db</name>
<type>function</type>
<docblock line="218">
<description><![CDATA[Remove a database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="218" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
<argument line="223">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="244" package="">
<name>get_dbs</name>
<type>function</type>
<docblock line="239">
<description><![CDATA[Retreive all db connections]]></description>
<long-description><![CDATA[]]></long-description>
<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="257" package="">
<name>get_db</name>
<type>function</type>
<docblock line="251">
<description><![CDATA[Retreive a specific database connection]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="251" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="251" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="257">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/common/functions.php" hash="d7bc8d7859bb49857803000bbf882664" 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="31" package="OpenSQLManager">
<name>array_to_object</name>
<type>function</type>
<docblock line="25">
<description><![CDATA[Convert an array to an object]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="25" name="param" description="" type="array" variable="$array">
<type by_reference="false">array</type>
</tag>
<tag line="25" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
<argument line="31">
<name>$array</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="OpenSQLManager" line="56" package="OpenSQLManager">
<name>alert</name>
<type>function</type>
<docblock line="50">
<description><![CDATA[Create info dialog to return an informational message]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="50" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="50" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="56">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="OpenSQLManager" line="69" package="OpenSQLManager">
<name>error</name>
<type>function</type>
<docblock line="63">
<description><![CDATA[Create info dialog to retun an informational message]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="63" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="63" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="69">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
<function namespace="OpenSQLManager" line="82" package="OpenSQLManager">
<name>confirm</name>
<type>function</type>
<docblock line="76">
<description><![CDATA[Creates a binary confirmation dialog]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="76" name="param" description="" type="string" variable="$message">
<type by_reference="false">string</type>
</tag>
<tag line="76" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
<argument line="82">
<name>$message</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
</file>
<file path="sys/widgets/connection_sidebar.php" hash="42a8bd9fc041e2cca52976ee298704c1" 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>BTN_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="125" package="">
<name>menu</name>
<type>function</type>
<docblock line="119">
<description><![CDATA[Right-click event to create context menu]]></description>
<long-description><![CDATA[]]></long-description>
<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="125">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="150" package="">
<name>menu_event</name>
<type>function</type>
<docblock line="144">
<description><![CDATA[Handler for context menu options]]></description>
<long-description><![CDATA[]]></long-description>
<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="150">
<name>$event</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="OpenSQLManager" line="163" package="">
<name>add_conn</name>
<type>function</type>
<docblock line="157">
<description><![CDATA[Handles an event for adding a connection]]></description>
<long-description><![CDATA[]]></long-description>
<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="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">
<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="73a75d4b737a59585b2d2c2b67c83e09" 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>
<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="37">
<description><![CDATA[Array of fields for Connection Information manipulation]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="37" name="var" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</property>
<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="51">
<description><![CDATA[Create the window]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="51" name="param" description="wxWindow" type="" variable="$parent"/>
<tag line="51" name="param" description="mixed" type="" variable="$params"/>
</docblock>
<argument line="57">
<name>$parent</name>
<default><![CDATA[]]></default>
<type/>
</argument>
<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="75" package="">
<name>_layout</name>
<type>function</type>
<docblock line="70">
<description><![CDATA[Layout fields on the form]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="70" name="param" description="array" type="" variable="$params"/>
</docblock>
<argument line="75">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="protected" namespace="OpenSQLManager" line="156" package="">
<name>get_available_dbs</name>
<type>function</type>
<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="297" package="">
<name>test_conn</name>
<type>function</type>
<docblock line="292">
<description><![CDATA[Test a db connection, and display a popup with the result]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="292" 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="335" package="">
<name>_get_vals</name>
<type>function</type>
<docblock line="330">
<description><![CDATA[Get the values of the widgets in the window]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="330" 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="365" package="">
<name>_hide</name>
<type>function</type>
<docblock line="360">
<description><![CDATA[Hides a list of elements]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="360" name="param" description="array" type="" variable="$ctrls"/>
</docblock>
<argument line="365">
<name>$ctrls</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="private" namespace="OpenSQLManager" line="384" package="">
<name>_show</name>
<type>function</type>
<docblock line="379">
<description><![CDATA[Shows a list of elements]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="379" name="param" description="array" type="" variable="$ctrls"/>
</docblock>
<argument line="384">
<name>$ctrls</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="sys/windows/main.php" hash="1fdbfc6076c09bf59b728d7dac4d839b" 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="154" package="">
<name>_create_menu</name>
<type>function</type>
<docblock line="149">
<description><![CDATA[Create the menu for the program]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="149" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
</method>
</class>
</file>
<package name="" full_name=""/>
<package name="Default" full_name="Default"/>
<package name="OpenSQLManager" full_name="OpenSQLManager">
<package name="Common" full_name="OpenSQLManager\Common"/>
<package name="Widgets" full_name="OpenSQLManager\Widgets"/>
<package name="Windows" full_name="OpenSQLManager\Windows"/>
</package>
<package name="Query" full_name="Query">
<package name="Drivers" full_name="Query\Drivers"/>
<package name="Query" full_name="Query\Query"/>
</package>
<namespace name="OpenSQLManager" full_name="OpenSQLManager"/>
<namespace name="default" full_name="default"/>
<marker count="5">todo</marker>
<marker count="0">fixme</marker>
<deprecated count="0"/>
</project>
Reference in New Issue View Git Blame Copy Permalink