5052 lines
223 KiB
XML
5052 lines
223 KiB
XML
<?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>
|
|
<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>
|
|
<tag line="15" name="package" description="Query"/>
|
|
<tag line="15" name="subpackage" description="Helper Classes"/>
|
|
</docblock>
|
|
<property final="false" static="true" visibility="private" line="29" package="Default">
|
|
<name>$instance</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<docblock line="26">
|
|
<description><![CDATA[Static array of connections]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="37" package="">
|
|
<name>get_db</name>
|
|
<type>function</type>
|
|
<docblock line="31">
|
|
<description><![CDATA[Registry access method]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="31" name="param" description="" type="string" variable="$key">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="return" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="37">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="55" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="50">
|
|
<description><![CDATA[Private constructor]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="50" name="param" description="" type="string" variable="$key">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="55">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="71" package="">
|
|
<name>get_connections</name>
|
|
<type>function</type>
|
|
<docblock line="66">
|
|
<description><![CDATA[Return exiting connections]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="66" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="84" package="">
|
|
<name>remove_db</name>
|
|
<type>function</type>
|
|
<docblock line="78">
|
|
<description><![CDATA[Remove a database connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="78" name="param" description="" type="string" variable="$key">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="78" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Helper Classes">
|
|
<name>Settings</name>
|
|
<full_name>\Settings</full_name>
|
|
<extends/>
|
|
<docblock line="16">
|
|
<description><![CDATA[Class for manipulating datbase connections, and miscellaneous settings]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Helper Classes"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="private" line="27" package="Default">
|
|
<name>$current</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="24">
|
|
<description><![CDATA[Settings object represented by the currently loaded JSON file]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="true" visibility="private" line="32" package="Default">
|
|
<name>$instance</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="29">
|
|
<description><![CDATA[Singleton instance]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="40" package="">
|
|
<name>get_instance</name>
|
|
<type>function</type>
|
|
<docblock line="34">
|
|
<description><![CDATA[Static method to retreive current instance
|
|
of the singleton]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="34" name="return" description="" type="\Settings">
|
|
<type by_reference="false">\Settings</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="55" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<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>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
|
|
<name>__destruct</name>
|
|
<type>function</type>
|
|
<docblock line="87">
|
|
<description><![CDATA[Output the settings on destruct]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="107" package="">
|
|
<name>__get</name>
|
|
<type>function</type>
|
|
<docblock line="101">
|
|
<description><![CDATA[Magic method to simplify isset checking for config options]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="101" name="param" description="" type="string" variable="$key">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="101" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="107">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="122" package="">
|
|
<name>__set</name>
|
|
<type>function</type>
|
|
<docblock line="116">
|
|
<description><![CDATA[Magic method to simplify setting config options]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="116" name="param" description="" type="string" variable="$key">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="116" name="param" description="mixed" type="" variable="$val"/>
|
|
</docblock>
|
|
<argument line="122">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="122">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="141" package="">
|
|
<name>add_db</name>
|
|
<type>function</type>
|
|
<docblock line="135">
|
|
<description><![CDATA[Add a database connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="135" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="135" name="param" description="" type="array" variable="$params">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="141">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="141">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="173" package="">
|
|
<name>edit_db</name>
|
|
<type>function</type>
|
|
<docblock line="167">
|
|
<description><![CDATA[Edit a database connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="167" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="167" name="param" description="" type="array" variable="$params">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="173">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="173">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="216" package="">
|
|
<name>remove_db</name>
|
|
<type>function</type>
|
|
<docblock line="211">
|
|
<description><![CDATA[Remove a database connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="211" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="216">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="237" package="">
|
|
<name>get_dbs</name>
|
|
<type>function</type>
|
|
<docblock line="232">
|
|
<description><![CDATA[Retreive all db connections]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="232" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="250" package="">
|
|
<name>get_db</name>
|
|
<type>function</type>
|
|
<docblock line="244">
|
|
<description><![CDATA[Retreive a specific database connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="244" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="244" name="return" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<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"/>
|
|
<tag line="2" name="package" description="Query"/>
|
|
</docblock>
|
|
<class final="false" abstract="true" namespace="default" line="22" package="Query\Query">
|
|
<name>DB_SQL</name>
|
|
<full_name>\DB_SQL</full_name>
|
|
<extends/>
|
|
<docblock line="16">
|
|
<description><![CDATA[Abstract parent for database manipulation subclasses]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="33" package="">
|
|
<name>max</name>
|
|
<type>function</type>
|
|
<docblock line="28">
|
|
<description><![CDATA[Get the max keyword sql]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="28" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="45" package="">
|
|
<name>min</name>
|
|
<type>function</type>
|
|
<docblock line="40">
|
|
<description><![CDATA[Get the min keyword sql]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="40" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="57" package="">
|
|
<name>distinct</name>
|
|
<type>function</type>
|
|
<docblock line="52">
|
|
<description><![CDATA[Get the 'distinct' keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="52" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
|
|
<name>avg</name>
|
|
<type>function</type>
|
|
<docblock line="64">
|
|
<description><![CDATA[Get the 'average' keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="64" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
|
|
<name>sum</name>
|
|
<type>function</type>
|
|
<docblock line="76">
|
|
<description><![CDATA[Get the 'sum' keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="76" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="99" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="90">
|
|
<description><![CDATA[Get database specific sql for limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="90" name="abstract" description=""/>
|
|
<tag line="90" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="90" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="90" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="90" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="99">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="99">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="99">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="107" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="101">
|
|
<description><![CDATA[Get the sql for random ordering]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="101" name="abstract" description=""/>
|
|
<tag line="101" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="114" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="109">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="109" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="121" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="116">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="116" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="128" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="123">
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="123" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="135" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="130">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="130" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="142" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="137">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="137" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="149" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="144">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="144" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="156" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="151">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="151" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="163" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="158">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="158" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="classes/db_pdo.php" hash="2f5d078b255b67629fb1267a38a354e3" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="true" namespace="default" line="24" package="Query\Query">
|
|
<name>DB_PDO</name>
|
|
<full_name>\DB_PDO</full_name>
|
|
<extends>\PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Base Database class]]></description>
|
|
<long-description><![CDATA[<p>Extends PDO to simplify cross-database issues</p>]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="31" package="Default">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="26">
|
|
<description><![CDATA[Reference to the last executed query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="26" name="var" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="38" package="Default">
|
|
<name>$escape_char</name>
|
|
<default><![CDATA['"']]></default>
|
|
<docblock line="33">
|
|
<description><![CDATA[Character to escape identifiers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="33" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="45" package="Default">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="40">
|
|
<description><![CDATA[Reference to sql sub class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="40" name="var" description="" type="Object">
|
|
<type by_reference="false">Object</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="52" package="Default">
|
|
<name>$util</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="47">
|
|
<description><![CDATA[Reference to util sub class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="47" name="var" description="" type="Object">
|
|
<type by_reference="false">Object</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="54">
|
|
<description><![CDATA[PDO constructor wrapper]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="54" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="54" name="param" description="" type="string" variable="$username">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="54" name="param" description="" type="string" variable="$password">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="54" name="param" description="" type="array" variable="$driver_options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="62">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="62">
|
|
<name>$username</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="62">
|
|
<name>$password</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="62">
|
|
<name>$driver_options</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="88" package="">
|
|
<name>prepare_query</name>
|
|
<type>function</type>
|
|
<docblock line="81">
|
|
<description><![CDATA[Simplifies prepared statements for database queries]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="81" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="81" name="param" description="" type="array" variable="$data">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="81" name="return" description="PDOStatement / FALSE" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="88">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="88">
|
|
<name>$data</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="139" package="">
|
|
<name>prepare_execute</name>
|
|
<type>function</type>
|
|
<docblock line="132">
|
|
<description><![CDATA[Create and execute a prepared statement with the provided parameters]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="132" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="132" name="param" description="" type="array" variable="$params">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="132" name="return" description="" type="\PDOStatement">
|
|
<type by_reference="false">\PDOStatement</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="139">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="139">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="155" package="">
|
|
<name>get_query_data</name>
|
|
<type>function</type>
|
|
<docblock line="149">
|
|
<description><![CDATA[Retreives the data from a select query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="149" name="param" description="" type="\PDOStatement" variable="$statement">
|
|
<type by_reference="false">\PDOStatement</type>
|
|
</tag>
|
|
<tag line="149" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="155">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="174" package="">
|
|
<name>affected_rows</name>
|
|
<type>function</type>
|
|
<docblock line="168">
|
|
<description><![CDATA[Returns number of rows affected by an INSERT, UPDATE, DELETE type query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="168" name="param" description="" type="\PDOStatement" variable="$statement">
|
|
<type by_reference="false">\PDOStatement</type>
|
|
</tag>
|
|
<tag line="168" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="174">
|
|
<name>$statement</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="192" package="">
|
|
<name>get_last_error</name>
|
|
<type>function</type>
|
|
<docblock line="187">
|
|
<description><![CDATA[Return the last error for the current database connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="187" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="207" package="">
|
|
<name>quote_ident</name>
|
|
<type>function</type>
|
|
<docblock line="201">
|
|
<description><![CDATA[Surrounds the string with the databases identifier escape characters]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="201" name="param" description="" type="mixed" variable="$ident">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="201" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="207">
|
|
<name>$ident</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="234" package="">
|
|
<name>empty_table</name>
|
|
<type>function</type>
|
|
<docblock line="227">
|
|
<description><![CDATA[Deletes all the rows from a table. Does the same as the truncate
|
|
method if the database does not support 'TRUNCATE';]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="227" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="227" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="234">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="248" package="">
|
|
<name>get_schemas</name>
|
|
<type>function</type>
|
|
<docblock line="243">
|
|
<description><![CDATA[Return schemas for databases that list them]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="243" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="260" package="">
|
|
<name>get_tables</name>
|
|
<type>function</type>
|
|
<docblock line="255">
|
|
<description><![CDATA[Return list of tables for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="255" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="272" package="">
|
|
<name>get_dbs</name>
|
|
<type>function</type>
|
|
<docblock line="267">
|
|
<description><![CDATA[Return list of dbs for the current connection, if possible]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="267" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="284" package="">
|
|
<name>get_views</name>
|
|
<type>function</type>
|
|
<docblock line="279">
|
|
<description><![CDATA[Return list of views for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="279" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="296" package="">
|
|
<name>get_sequences</name>
|
|
<type>function</type>
|
|
<docblock line="291">
|
|
<description><![CDATA[Return list of sequences for the current database, if they exist]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="291" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="308" package="">
|
|
<name>get_functions</name>
|
|
<type>function</type>
|
|
<docblock line="303">
|
|
<description><![CDATA[Return list of function for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="303" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="320" package="">
|
|
<name>get_procedures</name>
|
|
<type>function</type>
|
|
<docblock line="315">
|
|
<description><![CDATA[Return list of stored procedures for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="315" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="332" package="">
|
|
<name>get_triggers</name>
|
|
<type>function</type>
|
|
<docblock line="327">
|
|
<description><![CDATA[Return list of triggers for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="327" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="345" package="">
|
|
<name>get_system_tables</name>
|
|
<type>function</type>
|
|
<docblock line="339">
|
|
<description><![CDATA[Retreives an array of non-user-created tables for
|
|
the connection/database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="339" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="359" package="">
|
|
<name>driver_query</name>
|
|
<type>function</type>
|
|
<docblock line="352">
|
|
<description><![CDATA[Method to simplify retreiving db results for meta-data queries]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="352" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="352" name="param" description="" type="bool" variable="$filtered_index">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="352" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="359">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="359">
|
|
<name>$filtered_index</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="381" package="">
|
|
<name>num_rows</name>
|
|
<type>function</type>
|
|
<docblock line="376">
|
|
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="376" 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="399" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="392">
|
|
<description><![CDATA[Empty the passed table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="392" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="392" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="399">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="407" package="">
|
|
<name>switch_db</name>
|
|
<type>function</type>
|
|
<docblock line="401">
|
|
<description><![CDATA[Connect to a different database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="401" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="401" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="407">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="classes/query_builder.php" hash="b4acfaf086e907d2413e68faf516633b" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="23" package="Query\Query">
|
|
<name>Query_Builder</name>
|
|
<full_name>\Query_Builder</full_name>
|
|
<extends/>
|
|
<docblock line="16">
|
|
<description><![CDATA[Convienience class for creating sql queries - also the class that
|
|
instantiates the specific db driver]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="private" line="34" package="Default">
|
|
<name>$select_string</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="29">
|
|
<description><![CDATA[Compiled 'select' clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="29" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="41" package="Default">
|
|
<name>$from_string</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="36">
|
|
<description><![CDATA[Compiled 'from' clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="36" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="48" package="Default">
|
|
<name>$set_string</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="43">
|
|
<description><![CDATA[Compiled arguments for insert / update]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="43" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="55" package="Default">
|
|
<name>$order_string</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="50">
|
|
<description><![CDATA[Order by clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="50" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="62" package="Default">
|
|
<name>$group_string</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="57">
|
|
<description><![CDATA[Group by clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="57" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="73" package="Default">
|
|
<name>$set_array_keys</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="68">
|
|
<description><![CDATA[Keys for insert/update statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="68" name="var" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="80" package="Default">
|
|
<name>$order_array</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="75">
|
|
<description><![CDATA[Key/val pairs for order by clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="75" name="var" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="87" package="Default">
|
|
<name>$group_array</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="82">
|
|
<description><![CDATA[Key/val pairs for group by clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="82" name="var" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="98" package="Default">
|
|
<name>$values</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="93">
|
|
<description><![CDATA[Values to apply to prepared statements]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="93" name="var" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="105" package="Default">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="100">
|
|
<description><![CDATA[Value for limit string]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="100" name="var" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="112" package="Default">
|
|
<name>$offset</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="107">
|
|
<description><![CDATA[Value for offset in limit string]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="107" name="var" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="119" package="Default">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="114">
|
|
<description><![CDATA[Alias to $this->db->sql]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="114" name="var" description="" type="\DB_PDO">
|
|
<type by_reference="false">\DB_PDO</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="135" package="Default">
|
|
<name>$query_map</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="121">
|
|
<description><![CDATA[Query component order mapping
|
|
for complex select queries]]></description>
|
|
<long-description><![CDATA[<p>Format:</p>
|
|
|
|
<p>array(
|
|
'type' => 'where',
|
|
'conjunction' => ' AND ',
|
|
'string' => 'k=?'
|
|
)</p>]]></long-description>
|
|
<tag line="121" name="var" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="142" package="Default">
|
|
<name>$having_map</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="137">
|
|
<description><![CDATA[Map for having clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="137" name="var" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="149" package="Default">
|
|
<name>$conn_name</name>
|
|
<default><![CDATA[""]]></default>
|
|
<docblock line="144">
|
|
<description><![CDATA[Convenience property for connection management]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="144" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="156" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="151">
|
|
<description><![CDATA[Constructor]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="151" name="param" description="- the connection parametere" type="object" variable="$params">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="156">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="236" package="">
|
|
<name>select</name>
|
|
<type>function</type>
|
|
<docblock line="230">
|
|
<description><![CDATA[Specifies rows to select in a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="230" name="param" description="" type="string" variable="$fields">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="230" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="236">
|
|
<name>$fields</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="282" package="">
|
|
<name>_select</name>
|
|
<type>function</type>
|
|
<docblock line="275">
|
|
<description><![CDATA[Method to simplify select_ methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="275" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="275" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="275" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="282">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="282">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="303" package="">
|
|
<name>select_max</name>
|
|
<type>function</type>
|
|
<docblock line="296">
|
|
<description><![CDATA[Selects the maximum value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="296" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="296" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="296" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="303">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="303">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="319" package="">
|
|
<name>select_min</name>
|
|
<type>function</type>
|
|
<docblock line="312">
|
|
<description><![CDATA[Selects the minimum value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="312" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="312" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="312" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="319">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="319">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="335" package="">
|
|
<name>select_avg</name>
|
|
<type>function</type>
|
|
<docblock line="328">
|
|
<description><![CDATA[Selects the average value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="328" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="328" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="328" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="335">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="335">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="351" package="">
|
|
<name>select_sum</name>
|
|
<type>function</type>
|
|
<docblock line="344">
|
|
<description><![CDATA[Selects the sum of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="344" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="344" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="344" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="351">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="351">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="365" package="">
|
|
<name>distinct</name>
|
|
<type>function</type>
|
|
<docblock line="360">
|
|
<description><![CDATA[Adds the 'distinct' keyword to a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="360" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="380" package="">
|
|
<name>from</name>
|
|
<type>function</type>
|
|
<docblock line="374">
|
|
<description><![CDATA[Specify the database table to select from]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="374" name="param" description="" type="string" variable="$dbname">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="374" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="380">
|
|
<name>$dbname</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="407" package="">
|
|
<name>like</name>
|
|
<type>function</type>
|
|
<docblock line="399">
|
|
<description><![CDATA[Creates a Like clause in the sql statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="399" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="399" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="399" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="399" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="407">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="407">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="407">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="449" package="">
|
|
<name>or_like</name>
|
|
<type>function</type>
|
|
<docblock line="441">
|
|
<description><![CDATA[Generates an OR Like clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="441" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="441" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="441" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="441" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="449">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="449">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="449">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="479" package="">
|
|
<name>not_like</name>
|
|
<type>function</type>
|
|
<docblock line="471">
|
|
<description><![CDATA[Generates a NOT LIKE clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="471" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="471" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="471" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="471" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="479">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="479">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="479">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="509" package="">
|
|
<name>or_not_like</name>
|
|
<type>function</type>
|
|
<docblock line="501">
|
|
<description><![CDATA[Generates a OR NOT LIKE clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="501" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="501" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="501" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="501" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="509">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="509">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="509">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="538" package="">
|
|
<name>having</name>
|
|
<type>function</type>
|
|
<docblock line="531">
|
|
<description><![CDATA[Generates a 'Having' clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="531" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="531" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="531" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="538">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="538">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="573" package="">
|
|
<name>or_having</name>
|
|
<type>function</type>
|
|
<docblock line="566">
|
|
<description><![CDATA[Generates a 'Having' clause prefixed with 'OR']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="566" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="566" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="566" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="573">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="573">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="610" package="">
|
|
<name>_where</name>
|
|
<type>function</type>
|
|
<docblock line="603">
|
|
<description><![CDATA[Do all the repeditive stuff for where/having type methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="603" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="603" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="603" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="610">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="610">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="644" package="">
|
|
<name>where</name>
|
|
<type>function</type>
|
|
<docblock line="635">
|
|
<description><![CDATA[Specify condition(s) in the where clause of a query
|
|
Note: this function works with key / value, or a
|
|
passed array with key / value pairs]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="635" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="635" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="635" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="644">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="644">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="680" package="">
|
|
<name>or_where</name>
|
|
<type>function</type>
|
|
<docblock line="673">
|
|
<description><![CDATA[Where clause prefixed with "OR"]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="673" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="673" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="673" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="680">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="680">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="721" package="">
|
|
<name>where_in</name>
|
|
<type>function</type>
|
|
<docblock line="714">
|
|
<description><![CDATA[Where clause with 'IN' statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="714" name="param" description="" type="mixed" variable="$field">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="714" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="714" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="721">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="721">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="751" package="">
|
|
<name>or_where_in</name>
|
|
<type>function</type>
|
|
<docblock line="744">
|
|
<description><![CDATA[Where in statement prefixed with "or"]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="744" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="744" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="744" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="751">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="751">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="782" package="">
|
|
<name>where_not_in</name>
|
|
<type>function</type>
|
|
<docblock line="775">
|
|
<description><![CDATA[WHERE NOT IN (FOO) clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="775" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="775" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="775" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="782">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="782">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="812" package="">
|
|
<name>or_where_not_in</name>
|
|
<type>function</type>
|
|
<docblock line="805">
|
|
<description><![CDATA[OR WHERE NOT IN (FOO) clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="805" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="805" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="805" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="812">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="812">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="844" package="">
|
|
<name>set</name>
|
|
<type>function</type>
|
|
<docblock line="837">
|
|
<description><![CDATA[Sets values for inserts / updates / deletes]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="837" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="837" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="837" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="844">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="844">
|
|
<name>$val</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="883" package="">
|
|
<name>join</name>
|
|
<type>function</type>
|
|
<docblock line="875">
|
|
<description><![CDATA[Creates a join phrase in a compiled query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="875" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="875" name="param" description="" type="string" variable="$condition">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="875" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="875" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="883">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="883">
|
|
<name>$condition</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="883">
|
|
<name>$type</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="912" package="">
|
|
<name>group_by</name>
|
|
<type>function</type>
|
|
<docblock line="906">
|
|
<description><![CDATA[Group the results by the selected field(s)]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="906" name="param" description="" type="mixed" variable="$field">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="906" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="912">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="937" package="">
|
|
<name>order_by</name>
|
|
<type>function</type>
|
|
<docblock line="930">
|
|
<description><![CDATA[Order the results by the selected field(s)]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="930" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="930" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="930" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="937">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="937">
|
|
<name>$type</name>
|
|
<default><![CDATA[""]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="974" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="967">
|
|
<description><![CDATA[Set a limit on the current sql statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="967" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="967" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="967" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="974">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="974">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="991" package="">
|
|
<name>group_start</name>
|
|
<type>function</type>
|
|
<docblock line="986">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="986" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1010" package="">
|
|
<name>or_group_start</name>
|
|
<type>function</type>
|
|
<docblock line="1004">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping,
|
|
prefixed with 'OR']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1004" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1029" package="">
|
|
<name>or_not_group_start</name>
|
|
<type>function</type>
|
|
<docblock line="1023">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping,
|
|
prefixed with 'OR NOT']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1023" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1047" package="">
|
|
<name>group_end</name>
|
|
<type>function</type>
|
|
<docblock line="1042">
|
|
<description><![CDATA[Ends a query group]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1042" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1071" package="">
|
|
<name>get</name>
|
|
<type>function</type>
|
|
<docblock line="1062">
|
|
<description><![CDATA[Select and retrieve all records from the current table, and/or
|
|
execute current compiled query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1062" name="param" description="" type="" variable="$table"/>
|
|
<tag line="1062" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="1062" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="1062" name="return" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1071">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1071">
|
|
<name>$limit</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1071">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1115" package="">
|
|
<name>get_where</name>
|
|
<type>function</type>
|
|
<docblock line="1106">
|
|
<description><![CDATA[Convience method for get() with a where clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1106" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1106" name="param" description="" type="array" variable="$where">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="1106" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="1106" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="1106" name="return" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1115">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1115">
|
|
<name>$where</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1115">
|
|
<name>$limit</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1115">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1132" package="">
|
|
<name>count_all</name>
|
|
<type>function</type>
|
|
<docblock line="1126">
|
|
<description><![CDATA[Retreive the number of rows in the selected table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1126" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1126" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1132">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1148" package="">
|
|
<name>count_all_results</name>
|
|
<type>function</type>
|
|
<docblock line="1141">
|
|
<description><![CDATA[Retrieve the number of results for the generated query - used
|
|
in place of the get() method]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1141" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1141" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1148">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1186" package="">
|
|
<name>insert</name>
|
|
<type>function</type>
|
|
<docblock line="1179">
|
|
<description><![CDATA[Creates an insert clause, and executes it]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1179" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1179" name="param" description="" type="mixed" variable="$data">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="1179" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1186">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1186">
|
|
<name>$data</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1212" package="">
|
|
<name>update</name>
|
|
<type>function</type>
|
|
<docblock line="1205">
|
|
<description><![CDATA[Creates an update clause, and executes it]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1205" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1205" name="param" description="" type="mixed" variable="$data">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="1205" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1212">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1212">
|
|
<name>$data</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1239" package="">
|
|
<name>delete</name>
|
|
<type>function</type>
|
|
<docblock line="1232">
|
|
<description><![CDATA[Deletes data from a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1232" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1232" name="param" description="" type="mixed" variable="$where">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="1232" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1239">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1239">
|
|
<name>$where</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1270" package="">
|
|
<name>__call</name>
|
|
<type>function</type>
|
|
<docblock line="1263">
|
|
<description><![CDATA[Calls a function further down the inheritence chain]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1263" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1263" name="param" description="" type="array" variable="$params">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="1263" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1270">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1270">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="1285" package="">
|
|
<name>_reset</name>
|
|
<type>function</type>
|
|
<docblock line="1282">
|
|
<description><![CDATA[Clear out the class variables, so the next query can be run]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="1325" package="">
|
|
<name>_compile</name>
|
|
<type>function</type>
|
|
<docblock line="1318">
|
|
<description><![CDATA[String together the sql statements for sending to the db]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1318" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1318" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1318" name="return" description="" type="\$string">
|
|
<type by_reference="false">\$string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1325">
|
|
<name>$type</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1325">
|
|
<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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="true" namespace="default" line="22" package="Query\Query">
|
|
<name>DB_Util</name>
|
|
<full_name>\DB_Util</full_name>
|
|
<extends/>
|
|
<docblock line="16">
|
|
<description><![CDATA[Abstract class defining database / table creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="private" line="27" package="Default">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="24">
|
|
<description><![CDATA[Reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="34" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="29">
|
|
<description><![CDATA[Save a reference to the connection object for later use]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="29" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="34">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
|
|
<name>__call</name>
|
|
<type>function</type>
|
|
<docblock line="41">
|
|
<description><![CDATA[Enable calling driver methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="41" name="param" description="" type="string" variable="$method">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="41" name="param" description="" type="array" variable="$args">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="47">
|
|
<name>$method</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$args</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="71" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="61">
|
|
<description><![CDATA[Get database-specific sql to create a new table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="61" name="abstract" description=""/>
|
|
<tag line="61" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="61" name="param" description="" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="61" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="61" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="61" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="71">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="71">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="71">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="71">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="80" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="73">
|
|
<description><![CDATA[Get database-specific sql to drop a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="73" name="abstract" description=""/>
|
|
<tag line="73" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="73" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="80">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="88" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="82">
|
|
<description><![CDATA[Return an SQL file with the database table structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="82" name="abstract" description=""/>
|
|
<tag line="82" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="96" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="90">
|
|
<description><![CDATA[Return an SQL file with the database data as insert statements]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="90" name="abstract" description=""/>
|
|
<tag line="90" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<constant namespace="default" line="23" package="Default">
|
|
<name>BASE_PATH</name>
|
|
<value><![CDATA[dirname(__FILE__).'/']]></value>
|
|
<docblock line="20">
|
|
<description><![CDATA[Reference to root path]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</constant>
|
|
<constant namespace="default" line="28" package="Default">
|
|
<name>DRIVER_PATH</name>
|
|
<value><![CDATA[BASE_PATH.'drivers/']]></value>
|
|
<docblock line="25">
|
|
<description><![CDATA[Path to driver classes]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</constant>
|
|
<function namespace="default" line="39" package="Query">
|
|
<name>do_include</name>
|
|
<type>function</type>
|
|
<docblock line="32">
|
|
<description><![CDATA[Bulk directory loading workaround for use
|
|
with array_map and glob]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="32" name="param" description="" type="string" variable="$path">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="32" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="39">
|
|
<name>$path</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</function>
|
|
<function namespace="default" line="74" package="Query">
|
|
<name>db_filter</name>
|
|
<type>function</type>
|
|
<docblock line="67">
|
|
<description><![CDATA[Filter out db rows into one array]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="67" name="param" description="" type="array" variable="$array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="67" name="param" description="" type="mixed" variable="$index">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="67" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="74">
|
|
<name>$array</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="74">
|
|
<name>$index</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</function>
|
|
</file>
|
|
<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>
|
|
<class final="false" abstract="false" namespace="default" line="21" package="Query\Drivers">
|
|
<name>PgSQL_SQL</name>
|
|
<full_name>\PgSQL_SQL</full_name>
|
|
<extends>\DB_SQL</extends>
|
|
<docblock line="15">
|
|
<description><![CDATA[PostgreSQL specifc SQL]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="15" name="package" description="Query"/>
|
|
<tag line="15" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="31" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="23">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="23" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="23" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="23" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="23" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="31">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="31">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="31">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="50" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="45">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="45" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="57">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="57" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="78" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="73">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="73" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="96" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="91">
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="91" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="114" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="109">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="109" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="132" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="127">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="127" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="149" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="144">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="144" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="161" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="156">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="156" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="174">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="174" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="197" package="">
|
|
<name>column_list</name>
|
|
<type>function</type>
|
|
<docblock line="191">
|
|
<description><![CDATA[Return sql to list columns of the specified table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="191" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="191" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="197">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>PgSQL_Util</name>
|
|
<full_name>\PgSQL_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Posgres-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="35">
|
|
<description><![CDATA[Database-specific method to create a new table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="35" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="35" name="param" description="" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="35" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="35" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="35" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="44">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="44">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="44">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="44">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="100" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="94">
|
|
<description><![CDATA[Database-specific SQL for dropping a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="94" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="94" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="100">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="112" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="107">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="107" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="126" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="120">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="120" name="param" description="" type="array" variable="$exclude">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="120" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="126">
|
|
<name>$exclude</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/pgsql/pgsql_driver.php" hash="3be55bee617eba8379a38cd5a2657aad" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>PgSQL</name>
|
|
<full_name>\PgSQL</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[PostgreSQL specifc class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Connect to a PosgreSQL database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="string" variable="$username">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="string" variable="$password">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="array" variable="$options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$username</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$password</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$options</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
|
|
<name>switch_db</name>
|
|
<type>function</type>
|
|
<docblock line="39">
|
|
<description><![CDATA[Connect to a different database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="39" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="44">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="57" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="52">
|
|
<description><![CDATA[Empty a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="52" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="57">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="70" package="">
|
|
<name>get_schemas</name>
|
|
<type>function</type>
|
|
<docblock line="65">
|
|
<description><![CDATA[Get a list of schemas for the current connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="65" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/odbc/odbc_util.php" hash="e3254c43700cf53c79566c0590e5ca29" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>ODBC_Util</name>
|
|
<full_name>\ODBC_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[ODBC-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="46" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="37">
|
|
<description><![CDATA[Database-specific method to create a new table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="37" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="46">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="60" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="54">
|
|
<description><![CDATA[Remove a table from the database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="54" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="54" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="60">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="72" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="67">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="67" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="85" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="80">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="80" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/odbc/odbc_sql.php" hash="09d03f4e6a98823cdb5e78b23eae2ac0" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>ODBC_SQL</name>
|
|
<full_name>\ODBC_SQL</full_name>
|
|
<extends>\DB_SQL</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[ODBC SQL Class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="39">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="39" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="51">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="51" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="63">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="63" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="80" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="75">
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="75" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="92" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="87">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="87" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="104" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="99">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="99" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="111">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="111" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="123">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="123" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="140" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="135">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="135" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/odbc/odbc_driver.php" hash="345f3b133f34abb5ffaa785e058b1178" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="24" package="Query\Drivers">
|
|
<name>ODBC</name>
|
|
<full_name>\ODBC</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[ODBC Database Driver]]></description>
|
|
<long-description><![CDATA[<p>For general database access for databases not specified by the main drivers</p>]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="29" package="Default">
|
|
<name>$escape_char</name>
|
|
<default><![CDATA['']]></default>
|
|
<docblock line="26">
|
|
<description><![CDATA[Don't define the escape char - or define it in sub-drivers in a refactor]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="31">
|
|
<description><![CDATA[Use ODBC to connect to a database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="31" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$username">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$password">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="array" variable="$options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="39">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$username</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$password</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$options</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
|
|
<name>switch_db</name>
|
|
<type>function</type>
|
|
<docblock line="46">
|
|
<description><![CDATA[Doesn't apply to ODBC]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="46" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="46" name="return" description="" type="bool">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="52">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="65" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="59">
|
|
<description><![CDATA[Empty the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="59" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="59" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="65">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>MySQL_Util</name>
|
|
<full_name>\MySQL_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[MySQL-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="37">
|
|
<description><![CDATA[Convienience public function for creating a new MySQL table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="37" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="47">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="113" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="107">
|
|
<description><![CDATA[Convience public function for droping a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="107" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="107" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="113">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="125" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="120">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="120" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="139" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="133">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="133" name="param" description="" type="array" variable="$exclude">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="133" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="139">
|
|
<name>$exclude</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/mysql/mysql_driver.php" hash="0561fe57bbfa8b513a096ef66e1bf193" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>MySQL</name>
|
|
<full_name>\MySQL</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[MySQL specific class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="29" package="Default">
|
|
<name>$escape_char</name>
|
|
<default><![CDATA['`']]></default>
|
|
<docblock line="24">
|
|
<description><![CDATA[Set the backtick as the MySQL escape character]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="31">
|
|
<description><![CDATA[Connect to MySQL Database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="31" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$username">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$password">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="array" variable="$options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="39">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$username</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$password</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$options</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="55" package="">
|
|
<name>switch_db</name>
|
|
<type>function</type>
|
|
<docblock line="50">
|
|
<description><![CDATA[Connect to a different database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="50" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="55">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="63">
|
|
<description><![CDATA[Empty a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="63" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="68">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>MySQL_SQL</name>
|
|
<full_name>\MySQL_SQL</full_name>
|
|
<extends>\DB_SQL</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[MySQL specifc SQL]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="44">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="44" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="56">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="56" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="68">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="68" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="85" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="80">
|
|
<description><![CDATA[Overridden in MySQL class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="80" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="98" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="93">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="93" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="110" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="105">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="105" 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="122" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="117">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="117" 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="134" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="129">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="129" 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="146" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="141">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="141" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>SQLite_Util</name>
|
|
<full_name>\SQLite_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[SQLite-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="46" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="37">
|
|
<description><![CDATA[Convenience public function to create a new table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="37" name="param" description="//Name of the table" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="//columns as straight array and/or column => type pairs" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="// column => constraint pairs" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="// column => index pairs" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="46">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="96">
|
|
<description><![CDATA[SQL to drop the specified table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="96" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="96" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="102">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="109">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="109" name="param" description="" type="array" variable="$excluded">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="109" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="115">
|
|
<name>$excluded</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="174">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="174" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/sqlite/sqlite_driver.php" hash="d32d8a174c1770f558b6810f47ea8869" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>SQLite</name>
|
|
<full_name>\SQLite</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[SQLite specific class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="29" package="Default">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="24">
|
|
<description><![CDATA[Reference to the last executed sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="var" description="" type="\PDOStatement">
|
|
<type by_reference="false">\PDOStatement</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="38" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="31">
|
|
<description><![CDATA[Open SQLite Database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="31" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$user">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$pass">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="38">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="38">
|
|
<name>$user</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="38">
|
|
<name>$pass</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="51" package="">
|
|
<name>switch_db</name>
|
|
<type>function</type>
|
|
<docblock line="46">
|
|
<description><![CDATA[Doesn't apply to sqlite]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="46" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="51">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="63" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="58">
|
|
<description><![CDATA[Empty a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="58" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="63">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
|
|
<name>get_tables</name>
|
|
<type>function</type>
|
|
<docblock line="76">
|
|
<description><![CDATA[List tables for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="76" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
|
|
<name>get_system_tables</name>
|
|
<type>function</type>
|
|
<docblock line="97">
|
|
<description><![CDATA[List system tables for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="97" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="117" package="">
|
|
<name>load_database</name>
|
|
<type>function</type>
|
|
<docblock line="111">
|
|
<description><![CDATA[Load a database for the current connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="111" name="param" description="" type="string" variable="$db">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="111" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="117">
|
|
<name>$db</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="117">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
|
|
<name>unload_database</name>
|
|
<type>function</type>
|
|
<docblock line="125">
|
|
<description><![CDATA[Unload a database from the current connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="125" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="130">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>SQLite_SQL</name>
|
|
<full_name>\SQLite_SQL</full_name>
|
|
<extends>\DB_SQL</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[SQLite Specific SQL]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="44">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="44" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="56">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="56" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="68">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="68" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="85">
|
|
<description><![CDATA[Overridden in SQLite class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="85" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="97">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="97" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="111">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="111" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="123">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="123" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="140" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="135">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="135" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="152" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="147">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="147" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>Firebird_SQL</name>
|
|
<full_name>\Firebird_SQL</full_name>
|
|
<extends>\DB_SQL</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Firebird Specific SQL]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="51">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="51" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="64">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="64" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="76">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="76" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="98" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="93">
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="93" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="110">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="110" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="125">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="125" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="145" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="140">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="140" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="157" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="152">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="152" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="185" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="180">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="180" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="202" package="">
|
|
<name>column_list</name>
|
|
<type>function</type>
|
|
<docblock line="196">
|
|
<description><![CDATA[Return sql to list columns of the specified table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="196" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="196" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="202">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="23" package="Query\Drivers">
|
|
<name>Firebird_Result</name>
|
|
<full_name>\Firebird_Result</full_name>
|
|
<extends>\PDOStatement</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Firebird result class to emulate PDOStatement Class - only implements
|
|
data-fetching methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="private" line="30" package="Default">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="25">
|
|
<description><![CDATA[Reference to fbird resource]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="25" name="var" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="37" package="Default">
|
|
<name>$row</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="32">
|
|
<description><![CDATA[Current row in result array]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="32" name="var" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="44" package="Default">
|
|
<name>$result</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<docblock line="39">
|
|
<description><![CDATA[Data pulled from query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="39" name="param" description="mixed" type="" variable=""/>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="46">
|
|
<description><![CDATA[Create the object by passing the resource for
|
|
the query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="46" name="param" description="" type="resource" variable="$link">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="52">
|
|
<name>$link</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="83" package="">
|
|
<name>bindColumn</name>
|
|
<type>function</type>
|
|
<docblock line="73">
|
|
<description><![CDATA[Invalidate method for data consistency]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="73" name="param" description="" type="mixed" variable="$column">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="73" name="param" description="&$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="&$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="&$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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="24" package="Query\Drivers">
|
|
<name>Firebird</name>
|
|
<full_name>\Firebird</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Firebird Database class]]></description>
|
|
<long-description><![CDATA[<p>PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.</p>]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="31" package="Default">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="26">
|
|
<description><![CDATA[Reference to the last query executed]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="26" name="var" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="39" package="Default">
|
|
<name>$statement_link</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="33">
|
|
<description><![CDATA[Reference to the resource returned by
|
|
the last query executed]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="33" name="var" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="46" package="Default">
|
|
<name>$trans</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="41">
|
|
<description><![CDATA[Reference to the current transaction]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="41" name="var" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="53" package="Default">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="48">
|
|
<description><![CDATA[Reference to the connection resource]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="48" name="var" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="55">
|
|
<description><![CDATA[Open the link to the database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="55" name="param" description="" type="string" variable="$dbpath">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="55" name="param" description="" type="string" variable="$user">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="55" name="param" description="" type="string" variable="$pass">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="62">
|
|
<name>$dbpath</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="62">
|
|
<name>$user</name>
|
|
<default><![CDATA['sysdba']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="62">
|
|
<name>$pass</name>
|
|
<default><![CDATA['masterkey']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="95" package="">
|
|
<name>switch_db</name>
|
|
<type>function</type>
|
|
<docblock line="89">
|
|
<description><![CDATA[Doesn't apply to Firebird]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="89" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="89" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="95">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="107" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="102">
|
|
<description><![CDATA[Empty a database table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="102" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="107">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="122" package="">
|
|
<name>query</name>
|
|
<type>function</type>
|
|
<docblock line="116">
|
|
<description><![CDATA[Wrapper public function to better match PDO]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="116" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="116" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="122">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="148" package="">
|
|
<name>prepare</name>
|
|
<type>function</type>
|
|
<docblock line="141">
|
|
<description><![CDATA[Emulate PDO prepare]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="141" name="param" description="" type="string" variable="$query">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="141" name="param" description="" type="array" variable="$options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="141" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="148">
|
|
<name>$query</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="148">
|
|
<name>$options</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="170" package="">
|
|
<name>beginTransaction</name>
|
|
<type>function</type>
|
|
<docblock line="165">
|
|
<description><![CDATA[Start a database transaction]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="165" name="return" description="" type="bool">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="187" package="">
|
|
<name>commit</name>
|
|
<type>function</type>
|
|
<docblock line="182">
|
|
<description><![CDATA[Commit a database transaction]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="182" name="return" description="" type="bool">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="199" package="">
|
|
<name>rollBack</name>
|
|
<type>function</type>
|
|
<docblock line="194">
|
|
<description><![CDATA[Rollback a transaction]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="194" name="return" description="" type="bool">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="213" package="">
|
|
<name>prepare_execute</name>
|
|
<type>function</type>
|
|
<docblock line="206">
|
|
<description><![CDATA[Prepare and execute a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="206" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="206" name="param" description="" type="array" variable="$args">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="206" name="return" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="213">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="213">
|
|
<name>$args</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="232" package="">
|
|
<name>quote</name>
|
|
<type>function</type>
|
|
<docblock line="225">
|
|
<description><![CDATA[Method to emulate PDO->quote]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="225" name="param" description="" type="string" variable="$str">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="225" name="param" description="" type="int" variable="$param_type">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="225" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="232">
|
|
<name>$str</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="232">
|
|
<name>$param_type</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="249" package="">
|
|
<name>errorInfo</name>
|
|
<type>function</type>
|
|
<docblock line="244">
|
|
<description><![CDATA[Method to emulate PDO->errorInfo / PDOStatement->errorInfo]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="244" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="264" package="">
|
|
<name>errorCode</name>
|
|
<type>function</type>
|
|
<docblock line="259">
|
|
<description><![CDATA[Method to emulate PDO->errorCode]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="259" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="278" package="">
|
|
<name>prepare_query</name>
|
|
<type>function</type>
|
|
<docblock line="271">
|
|
<description><![CDATA[Bind a prepared query with arguments for executing]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="271" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="271" name="param" description="" type="array" variable="$params">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="271" name="return" description="" type="FALSE">
|
|
<type by_reference="false">FALSE</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="278">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="278">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="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>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>Firebird_Util</name>
|
|
<full_name>\Firebird_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Firebird-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="37">
|
|
<description><![CDATA[Convienience public function to generate sql for creating a db table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="37" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$fields">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="47">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$fields</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="103" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="97">
|
|
<description><![CDATA[Drop the selected table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="97" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="97" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="103">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="110">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="110" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="123">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="123" name="param" description="" type="array" variable="$exclude">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="123" name="param" description="" type="bool" variable="$system_tables">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="123" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="130">
|
|
<name>$exclude</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="130">
|
|
<name>$system_tables</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<package name="" full_name=""/>
|
|
<package name="Default" full_name="Default"/>
|
|
<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>
|