Query/docs/structure.xml

4972 lines
220 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a2" title="Query">
<file path="classes/db_reg.php" hash="4db07479d2dfdd5a403c7ffae83ceb23" 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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="false" namespace="default" line="24" package="Query\Helper Classes">
<name>DB_Reg</name>
<full_name>\DB_Reg</full_name>
<extends/>
<docblock line="15">
<description><![CDATA[Connection registry]]></description>
<long-description><![CDATA[<p>Decouples the Settings class from the query builder
and organizes database connections</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="15" name="package" description="Query"/>
<tag line="15" name="subpackage" description="Helper Classes"/>
</docblock>
2012-04-20 13:17:39 -04:00
<property final="false" static="true" visibility="private" line="29" package="Default">
<name>$instance</name>
<default><![CDATA[array()]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="26">
<description><![CDATA[Static array of connections]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="37" package="">
<name>get_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="31">
<description><![CDATA[Registry access method]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="31" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="37">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="55" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="50">
<description><![CDATA[Private constructor]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="50" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="55">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="71" package="">
<name>get_connections</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="66">
<description><![CDATA[Return exiting connections]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="66" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="84" package="">
<name>remove_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="78">
<description><![CDATA[Remove a database connection]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="78" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="78" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="84">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="classes/settings.php" hash="69d30a582c8ec7f2a29151aab896ce1e" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="false" namespace="default" line="22" package="Query\Helper Classes">
<name>Settings</name>
<full_name>\Settings</full_name>
<extends/>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[Class for manipulating datbase connections, and miscellaneous settings]]></description>
2012-04-20 13:17:39 -04:00
<long-description><![CDATA[]]></long-description>
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Helper Classes"/>
</docblock>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="27" package="Default">
<name>$current</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Settings object represented by the currently loaded JSON file]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="true" visibility="private" line="32" package="Default">
<name>$instance</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="29">
<description><![CDATA[Singleton instance]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="40" package="">
<name>get_instance</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="34">
<description><![CDATA[Static method to retreive current instance
of the singleton]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="34" name="return" description="" type="\Settings">
<type by_reference="false">\Settings</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="55" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="51">
<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>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
<name>__destruct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="87">
<description><![CDATA[Output the settings on destruct]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="107" package="">
<name>__get</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="101">
<description><![CDATA[Magic method to simplify isset checking for config options]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="101" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="101" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="107">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="122" package="">
<name>__set</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="116">
<description><![CDATA[Magic method to simplify setting config options]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="116" name="param" description="" type="string" variable="$key">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="116" name="param" description="mixed" type="" variable="$val"/>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="122">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="122">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="141" package="">
<name>add_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="135">
<description><![CDATA[Add a database connection]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="135" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="135" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="141">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="141">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="173" package="">
<name>edit_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="167">
<description><![CDATA[Edit a database connection]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="167" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="167" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="173">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="173">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="216" package="">
<name>remove_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="211">
<description><![CDATA[Remove a database connection]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="211" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="216">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="237" package="">
<name>get_dbs</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="232">
<description><![CDATA[Retreive all db connections]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="232" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="250" package="">
<name>get_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="244">
<description><![CDATA[Retreive a specific database connection]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="244" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="244" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="250">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="classes/db_sql.php" hash="ac302192ccf945708ea13bd46d7427ac" 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"/>
2012-04-20 13:17:39 -04:00
<tag line="2" name="package" description="Query"/>
</docblock>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="true" namespace="default" line="22" package="Query\Query">
<name>DB_SQL</name>
<full_name>\DB_SQL</full_name>
<extends/>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[Abstract parent for database manipulation subclasses]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Query"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="33" package="">
<name>max</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="28">
<description><![CDATA[Get the max keyword sql]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="28" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="45" package="">
<name>min</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="40">
<description><![CDATA[Get the min keyword sql]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="40" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="57" package="">
<name>distinct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="52">
<description><![CDATA[Get the 'distinct' keyword]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="52" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
<name>avg</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="64">
<description><![CDATA[Get the 'average' keyword]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="64" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
<name>sum</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="76">
<description><![CDATA[Get the 'sum' keyword]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="76" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="99" package="">
<name>limit</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="90">
<description><![CDATA[Get database specific sql for limit clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="90" name="abstract" description=""/>
<tag line="90" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="90" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="90" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="90" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="99">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="99">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="99">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="107" package="">
<name>random</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="101">
<description><![CDATA[Get the sql for random ordering]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="101" name="abstract" description=""/>
<tag line="101" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="114" package="">
<name>db_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="109">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="109" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="121" package="">
<name>table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="116">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="116" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="128" package="">
<name>system_table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="123">
<description><![CDATA[Returns sql to list system tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="123" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="135" package="">
<name>view_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="130">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="130" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="142" package="">
<name>trigger_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="137">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="137" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="149" package="">
<name>function_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="144">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="144" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="156" package="">
<name>procedure_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="151">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="151" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="163" package="">
<name>sequence_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="158">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="158" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="classes/db_pdo.php" hash="1c3c46d37444ad1465d98aa30a48c233" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[Base Database class]]></description>
<long-description><![CDATA[<p>Extends PDO to simplify cross-database issues</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Query"/>
</docblock>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="protected" line="29" package="Default">
<name>$statement</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="26">
<description><![CDATA[Reference to the last executed query]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="protected" line="34" package="Default">
<name>$escape_char</name>
<default><![CDATA['"']]></default>
2012-04-20 13:17:39 -04:00
<docblock line="31">
<description><![CDATA[Character to escape identifiers]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="public" line="39" package="Default">
<name>$sql</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="36">
<description><![CDATA[Reference to sql sub class]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="public" line="44" package="Default">
<name>$util</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="41">
<description><![CDATA[Reference to util sub class]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="54" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="46">
<description><![CDATA[PDO constructor wrapper]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="46" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="46" name="param" description="" type="string" variable="$username">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="46" name="param" description="" type="string" variable="$password">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="46" name="param" description="" type="array" variable="$driver_options">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="54">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="54">
<name>$username</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="54">
<name>$password</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="54">
<name>$driver_options</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="80" package="">
<name>prepare_query</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="73">
<description><![CDATA[Simplifies prepared statements for database queries]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="73" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="73" name="param" description="" type="array" variable="$data">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="73" name="return" description="PDOStatement / FALSE" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="80">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="80">
<name>$data</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="131" package="">
<name>prepare_execute</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="124">
<description><![CDATA[Create and execute a prepared statement with the provided parameters]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="124" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="124" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="124" name="return" description="" type="\PDOStatement">
<type by_reference="false">\PDOStatement</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="131">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="131">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="147" package="">
<name>get_query_data</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="141">
<description><![CDATA[Retreives the data from a select query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="141" name="param" description="" type="\PDOStatement" variable="$statement">
<type by_reference="false">\PDOStatement</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="141" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="147">
<name>$statement</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="166" package="">
<name>affected_rows</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="160">
<description><![CDATA[Returns number of rows affected by an INSERT, UPDATE, DELETE type query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="160" name="param" description="" type="\PDOStatement" variable="$statement">
<type by_reference="false">\PDOStatement</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="160" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="166">
<name>$statement</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="184" package="">
<name>get_last_error</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="179">
<description><![CDATA[Return the last error for the current database connection]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="179" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="199" package="">
<name>quote_ident</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="193">
<description><![CDATA[Surrounds the string with the databases identifier escape characters]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="193" name="param" description="" type="mixed" variable="$ident">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="193" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="199">
<name>$ident</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="223" package="">
<name>empty_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="216">
<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>
2012-04-20 13:17:39 -04:00
<tag line="216" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="216" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="223">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="237" package="">
<name>get_schemas</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="232">
<description><![CDATA[Return schemas for databases that list them]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="232" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="249" package="">
<name>get_tables</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="244">
<description><![CDATA[Return list of tables for the current database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="244" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="261" package="">
<name>get_dbs</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="256">
<description><![CDATA[Return list of dbs for the current connection, if possible]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="256" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="273" package="">
<name>get_views</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="268">
<description><![CDATA[Return list of views for the current database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="268" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="285" package="">
<name>get_sequences</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="280">
<description><![CDATA[Return list of sequences for the current database, if they exist]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="280" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="297" package="">
<name>get_functions</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="292">
<description><![CDATA[Return list of function for the current database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="292" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="309" package="">
<name>get_procedures</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="304">
<description><![CDATA[Return list of stored procedures for the current database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="304" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="321" package="">
<name>get_triggers</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="316">
<description><![CDATA[Return list of triggers for the current database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="316" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="334" package="">
<name>get_system_tables</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="328">
<description><![CDATA[Retreives an array of non-user-created tables for
the connection/database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="328" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="348" package="">
<name>driver_query</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="341">
<description><![CDATA[Method to simplify retreiving db results for meta-data queries]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="341" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="341" name="param" description="" type="bool" variable="$filtered_index">
<type by_reference="false">bool</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="341" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="348">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="348">
<name>$filtered_index</name>
<default><![CDATA[TRUE]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="370" package="">
<name>num_rows</name>
<type>function</type>
<docblock line="365">
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="365" 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="388" package="">
<name>truncate</name>
<type>function</type>
<docblock line="381">
<description><![CDATA[Empty the passed table]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="381" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
<tag line="381" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="388">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="396" package="">
<name>switch_db</name>
<type>function</type>
<docblock line="390">
<description><![CDATA[Connect to a different database]]></description>
<long-description><![CDATA[]]></long-description>
<tag line="390" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
<tag line="390" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
<argument line="396">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="classes/query_builder.php" hash="30a3abbeeb55657ffc7531da59d4d9e8" 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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="false" namespace="default" line="22" package="Query\Query">
<name>Query_Builder</name>
<full_name>\Query_Builder</full_name>
<extends/>
<docblock line="15">
<description><![CDATA[Convienience class for creating sql queries - also the class that
instantiates the specific db driver]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="15" name="package" description="Query"/>
<tag line="15" name="subpackage" description="Query"/>
</docblock>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="27" package="Default">
<name>$select_string</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Compiled 'select' clause]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="32" package="Default">
<name>$from_string</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="29">
<description><![CDATA[Compiled 'from' clause]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="37" package="Default">
<name>$set_string</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="34">
<description><![CDATA[Compiled arguments for insert / update]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="42" package="Default">
<name>$order_string</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="39">
<description><![CDATA[Order by clause]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="47" package="Default">
<name>$group_string</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="44">
<description><![CDATA[Group by clause]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="54" package="Default">
<name>$set_array</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="51">
<description><![CDATA[key/val pairs for insert/update statement]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="59" package="Default">
<name>$set_array_keys</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="56">
<description><![CDATA[Keys for insert/update statement]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="64" package="Default">
<name>$order_array</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="61">
<description><![CDATA[Key/val pairs for order by clause]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="69" package="Default">
<name>$group_array</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="66">
<description><![CDATA[Key/val pairs for group by clause]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="76" package="Default">
<name>$values</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="73">
<description><![CDATA[Values to apply to prepared statements]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="81" package="Default">
<name>$limit</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="78">
<description><![CDATA[Value for limit string]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="86" package="Default">
<name>$offset</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="83">
<description><![CDATA[Value for offset in limit string]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="91" package="Default">
<name>$sql</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="88">
<description><![CDATA[Alias to $this->db->sql]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="105" package="Default">
<name>$query_map</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="93">
<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>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="110" package="Default">
<name>$having_map</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="107">
<description><![CDATA[Map for having clause]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="public" line="115" package="Default">
<name>$conn_name</name>
<default><![CDATA[""]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="112">
<description><![CDATA[Convenience property for connection management]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="126" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="121">
<description><![CDATA[Constructor]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="121" name="param" description="- the connection parametere" type="object" variable="$params">
<type by_reference="false">object</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="126">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="206" package="">
<name>select</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="200">
<description><![CDATA[Specifies rows to select in a query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="200" name="param" description="" type="string" variable="$fields">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="200" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="206">
<name>$fields</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="252" package="">
<name>select_max</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="245">
<description><![CDATA[Selects the maximum value of a field from a query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="245" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="245" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="245" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="252">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="252">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="276" package="">
<name>select_min</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="269">
<description><![CDATA[Selects the minimum value of a field from a query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="269" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="269" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="269" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="276">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="276">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="300" package="">
<name>select_avg</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="293">
<description><![CDATA[Selects the average value of a field from a query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="293" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="293" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="293" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="300">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="300">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="324" package="">
<name>select_sum</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="317">
<description><![CDATA[Selects the sum of a field from a query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="317" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="317" name="param" description="" type="string" variable="$as">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="317" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="324">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="324">
<name>$as</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="346" package="">
<name>distinct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="341">
<description><![CDATA[Adds the 'distinct' keyword to a query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="341" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="362" package="">
<name>from</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="356">
<description><![CDATA[Specify the database table to select from]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="356" name="param" description="" type="string" variable="$dbname">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="356" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="362">
<name>$dbname</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="389" package="">
<name>like</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="381">
<description><![CDATA[Creates a Like clause in the sql statement]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="381" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="381" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="381" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="381" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="389">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="389">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="389">
<name>$pos</name>
<default><![CDATA['both']]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="431" package="">
<name>or_like</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="423">
<description><![CDATA[Generates an OR Like clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="423" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="423" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="423" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="423" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="431">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="431">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="431">
<name>$pos</name>
<default><![CDATA['both']]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="473" package="">
<name>not_like</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="465">
<description><![CDATA[Generates a NOT LIKE clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="465" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="465" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="465" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="465" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="473">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="473">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="473">
<name>$pos</name>
<default><![CDATA['both']]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="515" package="">
<name>or_not_like</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="507">
<description><![CDATA[Generates a OR NOT LIKE clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="507" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="507" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="507" name="param" description="" type="string" variable="$pos">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="507" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="515">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="515">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="515">
<name>$pos</name>
<default><![CDATA['both']]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="556" package="">
<name>having</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="549">
<description><![CDATA[Generates a 'Having' clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="549" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="549" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="549" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="556">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="556">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="591" package="">
<name>or_having</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="584">
<description><![CDATA[Generates a 'Having' clause prefixed with 'OR']]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="584" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="584" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="584" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="591">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="591">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="628" package="">
<name>_where</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="621">
<description><![CDATA[Do all the repeditive stuff for where/having type methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="621" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="621" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="621" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="628">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="628">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="662" package="">
<name>where</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="653">
<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>
2012-04-20 13:17:39 -04:00
<tag line="653" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="653" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="653" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="662">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="662">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="698" package="">
<name>or_where</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="691">
<description><![CDATA[Where clause prefixed with "OR"]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="691" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="691" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="691" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="698">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="698">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="739" package="">
<name>where_in</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="732">
<description><![CDATA[Where clause with 'IN' statement]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="732" name="param" description="" type="mixed" variable="$field">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="732" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="732" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="739">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="739">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="769" package="">
<name>or_where_in</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="762">
<description><![CDATA[Where in statement prefixed with "or"]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="762" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="762" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="762" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="769">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="769">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="799" package="">
<name>where_not_in</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="792">
<description><![CDATA[WHERE NOT IN (FOO) clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="792" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="792" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="792" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="799">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="799">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="829" package="">
<name>or_where_not_in</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="822">
<description><![CDATA[OR WHERE NOT IN (FOO) clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="822" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="822" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="822" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="829">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="829">
<name>$val</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="861" package="">
<name>set</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="854">
<description><![CDATA[Sets values for inserts / updates / deletes]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="854" name="param" description="" type="mixed" variable="$key">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="854" name="param" description="" type="mixed" variable="$val">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="854" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="861">
<name>$key</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="861">
<name>$val</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="900" package="">
<name>join</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="892">
<description><![CDATA[Creates a join phrase in a compiled query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="892" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="892" name="param" description="" type="string" variable="$condition">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="892" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="892" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="900">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="900">
<name>$condition</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="900">
<name>$type</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="928" package="">
<name>group_by</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="922">
<description><![CDATA[Group the results by the selected field(s)]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="922" name="param" description="" type="mixed" variable="$field">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="922" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="928">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="953" package="">
<name>order_by</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="946">
<description><![CDATA[Order the results by the selected field(s)]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="946" name="param" description="" type="string" variable="$field">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="946" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="946" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="953">
<name>$field</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="953">
<name>$type</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="990" package="">
<name>limit</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="983">
<description><![CDATA[Set a limit on the current sql statement]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="983" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="983" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="983" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="990">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="990">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1007" package="">
<name>group_start</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1002">
<description><![CDATA[Adds a paren to the current query for query grouping]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1002" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1026" package="">
<name>or_group_start</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1020">
<description><![CDATA[Adds a paren to the current query for query grouping,
prefixed with 'OR']]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1020" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1045" package="">
<name>or_not_group_start</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1039">
<description><![CDATA[Adds a paren to the current query for query grouping,
prefixed with 'OR NOT']]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1039" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1063" package="">
<name>group_end</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1058">
<description><![CDATA[Ends a query group]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1058" name="return" description="" type="\$this">
<type by_reference="false">\$this</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1087" package="">
<name>get</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1078">
<description><![CDATA[Select and retrieve all records from the current table, and/or
execute current compiled query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1078" name="param" description="" type="" variable="$table"/>
<tag line="1078" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1078" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1078" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1087">
<name>$table</name>
<default><![CDATA['']]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1087">
<name>$limit</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1087">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1131" package="">
<name>get_where</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1122">
<description><![CDATA[Convience method for get() with a where clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1122" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1122" name="param" description="" type="array" variable="$where">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1122" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1122" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1122" name="return" description="" type="object">
<type by_reference="false">object</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1131">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1131">
<name>$where</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1131">
<name>$limit</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1131">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1148" package="">
<name>count_all</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1142">
<description><![CDATA[Retreive the number of rows in the selected table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1142" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1142" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1148">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1164" package="">
<name>count_all_results</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1157">
<description><![CDATA[Retrieve the number of results for the generated query - used
in place of the get() method]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1157" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1157" name="return" description="" type="int">
<type by_reference="false">int</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1164">
<name>$table</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1202" package="">
<name>insert</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1195">
<description><![CDATA[Creates an insert clause, and executes it]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1195" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1195" name="param" description="" type="mixed" variable="$data">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1195" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1202">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1202">
<name>$data</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1228" package="">
<name>update</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1221">
<description><![CDATA[Creates an update clause, and executes it]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1221" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1221" name="param" description="" type="mixed" variable="$data">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1221" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1228">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1228">
<name>$data</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1255" package="">
<name>delete</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1248">
<description><![CDATA[Deletes data from a table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1248" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1248" name="param" description="" type="mixed" variable="$where">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1248" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1255">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1255">
<name>$where</name>
<default><![CDATA['']]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1286" package="">
<name>__call</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1279">
<description><![CDATA[Calls a function further down the inheritence chain]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1279" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1279" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1279" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1286">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1286">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="1301" package="">
<name>_reset</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1298">
<description><![CDATA[Clear out the class variables, so the next query can be run]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="1343" package="">
<name>_compile</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="1336">
<description><![CDATA[String together the sql statements for sending to the db]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="1336" name="param" description="" type="string" variable="$type">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1336" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="1336" name="return" description="" type="\$string">
<type by_reference="false">\$string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="1343">
<name>$type</name>
<default><![CDATA['']]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="1343">
<name>$table</name>
<default><![CDATA[""]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="true" namespace="default" line="22" package="Query\Query">
<name>DB_Util</name>
<full_name>\DB_Util</full_name>
<extends/>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[Abstract class defining database / table creation methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Query"/>
</docblock>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="private" line="27" package="Default">
<name>$conn</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="34" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="29">
<description><![CDATA[Save a reference to the connection object for later use]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="29" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="34">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
<name>__call</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="41">
<description><![CDATA[Enable calling driver methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="41" name="param" description="" type="string" variable="$method">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="41" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$method</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$args</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="71" package="">
<name>create_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="61">
<description><![CDATA[Get database-specific sql to create a new table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="61" name="abstract" description=""/>
<tag line="61" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="61" name="param" description="" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="61" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="61" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="61" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="71">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="71">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="71">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="71">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="80" package="">
<name>delete_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="73">
<description><![CDATA[Get database-specific sql to drop a table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="73" name="abstract" description=""/>
<tag line="73" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="73" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="80">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="88" package="">
<name>backup_structure</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="82">
<description><![CDATA[Return an SQL file with the database table structure]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="82" name="abstract" description=""/>
<tag line="82" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="96" package="">
<name>backup_data</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="90">
<description><![CDATA[Return an SQL file with the database data as insert statements]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<file path="autoload.php" hash="70540d25cb0bccfcfcd8d495d7cfab57" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<constant namespace="default" line="23" package="Default">
<name>BASE_PATH</name>
<value><![CDATA[dirname(__FILE__).'/']]></value>
2012-04-20 13:17:39 -04:00
<docblock line="20">
<description><![CDATA[Reference to root path]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</constant>
2012-04-20 13:17:39 -04:00
<constant namespace="default" line="28" package="Default">
<name>DRIVER_PATH</name>
<value><![CDATA[BASE_PATH.'drivers/']]></value>
2012-04-20 13:17:39 -04:00
<docblock line="25">
<description><![CDATA[Path to driver classes]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</constant>
2012-04-20 13:17:39 -04:00
<function namespace="default" line="39" package="Query">
<name>do_include</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="32">
<description><![CDATA[Bulk directory loading workaround for use
with array_map and glob]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="32" name="param" description="" type="string" variable="$path">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="32" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$path</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
2012-04-20 13:17:39 -04:00
<function namespace="default" line="74" package="Query">
<name>db_filter</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="67">
<description><![CDATA[Filter out db rows into one array]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="67" name="param" description="" type="array" variable="$array">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="67" name="param" description="" type="mixed" variable="$index">
<type by_reference="false">mixed</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="67" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="74">
<name>$array</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="74">
<name>$index</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</function>
</file>
2012-04-20 13:17:39 -04:00
<file path="drivers/pgsql/pgsql_sql.php" hash="28f1fe85be6eba57e8ec7373f885faec" 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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<tag line="15" name="package" description="Query"/>
<tag line="15" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="31" package="">
<name>limit</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="23">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="23" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="23" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="23" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="23" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="31">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="31">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="31">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="50" package="">
<name>random</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="45">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="45" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
<name>db_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="57">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="57" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="78" package="">
<name>table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="73">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="73" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="96" package="">
<name>system_table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="91">
<description><![CDATA[Returns sql to list system tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="91" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="114" package="">
<name>view_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="109">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="109" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="132" package="">
<name>trigger_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="127">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="127" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="149" package="">
<name>function_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="144">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="144" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="161" package="">
<name>procedure_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="156">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="156" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
<name>sequence_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="174">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="174" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="197" package="">
<name>column_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="191">
<description><![CDATA[Return sql to list columns of the specified table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="191" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="191" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="197">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
2012-04-20 13:17:39 -04:00
<file path="drivers/pgsql/pgsql_util.php" hash="5bc6c47b681f4bdbb9385d8101666760" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[Posgres-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
<name>create_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="35">
<description><![CDATA[Database-specific method to create a new table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="35" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="35" name="param" description="" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="35" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="35" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="35" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="44">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="44">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="44">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="44">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="100" package="">
<name>delete_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="94">
<description><![CDATA[Database-specific SQL for dropping a table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="94" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="94" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="100">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="112" package="">
<name>backup_structure</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="107">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="107" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="126" package="">
<name>backup_data</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="120">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="120" name="param" description="" type="array" variable="$exclude">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="120" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="126">
<name>$exclude</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="drivers/pgsql/pgsql_driver.php" hash="6c0a0c18134ae745f26ab4f02ccde45f" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>PgSQL</name>
<full_name>\PgSQL</full_name>
<extends>\DB_PDO</extends>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[PostgreSQL specifc class]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Connect to a PosgreSQL database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="string" variable="$username">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="string" variable="$password">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$username</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$password</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$options</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
<name>switch_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="39">
<description><![CDATA[Connect to a different database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="39" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="44">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="57" package="">
<name>truncate</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="52">
<description><![CDATA[Empty a table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="52" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="57">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<file path="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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[ODBC-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="46" package="">
<name>create_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="37">
<description><![CDATA[Database-specific method to create a new table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="46">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="46">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="46">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="46">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="60" package="">
<name>delete_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="54">
<description><![CDATA[Remove a table from the database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="54" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="54" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="60">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="72" package="">
<name>backup_structure</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="67">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="67" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="85" package="">
<name>backup_data</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="80">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="80" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
2012-04-20 13:17:39 -04:00
<file path="drivers/odbc/odbc_sql.php" hash="e13c5f4cb9739325d812c8aeb33e8f52" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[ODBC SQL Class]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>limit</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
<name>random</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="39">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="39" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
<name>db_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="51">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="51" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
<name>table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="63">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="63" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="80" package="">
<name>system_table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="75">
<description><![CDATA[Returns sql to list system tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="75" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="92" package="">
<name>view_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="87">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="87" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="104" package="">
<name>trigger_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="99">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="99" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
<name>function_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="111">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="111" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
<name>procedure_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="123">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="123" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="140" package="">
<name>sequence_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="135">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="135" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="drivers/odbc/odbc_driver.php" hash="4eed99411477e5f649f464159f1976ef" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="false" namespace="default" line="24" package="Query\Drivers">
<name>ODBC</name>
<full_name>\ODBC</full_name>
<extends>\DB_PDO</extends>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="protected" line="29" package="Default">
<name>$escape_char</name>
<default><![CDATA['']]></default>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="31">
<description><![CDATA[Use ODBC to connect to a database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="string" variable="$username">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="string" variable="$password">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$username</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$password</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$options</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
<name>switch_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="46">
<description><![CDATA[Doesn't apply to ODBC]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="46" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="46" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="52">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="65" package="">
<name>truncate</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="59">
<description><![CDATA[Empty the current database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="59" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="59" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="65">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
2012-04-20 13:17:39 -04:00
<file path="drivers/mysql/mysql_util.php" hash="e6dbdd9b0b965f7e09ee0638ed4a7a35" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[MySQL-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
<name>create_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="37">
<description><![CDATA[Convienience public function for creating a new MySQL table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$columns">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="113" package="">
<name>delete_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="107">
<description><![CDATA[Convience public function for droping a table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="107" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="107" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="113">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="125" package="">
<name>backup_structure</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="120">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="120" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="139" package="">
<name>backup_data</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="133">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="133" name="param" description="" type="array" variable="$exclude">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="133" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="139">
<name>$exclude</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="drivers/mysql/mysql_driver.php" hash="c2864f80d57183bbea8b2ee75d4927d8" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>MySQL</name>
<full_name>\MySQL</full_name>
<extends>\DB_PDO</extends>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[MySQL specific class]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="protected" line="29" package="Default">
<name>$escape_char</name>
<default><![CDATA['`']]></default>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Set the backtick as the MySQL escape character]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="var" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="31">
<description><![CDATA[Connect to MySQL Database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="string" variable="$username">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="string" variable="$password">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="31" name="param" description="" type="array" variable="$options">
<type by_reference="false">array</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$username</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$password</name>
<default><![CDATA[null]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="39">
<name>$options</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="55" package="">
<name>switch_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="50">
<description><![CDATA[Connect to a different database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="50" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="55">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
<name>truncate</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="63">
<description><![CDATA[Empty a table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="63" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="68">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
2012-04-20 13:17:39 -04:00
<file path="drivers/mysql/mysql_sql.php" hash="41d15ee4e1357bb84f07e71872252810" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[MySQL specifc SQL]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>limit</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
<name>random</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="44">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="44" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
<name>db_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="56">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="56" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
<name>table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="68">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="68" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="85" package="">
<name>system_table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="80">
<description><![CDATA[Overridden in MySQL class]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="80" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="98" package="">
<name>view_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="93">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="93" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="110" package="">
<name>trigger_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="105">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="105" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="122" package="">
<name>function_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="117">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="117" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="134" package="">
<name>procedure_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="129">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="129" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="146" package="">
<name>sequence_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="141">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="141" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
</class>
</file>
2012-04-20 13:17:39 -04:00
<file path="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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[SQLite-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="46" package="">
<name>create_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="37">
<description><![CDATA[Convenience public function to create a new table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="//Name of the table" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="// column =&gt; constraint pairs" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="// column =&gt; index pairs" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="46">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="46">
<name>$columns</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="46">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="46">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
<name>delete_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="96">
<description><![CDATA[SQL to drop the specified table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="96" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="96" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="102">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>backup_data</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="109">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="109" name="param" description="" type="array" variable="$excluded">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="109" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="115">
<name>$excluded</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
<name>backup_structure</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="174">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="174" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
</class>
</file>
<file path="drivers/sqlite/sqlite_driver.php" hash="570c7de63389b318dcf037c7ecb41484" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
<name>SQLite</name>
<full_name>\SQLite</full_name>
<extends>\DB_PDO</extends>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[SQLite specific class]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<property final="false" static="false" visibility="protected" line="27" package="Default">
<name>$statement</name>
<default><![CDATA[]]></default>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Reference to the last executed sql query]]></description>
<long-description><![CDATA[]]></long-description>
</docblock>
</property>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="36" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="29">
<description><![CDATA[Open SQLite Database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="29" name="param" description="" type="string" variable="$dsn">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="29" name="param" description="" type="string" variable="$user">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="29" name="param" description="" type="string" variable="$pass">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="36">
<name>$dsn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="36">
<name>$user</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="36">
<name>$pass</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
<name>switch_db</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="44">
<description><![CDATA[Doesn't apply to sqlite]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="44" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="49">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
<name>truncate</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="56">
<description><![CDATA[Empty a table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="56" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="61">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="79" package="">
<name>get_tables</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="74">
<description><![CDATA[List tables for the current database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="74" name="return" description="" type="mixed">
<type by_reference="false">mixed</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="100" package="">
<name>get_system_tables</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="95">
<description><![CDATA[List system tables for the current database]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="95" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>load_database</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="109">
<description><![CDATA[Load a database for the current connection]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="109" name="param" description="" type="string" variable="$db">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="109" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="115">
<name>$db</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="115">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
<name>unload_database</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="123">
<description><![CDATA[Unload a database from the current connection]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="123" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="128">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
2012-04-20 13:17:39 -04:00
<file path="drivers/sqlite/sqlite_sql.php" hash="922f241976864c2452c65c2ebec32eda" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[SQLite Specific SQL]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>limit</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
<name>random</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="44">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="44" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
<name>db_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="56">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="56" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
<name>table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="68">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="68" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
<name>system_table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="85">
<description><![CDATA[Overridden in SQLite class]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="85" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
<name>view_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="97">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="97" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
<name>trigger_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="111">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="111" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
<name>function_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="123">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="123" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="140" package="">
<name>procedure_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="135">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="135" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="152" package="">
<name>sequence_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="147">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="147" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
</class>
</file>
2012-04-20 13:17:39 -04:00
<file path="drivers/firebird/firebird_sql.php" hash="1691368f9f3d42296b89c1e5e33281e0" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[Firebird Specific SQL]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
<name>limit</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Limit clause]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="int" variable="$limit">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="" type="int" variable="$offset">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$limit</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="32">
<name>$offset</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
<name>random</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="51">
<description><![CDATA[Random ordering keyword]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="51" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
<name>db_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="64">
<description><![CDATA[Returns sql to list other databases]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="64" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
<name>table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="76">
<description><![CDATA[Returns sql to list tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="76" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="98" package="">
<name>system_table_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="93">
<description><![CDATA[Returns sql to list system tables]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="93" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>view_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="110">
<description><![CDATA[Returns sql to list views]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="110" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
<name>trigger_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="125">
<description><![CDATA[Returns sql to list triggers]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="125" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="145" package="">
<name>function_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="140">
<description><![CDATA[Return sql to list functions]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="140" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="157" package="">
<name>procedure_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="152">
<description><![CDATA[Return sql to list stored procedures]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="152" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="185" package="">
<name>sequence_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="180">
<description><![CDATA[Return sql to list sequences]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="180" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="202" package="">
<name>column_list</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="196">
<description><![CDATA[Return sql to list columns of the specified table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="196" name="param" description="" type="string" variable="$table">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="196" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="202">
<name>$table</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
<file path="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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[Firebird result class to emulate PDOStatement Class - only implements
data-fetching methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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="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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<class final="false" abstract="false" namespace="default" line="24" package="Query\Drivers">
<name>Firebird</name>
<full_name>\Firebird</full_name>
<extends>\DB_PDO</extends>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="170" package="">
<name>beginTransaction</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="165">
<description><![CDATA[Start a database transaction]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="165" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="187" package="">
<name>commit</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="182">
<description><![CDATA[Commit a database transaction]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="182" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="199" package="">
<name>rollBack</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="194">
<description><![CDATA[Rollback a transaction]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="194" name="return" description="" type="bool">
<type by_reference="false">bool</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="213" package="">
<name>prepare_execute</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="206">
<description><![CDATA[Prepare and execute a query]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="206" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="206" name="param" description="" type="array" variable="$args">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="206" name="return" description="" type="resource">
<type by_reference="false">resource</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="213">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="213">
<name>$args</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="232" package="">
<name>quote</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="225">
<description><![CDATA[Method to emulate PDO->quote]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="225" name="param" description="" type="string" variable="$str">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="225" name="param" description="" type="int" variable="$param_type">
<type by_reference="false">int</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="225" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="232">
<name>$str</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="232">
<name>$param_type</name>
<default><![CDATA[NULL]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="249" package="">
<name>errorInfo</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="244">
<description><![CDATA[Method to emulate PDO->errorInfo / PDOStatement->errorInfo]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="244" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="264" package="">
<name>errorCode</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="259">
<description><![CDATA[Method to emulate PDO->errorCode]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="259" name="return" description="" type="array">
<type by_reference="false">array</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="278" package="">
<name>prepare_query</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="271">
<description><![CDATA[Bind a prepared query with arguments for executing]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="271" name="param" description="" type="string" variable="$sql">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="271" name="param" description="" type="array" variable="$params">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="271" name="return" description="" type="FALSE">
<type by_reference="false">FALSE</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="278">
<name>$sql</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="278">
<name>$params</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
</class>
</file>
2012-04-20 13:17:39 -04:00
<file path="drivers/firebird/firebird_util.php" hash="e51cf49b7bb1e2bb39ed5eab9bf6e98c" package="Query">
<docblock line="2">
<description><![CDATA[Query]]></description>
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<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>
2012-04-20 13:17:39 -04:00
<docblock line="16">
<description><![CDATA[Firebird-specific backup, import and creation methods]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="16" name="package" description="Query"/>
<tag line="16" name="subpackage" description="Drivers"/>
</docblock>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
<name>__construct</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="24">
<description><![CDATA[Save a reference to the current connection object]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="24" name="param" description="&amp;$conn" type="object" variable="$conn">
<type by_reference="false">object</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="24" name="return" description="" type="void">
<type by_reference="false">void</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="30">
<name>$conn</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
<name>create_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="37">
<description><![CDATA[Convienience public function to generate sql for creating a db table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$fields">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$constraints">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="param" description="" type="array" variable="$indexes">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="37" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$fields</name>
<default><![CDATA[]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$constraints</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="47">
<name>$indexes</name>
<default><![CDATA[array()]]></default>
<type>array</type>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="103" package="">
<name>delete_table</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="97">
<description><![CDATA[Drop the selected table]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="97" name="param" description="" type="string" variable="$name">
<type by_reference="false">string</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="97" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="103">
<name>$name</name>
<default><![CDATA[]]></default>
<type/>
</argument>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
<name>backup_structure</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="110">
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="110" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
</method>
2012-04-20 13:17:39 -04:00
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
<name>backup_data</name>
<type>function</type>
2012-04-20 13:17:39 -04:00
<docblock line="123">
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
<long-description><![CDATA[]]></long-description>
2012-04-20 13:17:39 -04:00
<tag line="123" name="param" description="" type="array" variable="$exclude">
<type by_reference="false">array</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="123" name="param" description="" type="bool" variable="$system_tables">
<type by_reference="false">bool</type>
</tag>
2012-04-20 13:17:39 -04:00
<tag line="123" name="return" description="" type="string">
<type by_reference="false">string</type>
</tag>
</docblock>
2012-04-20 13:17:39 -04:00
<argument line="130">
<name>$exclude</name>
<default><![CDATA[array()]]></default>
<type/>
</argument>
2012-04-20 13:17:39 -04:00
<argument line="130">
<name>$system_tables</name>
<default><![CDATA[FALSE]]></default>
<type/>
</argument>
</method>
</class>
</file>
<package name="" full_name=""/>
<package name="Default" full_name="Default"/>
2012-04-20 13:17:39 -04:00
<package name="Query" full_name="Query">
<package name="Drivers" full_name="Query\Drivers"/>
<package name="Helper Classes" full_name="Query\Helper Classes"/>
<package name="Query" full_name="Query\Query"/>
</package>
<namespace name="default" full_name="default"/>
<marker count="0">todo</marker>
<marker count="0">fixme</marker>
<deprecated count="0"/>
</project>