6446 lines
284 KiB
XML
6446 lines
284 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<project version="2.0.0a2" title="OpenSQLManager">
|
||
|
|
<file path="sys/db/classes/db_reg.php" hash="3ecb4dc76cb6487a3c7a0ec5bd68b2bb" 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="Default">
|
||
|
|
<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>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="true" visibility="private" line="26" package="Default">
|
||
|
|
<name>$instance</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<docblock line="23">
|
||
|
|
<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="34" package="">
|
||
|
|
<name>get_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="28">
|
||
|
|
<description><![CDATA[Registry access method]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="28" name="param" description="" type="string" variable="$key">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="28" name="return" description="" type="object">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="34">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="52" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="47">
|
||
|
|
<description><![CDATA[Private constructor]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="47" name="param" description="" type="string" variable="$key">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="52">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="68" package="">
|
||
|
|
<name>get_connections</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="63">
|
||
|
|
<description><![CDATA[Return exiting connections]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="63" 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="81" package="">
|
||
|
|
<name>remove_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="75">
|
||
|
|
<description><![CDATA[Remove a database connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="75" name="param" description="" type="string" variable="$key">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="75" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="81">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/classes/settings.php" hash="bc583190579c14a480c318b5eb066cfd" 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="20" package="Default">
|
||
|
|
<name>Settings</name>
|
||
|
|
<full_name>\Settings</full_name>
|
||
|
|
<extends/>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Class for manipulating datbase connections, and miscellaneous settings]]></description>
|
||
|
|
<long-description><![CDATA[<p>Use JSON for compatibility</p>]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="private" line="25" package="Default">
|
||
|
|
<name>$current</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="22">
|
||
|
|
<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="30" package="Default">
|
||
|
|
<name>$instance</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="27">
|
||
|
|
<description><![CDATA[Singleton instance]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="38" package="">
|
||
|
|
<name>get_instance</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="32">
|
||
|
|
<description><![CDATA[Static method to retreive current instance
|
||
|
|
of the singleton]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="32" 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="53" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="49">
|
||
|
|
<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="88" package="">
|
||
|
|
<name>__destruct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="85">
|
||
|
|
<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="105" package="">
|
||
|
|
<name>__get</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="99">
|
||
|
|
<description><![CDATA[Magic method to simplify isset checking for config options]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="99" name="param" description="" type="string" variable="$key">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="99" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="105">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="120" package="">
|
||
|
|
<name>__set</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="114">
|
||
|
|
<description><![CDATA[Magic method to simplify setting config options]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="114" name="param" description="" type="string" variable="$key">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="114" name="param" description="mixed" type="" variable="$val"/>
|
||
|
|
</docblock>
|
||
|
|
<argument line="120">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="120">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="139" package="">
|
||
|
|
<name>add_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="133">
|
||
|
|
<description><![CDATA[Add a database connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="133" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="133" name="param" description="" type="array" variable="$params">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="139">
|
||
|
|
<name>$name</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="171" package="">
|
||
|
|
<name>edit_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="165">
|
||
|
|
<description><![CDATA[Edit a database connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="165" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="165" name="param" description="" type="array" variable="$params">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="171">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="171">
|
||
|
|
<name>$params</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="214" package="">
|
||
|
|
<name>remove_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="209">
|
||
|
|
<description><![CDATA[Remove a database connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="209" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="214">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="235" package="">
|
||
|
|
<name>get_dbs</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="230">
|
||
|
|
<description><![CDATA[Retreive all db connections]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="230" 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="248" package="">
|
||
|
|
<name>get_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="242">
|
||
|
|
<description><![CDATA[Retreive a specific database connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="242" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="242" name="return" description="" type="object">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="248">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/classes/db_sql.php" hash="0c64dbfafa6060298a5729483e91be45" 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="true" namespace="default" line="18" package="Default">
|
||
|
|
<name>DB_SQL</name>
|
||
|
|
<full_name>\DB_SQL</full_name>
|
||
|
|
<extends/>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Abstract parent for database manipulation subclasses]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="29" package="">
|
||
|
|
<name>max</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="24">
|
||
|
|
<description><![CDATA[Get the max keyword sql]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="24" 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="41" package="">
|
||
|
|
<name>min</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="36">
|
||
|
|
<description><![CDATA[Get the min keyword sql]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="36" 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="53" package="">
|
||
|
|
<name>distinct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="48">
|
||
|
|
<description><![CDATA[Get the 'distinct' keyword]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="48" 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="65" package="">
|
||
|
|
<name>avg</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="60">
|
||
|
|
<description><![CDATA[Get the 'average' keyword]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="60" 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="77" package="">
|
||
|
|
<name>sum</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="72">
|
||
|
|
<description><![CDATA[Get the 'sum' keyword]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="72" 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="95" package="">
|
||
|
|
<name>limit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="86">
|
||
|
|
<description><![CDATA[Get database specific sql for limit clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="86" name="abstract" description=""/>
|
||
|
|
<tag line="86" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="86" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="86" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="86" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="95">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="95">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="95">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="103" package="">
|
||
|
|
<name>random</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="97">
|
||
|
|
<description><![CDATA[Get the sql for random ordering]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="97" name="abstract" description=""/>
|
||
|
|
<tag line="97" 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="110" package="">
|
||
|
|
<name>db_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="105">
|
||
|
|
<description><![CDATA[Returns sql to list other databases]]></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="true" static="false" visibility="public" namespace="default" line="117" package="">
|
||
|
|
<name>table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="112">
|
||
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="112" 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="124" package="">
|
||
|
|
<name>system_table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="119">
|
||
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="119" 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="131" package="">
|
||
|
|
<name>view_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="126">
|
||
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="126" 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="138" package="">
|
||
|
|
<name>trigger_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="133">
|
||
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="133" 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="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="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="152" package="">
|
||
|
|
<name>procedure_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="147">
|
||
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="147" 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="159" package="">
|
||
|
|
<name>sequence_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="154">
|
||
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="154" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/classes/db_pdo.php" hash="f8fb05f7bfffa3062ed7fa381028064d" 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="true" namespace="default" line="20" package="Default">
|
||
|
|
<name>DB_PDO</name>
|
||
|
|
<full_name>\DB_PDO</full_name>
|
||
|
|
<extends>\PDO</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Base Database class]]></description>
|
||
|
|
<long-description><![CDATA[<p>Extends PDO to simplify cross-database issues</p>]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="25" package="Default">
|
||
|
|
<name>$statement</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="22">
|
||
|
|
<description><![CDATA[Reference to the last executed query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="30" package="Default">
|
||
|
|
<name>$escape_char</name>
|
||
|
|
<default><![CDATA['"']]></default>
|
||
|
|
<docblock line="27">
|
||
|
|
<description><![CDATA[Character to escape identifiers]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="public" line="35" package="Default">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="32">
|
||
|
|
<description><![CDATA[Reference to sql sub class]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="public" line="40" package="Default">
|
||
|
|
<name>$util</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="37">
|
||
|
|
<description><![CDATA[Reference to util sub class]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="50" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="42">
|
||
|
|
<description><![CDATA[PDO constructor wrapper]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="42" name="param" description="" type="string" variable="$dsn">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="42" name="param" description="" type="string" variable="$username">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="42" name="param" description="" type="string" variable="$password">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="42" name="param" description="" type="array" variable="$driver_options">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="50">
|
||
|
|
<name>$dsn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="50">
|
||
|
|
<name>$username</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="50">
|
||
|
|
<name>$password</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="50">
|
||
|
|
<name>$driver_options</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="76" package="">
|
||
|
|
<name>prepare_query</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="69">
|
||
|
|
<description><![CDATA[Simplifies prepared statements for database queries]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="69" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="69" name="param" description="" type="array" variable="$data">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="69" name="return" description="PDOStatement / FALSE" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="76">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="76">
|
||
|
|
<name>$data</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="127" package="">
|
||
|
|
<name>prepare_execute</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="120">
|
||
|
|
<description><![CDATA[Create and execute a prepared statement with the provided parameters]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="120" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="120" name="param" description="" type="array" variable="$params">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="120" name="return" description="" type="\PDOStatement">
|
||
|
|
<type by_reference="false">\PDOStatement</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="127">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="127">
|
||
|
|
<name>$params</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="143" package="">
|
||
|
|
<name>get_query_data</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="137">
|
||
|
|
<description><![CDATA[Retreives the data from a select query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="137" name="param" description="" type="\PDOStatement" variable="$statement">
|
||
|
|
<type by_reference="false">\PDOStatement</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="137" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="143">
|
||
|
|
<name>$statement</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="162" package="">
|
||
|
|
<name>affected_rows</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="156">
|
||
|
|
<description><![CDATA[Returns number of rows affected by an INSERT, UPDATE, DELETE type query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="156" name="param" description="" type="\PDOStatement" variable="$statement">
|
||
|
|
<type by_reference="false">\PDOStatement</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="156" name="return" description="" type="int">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="162">
|
||
|
|
<name>$statement</name>
|
||
|
|
<default><![CDATA['']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="180" package="">
|
||
|
|
<name>get_last_error</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="175">
|
||
|
|
<description><![CDATA[Return the last error for the current database connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="175" 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="195" package="">
|
||
|
|
<name>quote_ident</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="189">
|
||
|
|
<description><![CDATA[Surrounds the string with the databases identifier escape characters]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="189" name="param" description="" type="mixed" variable="$ident">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="189" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="195">
|
||
|
|
<name>$ident</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="219" package="">
|
||
|
|
<name>empty_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="212">
|
||
|
|
<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="212" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="212" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="219">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="233" package="">
|
||
|
|
<name>get_schemas</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="228">
|
||
|
|
<description><![CDATA[Return schemas for databases that list them]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="228" 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="245" package="">
|
||
|
|
<name>get_tables</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="240">
|
||
|
|
<description><![CDATA[Return list of tables for the current database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="240" 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="257" package="">
|
||
|
|
<name>get_dbs</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="252">
|
||
|
|
<description><![CDATA[Return list of dbs for the current connection, if possible]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="252" 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="269" package="">
|
||
|
|
<name>get_views</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="264">
|
||
|
|
<description><![CDATA[Return list of views for the current database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="264" 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="281" package="">
|
||
|
|
<name>get_sequences</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="276">
|
||
|
|
<description><![CDATA[Return list of sequences for the current database, if they exist]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="276" 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="293" package="">
|
||
|
|
<name>get_functions</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="288">
|
||
|
|
<description><![CDATA[Return list of function for the current database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="288" 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="305" package="">
|
||
|
|
<name>get_procedures</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="300">
|
||
|
|
<description><![CDATA[Return list of stored procedures for the current database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="300" 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="317" package="">
|
||
|
|
<name>get_triggers</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="312">
|
||
|
|
<description><![CDATA[Return list of triggers for the current database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="312" 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="330" package="">
|
||
|
|
<name>get_system_tables</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="324">
|
||
|
|
<description><![CDATA[Retreives an array of non-user-created tables for
|
||
|
|
the connection/database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="324" 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="344" package="">
|
||
|
|
<name>driver_query</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="337">
|
||
|
|
<description><![CDATA[Method to simplify retreiving db results for meta-data queries]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="337" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="337" name="param" description="" type="bool" variable="$filtered_index">
|
||
|
|
<type by_reference="false">bool</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="337" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="344">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="344">
|
||
|
|
<name>$filtered_index</name>
|
||
|
|
<default><![CDATA[TRUE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="370" package="">
|
||
|
|
<name>truncate</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="363">
|
||
|
|
<description><![CDATA[Empty the passed table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="363" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="363" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="370">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="377" package="">
|
||
|
|
<name>num_rows</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="372">
|
||
|
|
<description><![CDATA[Return the number of rows for the last SELECT query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="372" 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="385" package="">
|
||
|
|
<name>switch_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="379">
|
||
|
|
<description><![CDATA[Connect to a different database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="379" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="379" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="385">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/classes/query_builder.php" hash="d375a099b358b3df40da4afd58a5e279" 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="19" package="Default">
|
||
|
|
<name>Query_Builder</name>
|
||
|
|
<full_name>\Query_Builder</full_name>
|
||
|
|
<extends/>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Convienience class for creating sql queries - also the class that
|
||
|
|
instantiates the specific db driver]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="private" line="24" package="Default">
|
||
|
|
<name>$select_string</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="21">
|
||
|
|
<description><![CDATA[Compiled 'select' clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="29" package="Default">
|
||
|
|
<name>$from_string</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="26">
|
||
|
|
<description><![CDATA[Compiled 'from' clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="34" package="Default">
|
||
|
|
<name>$set_string</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="31">
|
||
|
|
<description><![CDATA[Compiled arguments for insert / update]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="39" package="Default">
|
||
|
|
<name>$order_string</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="36">
|
||
|
|
<description><![CDATA[Order by clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="44" package="Default">
|
||
|
|
<name>$group_string</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="41">
|
||
|
|
<description><![CDATA[Group by clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="51" package="Default">
|
||
|
|
<name>$set_array</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="48">
|
||
|
|
<description><![CDATA[key/val pairs for insert/update statement]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="56" package="Default">
|
||
|
|
<name>$set_array_keys</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="53">
|
||
|
|
<description><![CDATA[Keys for insert/update statement]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="61" package="Default">
|
||
|
|
<name>$order_array</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="58">
|
||
|
|
<description><![CDATA[Key/val pairs for order by clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="66" package="Default">
|
||
|
|
<name>$group_array</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="63">
|
||
|
|
<description><![CDATA[Key/val pairs for group by clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="73" package="Default">
|
||
|
|
<name>$values</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="70">
|
||
|
|
<description><![CDATA[Values to apply to prepared statements]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="78" package="Default">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="75">
|
||
|
|
<description><![CDATA[Value for limit string]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="83" package="Default">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="80">
|
||
|
|
<description><![CDATA[Value for offset in limit string]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="88" package="Default">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="85">
|
||
|
|
<description><![CDATA[Alias to $this->db->sql]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="102" package="Default">
|
||
|
|
<name>$query_map</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="90">
|
||
|
|
<description><![CDATA[Query component order mapping
|
||
|
|
for complex select queries]]></description>
|
||
|
|
<long-description><![CDATA[<p>Format:</p>
|
||
|
|
|
||
|
|
<p>array(
|
||
|
|
'type' => 'where',
|
||
|
|
'conjunction' => ' AND ',
|
||
|
|
'string' => 'k=?'
|
||
|
|
)</p>]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="107" package="Default">
|
||
|
|
<name>$having_map</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="104">
|
||
|
|
<description><![CDATA[Map for having clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="public" line="112" package="Default">
|
||
|
|
<name>$conn_name</name>
|
||
|
|
<default><![CDATA[""]]></default>
|
||
|
|
<docblock line="109">
|
||
|
|
<description><![CDATA[Convenience property for connection management]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="123" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="118">
|
||
|
|
<description><![CDATA[Constructor]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="118" name="param" description="- the connection parametere" type="object" variable="$params">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="123">
|
||
|
|
<name>$params</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="203" package="">
|
||
|
|
<name>select</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="197">
|
||
|
|
<description><![CDATA[Specifies rows to select in a query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="197" name="param" description="" type="string" variable="$fields">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="197" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="203">
|
||
|
|
<name>$fields</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="249" package="">
|
||
|
|
<name>select_max</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="242">
|
||
|
|
<description><![CDATA[Selects the maximum value of a field from a query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="242" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="242" name="param" description="" type="string" variable="$as">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="242" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="249">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="249">
|
||
|
|
<name>$as</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="273" package="">
|
||
|
|
<name>select_min</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="266">
|
||
|
|
<description><![CDATA[Selects the minimum value of a field from a query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="266" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="266" name="param" description="" type="string" variable="$as">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="266" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="273">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="273">
|
||
|
|
<name>$as</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="297" package="">
|
||
|
|
<name>select_avg</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="290">
|
||
|
|
<description><![CDATA[Selects the average value of a field from a query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="290" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="290" name="param" description="" type="string" variable="$as">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="290" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="297">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="297">
|
||
|
|
<name>$as</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="321" package="">
|
||
|
|
<name>select_sum</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="314">
|
||
|
|
<description><![CDATA[Selects the sum of a field from a query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="314" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="314" name="param" description="" type="string" variable="$as">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="314" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="321">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="321">
|
||
|
|
<name>$as</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="343" package="">
|
||
|
|
<name>distinct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="338">
|
||
|
|
<description><![CDATA[Adds the 'distinct' keyword to a query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="338" 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="359" package="">
|
||
|
|
<name>from</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="353">
|
||
|
|
<description><![CDATA[Specify the database table to select from]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="353" name="param" description="" type="string" variable="$dbname">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="353" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="359">
|
||
|
|
<name>$dbname</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="386" package="">
|
||
|
|
<name>like</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="378">
|
||
|
|
<description><![CDATA[Creates a Like clause in the sql statement]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="378" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="378" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="378" name="param" description="" type="string" variable="$pos">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="378" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="386">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="386">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="386">
|
||
|
|
<name>$pos</name>
|
||
|
|
<default><![CDATA['both']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="428" package="">
|
||
|
|
<name>or_like</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="420">
|
||
|
|
<description><![CDATA[Generates an OR Like clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="420" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="420" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="420" name="param" description="" type="string" variable="$pos">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="420" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="428">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="428">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="428">
|
||
|
|
<name>$pos</name>
|
||
|
|
<default><![CDATA['both']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="470" package="">
|
||
|
|
<name>not_like</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="462">
|
||
|
|
<description><![CDATA[Generates a NOT LIKE clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="462" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="462" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="462" name="param" description="" type="string" variable="$pos">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="462" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="470">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="470">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="470">
|
||
|
|
<name>$pos</name>
|
||
|
|
<default><![CDATA['both']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="512" package="">
|
||
|
|
<name>or_not_like</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="504">
|
||
|
|
<description><![CDATA[Generates a OR NOT LIKE clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="504" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="504" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="504" name="param" description="" type="string" variable="$pos">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="504" name="return" description="" type="\$this;">
|
||
|
|
<type by_reference="false">\$this;</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="512">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="512">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="512">
|
||
|
|
<name>$pos</name>
|
||
|
|
<default><![CDATA['both']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="553" package="">
|
||
|
|
<name>having</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="546">
|
||
|
|
<description><![CDATA[Generates a 'Having' clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="546" name="param" description="" type="mixed" variable="$key">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="546" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="546" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="553">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="553">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="588" package="">
|
||
|
|
<name>or_having</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="581">
|
||
|
|
<description><![CDATA[Generates a 'Having' clause prefixed with 'OR']]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="581" name="param" description="" type="mixed" variable="$key">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="581" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="581" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="588">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="588">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="625" package="">
|
||
|
|
<name>_where</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="618">
|
||
|
|
<description><![CDATA[Do all the repeditive stuff for where/having type methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="618" name="param" description="" type="mixed" variable="$key">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="618" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="618" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="625">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="625">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="659" package="">
|
||
|
|
<name>where</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="650">
|
||
|
|
<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="650" name="param" description="" type="mixed" variable="$key">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="650" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="650" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="659">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="659">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="695" package="">
|
||
|
|
<name>or_where</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="688">
|
||
|
|
<description><![CDATA[Where clause prefixed with "OR"]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="688" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="688" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="688" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="695">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="695">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="736" package="">
|
||
|
|
<name>where_in</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="729">
|
||
|
|
<description><![CDATA[Where clause with 'IN' statement]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="729" name="param" description="" type="mixed" variable="$field">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="729" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="729" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="736">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="736">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="766" package="">
|
||
|
|
<name>or_where_in</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="759">
|
||
|
|
<description><![CDATA[Where in statement prefixed with "or"]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="759" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="759" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="759" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="766">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="766">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="796" package="">
|
||
|
|
<name>where_not_in</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="789">
|
||
|
|
<description><![CDATA[WHERE NOT IN (FOO) clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="789" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="789" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="789" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="796">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="796">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="826" package="">
|
||
|
|
<name>or_where_not_in</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="819">
|
||
|
|
<description><![CDATA[OR WHERE NOT IN (FOO) clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="819" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="819" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="819" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="826">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="826">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="858" package="">
|
||
|
|
<name>set</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="851">
|
||
|
|
<description><![CDATA[Sets values for inserts / updates / deletes]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="851" name="param" description="" type="mixed" variable="$key">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="851" name="param" description="" type="mixed" variable="$val">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="851" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="858">
|
||
|
|
<name>$key</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="858">
|
||
|
|
<name>$val</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="897" package="">
|
||
|
|
<name>join</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="889">
|
||
|
|
<description><![CDATA[Creates a join phrase in a compiled query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="889" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="889" name="param" description="" type="string" variable="$condition">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="889" name="param" description="" type="string" variable="$type">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="889" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="897">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="897">
|
||
|
|
<name>$condition</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="897">
|
||
|
|
<name>$type</name>
|
||
|
|
<default><![CDATA['']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="925" package="">
|
||
|
|
<name>group_by</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="919">
|
||
|
|
<description><![CDATA[Group the results by the selected field(s)]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="919" name="param" description="" type="mixed" variable="$field">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="919" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="925">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="950" package="">
|
||
|
|
<name>order_by</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="943">
|
||
|
|
<description><![CDATA[Order the results by the selected field(s)]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="943" name="param" description="" type="string" variable="$field">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="943" name="param" description="" type="string" variable="$type">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="943" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="950">
|
||
|
|
<name>$field</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="950">
|
||
|
|
<name>$type</name>
|
||
|
|
<default><![CDATA[""]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="987" package="">
|
||
|
|
<name>limit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="980">
|
||
|
|
<description><![CDATA[Set a limit on the current sql statement]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="980" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="980" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="980" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="987">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="987">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1004" package="">
|
||
|
|
<name>group_start</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="999">
|
||
|
|
<description><![CDATA[Adds a paren to the current query for query grouping]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="999" 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="1023" package="">
|
||
|
|
<name>or_group_start</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1017">
|
||
|
|
<description><![CDATA[Adds a paren to the current query for query grouping,
|
||
|
|
prefixed with 'OR']]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1017" 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="1042" package="">
|
||
|
|
<name>or_not_group_start</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1036">
|
||
|
|
<description><![CDATA[Adds a paren to the current query for query grouping,
|
||
|
|
prefixed with 'OR NOT']]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1036" 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="1060" package="">
|
||
|
|
<name>group_end</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1055">
|
||
|
|
<description><![CDATA[Ends a query group]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1055" 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="1084" package="">
|
||
|
|
<name>get</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1075">
|
||
|
|
<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="1075" name="param" description="" type="" variable="$table"/>
|
||
|
|
<tag line="1075" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1075" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1075" name="return" description="" type="object">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1084">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA['']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1084">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1084">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1128" package="">
|
||
|
|
<name>get_where</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1119">
|
||
|
|
<description><![CDATA[Convience method for get() with a where clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1119" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1119" name="param" description="" type="array" variable="$where">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1119" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1119" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1119" name="return" description="" type="object">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1128">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1128">
|
||
|
|
<name>$where</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1128">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1128">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1145" package="">
|
||
|
|
<name>count_all</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1139">
|
||
|
|
<description><![CDATA[Retreive the number of rows in the selected table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1139" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1139" name="return" description="" type="int">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1145">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1161" package="">
|
||
|
|
<name>count_all_results</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1154">
|
||
|
|
<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="1154" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1154" name="return" description="" type="int">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1161">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA['']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1199" package="">
|
||
|
|
<name>insert</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1192">
|
||
|
|
<description><![CDATA[Creates an insert clause, and executes it]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1192" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1192" name="param" description="" type="mixed" variable="$data">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1192" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1199">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1199">
|
||
|
|
<name>$data</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1225" package="">
|
||
|
|
<name>update</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1218">
|
||
|
|
<description><![CDATA[Creates an update clause, and executes it]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1218" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1218" name="param" description="" type="mixed" variable="$data">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1218" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1225">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1225">
|
||
|
|
<name>$data</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1252" package="">
|
||
|
|
<name>delete</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1245">
|
||
|
|
<description><![CDATA[Deletes data from a table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1245" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1245" name="param" description="" type="mixed" variable="$where">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1245" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1252">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1252">
|
||
|
|
<name>$where</name>
|
||
|
|
<default><![CDATA['']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1283" package="">
|
||
|
|
<name>__call</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1276">
|
||
|
|
<description><![CDATA[Calls a function further down the inheritence chain]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1276" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1276" name="param" description="" type="array" variable="$params">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1276" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1283">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1283">
|
||
|
|
<name>$params</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="1298" package="">
|
||
|
|
<name>_reset</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1295">
|
||
|
|
<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="1340" package="">
|
||
|
|
<name>_compile</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="1333">
|
||
|
|
<description><![CDATA[String together the sql statements for sending to the db]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="1333" name="param" description="" type="string" variable="$type">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1333" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="1333" name="return" description="" type="\$string">
|
||
|
|
<type by_reference="false">\$string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="1340">
|
||
|
|
<name>$type</name>
|
||
|
|
<default><![CDATA['']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="1340">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[""]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/classes/db_util.php" hash="431de8d317520e41982bb00140d9bc11" 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="true" namespace="default" line="18" package="Default">
|
||
|
|
<name>DB_Util</name>
|
||
|
|
<full_name>\DB_Util</full_name>
|
||
|
|
<extends/>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Abstract class defining database / table creation methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="private" line="23" package="Default">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="20">
|
||
|
|
<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="30" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="25">
|
||
|
|
<description><![CDATA[Save a reference to the connection object for later use]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="25" name="param" description="&$conn" type="object" variable="$conn">
|
||
|
|
<type by_reference="false">object</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="43" package="">
|
||
|
|
<name>__call</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="37">
|
||
|
|
<description><![CDATA[Enable calling driver methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="37" name="param" description="" type="string" variable="$method">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="37" name="param" description="" type="array" variable="$args">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$method</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$args</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="67" package="">
|
||
|
|
<name>create_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="57">
|
||
|
|
<description><![CDATA[Get database-specific sql to create a new table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="57" name="abstract" description=""/>
|
||
|
|
<tag line="57" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="57" name="param" description="" type="array" variable="$columns">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="57" name="param" description="" type="array" variable="$constraints">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="57" name="param" description="" type="array" variable="$indexes">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="57" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="67">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="67">
|
||
|
|
<name>$columns</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="67">
|
||
|
|
<name>$constraints</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
<argument line="67">
|
||
|
|
<name>$indexes</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="76" package="">
|
||
|
|
<name>delete_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="69">
|
||
|
|
<description><![CDATA[Get database-specific sql to drop a table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="69" name="abstract" description=""/>
|
||
|
|
<tag line="69" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="69" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="76">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="84" package="">
|
||
|
|
<name>backup_structure</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="78">
|
||
|
|
<description><![CDATA[Return an SQL file with the database table structure]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="78" name="abstract" description=""/>
|
||
|
|
<tag line="78" 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="92" package="">
|
||
|
|
<name>backup_data</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="86">
|
||
|
|
<description><![CDATA[Return an SQL file with the database data as insert statements]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="86" name="abstract" description=""/>
|
||
|
|
<tag line="86" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/autoload.php" hash="921f7582dd35a5ba96d22c7e75c2b3e4" 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>
|
||
|
|
<constant namespace="default" line="22" package="Default">
|
||
|
|
<name>BASE_PATH</name>
|
||
|
|
<value><![CDATA[dirname(__FILE__).'/']]></value>
|
||
|
|
<docblock line="19">
|
||
|
|
<description><![CDATA[Reference to root path]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</constant>
|
||
|
|
<constant namespace="default" line="27" package="Default">
|
||
|
|
<name>DRIVER_PATH</name>
|
||
|
|
<value><![CDATA[BASE_PATH.'drivers/']]></value>
|
||
|
|
<docblock line="24">
|
||
|
|
<description><![CDATA[Path to driver classes]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</constant>
|
||
|
|
<function namespace="default" line="38" package="Default">
|
||
|
|
<name>do_include</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="31">
|
||
|
|
<description><![CDATA[Bulk directory loading workaround for use
|
||
|
|
with array_map and glob]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="31" name="param" description="" type="string" variable="$path">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="31" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="38">
|
||
|
|
<name>$path</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
<function namespace="default" line="73" package="Default">
|
||
|
|
<name>db_filter</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="66">
|
||
|
|
<description><![CDATA[Filter out db rows into one array]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="66" name="param" description="" type="array" variable="$array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="66" name="param" description="" type="mixed" variable="$index">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="66" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="73">
|
||
|
|
<name>$array</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="73">
|
||
|
|
<name>$index</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/pgsql/pgsql_sql.php" hash="6e96291ff159ec7586563edb0321e779" 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="18" package="Default">
|
||
|
|
<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>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="28" package="">
|
||
|
|
<name>limit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Limit clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
|
||
|
|
<name>random</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="42">
|
||
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="42" 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="59" package="">
|
||
|
|
<name>db_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="54">
|
||
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="54" 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="75" package="">
|
||
|
|
<name>table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="70">
|
||
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="70" 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="93" package="">
|
||
|
|
<name>system_table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="88">
|
||
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="88" 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="111" package="">
|
||
|
|
<name>view_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="106">
|
||
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="106" 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="129" package="">
|
||
|
|
<name>trigger_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="124">
|
||
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="124" 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>function_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="141">
|
||
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="141" 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="158" package="">
|
||
|
|
<name>procedure_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="153">
|
||
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="153" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="176" package="">
|
||
|
|
<name>sequence_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="171">
|
||
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="171" 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="194" package="">
|
||
|
|
<name>column_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="188">
|
||
|
|
<description><![CDATA[Return sql to list columns of the specified table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="188" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="188" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="194">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/pgsql/pgsql_util.php" hash="e4363e06307d5e7281dbdbf76e7f5a93" 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="18" package="Default">
|
||
|
|
<name>PgSQL_Util</name>
|
||
|
|
<full_name>\PgSQL_Util</full_name>
|
||
|
|
<extends>\DB_Util</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Posgres-specific backup, import and creation methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="26" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="&$conn" type="object" variable="$conn">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="26">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="40" package="">
|
||
|
|
<name>create_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="31">
|
||
|
|
<description><![CDATA[Database-specific method to create a new table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="31" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="31" name="param" description="" type="array" variable="$columns">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="31" name="param" description="" type="array" variable="$constraints">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="31" name="param" description="" type="array" variable="$indexes">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="31" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="40">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="40">
|
||
|
|
<name>$columns</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="40">
|
||
|
|
<name>$constraints</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
<argument line="40">
|
||
|
|
<name>$indexes</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="96" package="">
|
||
|
|
<name>delete_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="90">
|
||
|
|
<description><![CDATA[Database-specific SQL for dropping a table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="90" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="90" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="96">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="108" package="">
|
||
|
|
<name>backup_structure</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="103">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="103" 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>backup_data</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="116">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="116" name="param" description="" type="array" variable="$exclude">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="116" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="122">
|
||
|
|
<name>$exclude</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/pgsql/pgsql_driver.php" hash="cdd0d50e7f83eea78024ea8e4a4bdd8a" 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="20" package="Default">
|
||
|
|
<name>pgSQL</name>
|
||
|
|
<full_name>\pgSQL</full_name>
|
||
|
|
<extends>\DB_PDO</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[PostgreSQL specifc class]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="15" name="extends" description="DB_PDO"/>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="22">
|
||
|
|
<description><![CDATA[Connect to a PosgreSQL database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="22" name="param" description="" type="string" variable="$dsn">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="22" name="param" description="" type="string" variable="$username">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="22" name="param" description="" type="string" variable="$password">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="22" name="param" description="" type="array" variable="$options">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="30">
|
||
|
|
<name>$dsn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="30">
|
||
|
|
<name>$username</name>
|
||
|
|
<default><![CDATA[null]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="30">
|
||
|
|
<name>$password</name>
|
||
|
|
<default><![CDATA[null]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="30">
|
||
|
|
<name>$options</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="42" package="">
|
||
|
|
<name>switch_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="37">
|
||
|
|
<description><![CDATA[Connect to a different database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="37" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="55" package="">
|
||
|
|
<name>truncate</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="50">
|
||
|
|
<description><![CDATA[Empty a table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="50" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="55">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
|
||
|
|
<name>num_rows</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="63">
|
||
|
|
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="63" 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="80" package="">
|
||
|
|
<name>get_schemas</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="75">
|
||
|
|
<description><![CDATA[Get a list of schemas for the current connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="75" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/odbc/odbc_util.php" hash="9c08585a33e576b5808073478f42e6a8" 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="18" package="Default">
|
||
|
|
<name>ODBC_Util</name>
|
||
|
|
<full_name>\ODBC_Util</full_name>
|
||
|
|
<extends>\DB_Util</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[ODBC-specific backup, import and creation methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="26" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="&$conn" type="object" variable="$conn">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="26">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="42" package="">
|
||
|
|
<name>create_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="33">
|
||
|
|
<description><![CDATA[Database-specific method to create a new table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="33" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$columns">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$constraints">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$indexes">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$columns</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$constraints</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$indexes</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
|
||
|
|
<name>delete_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="50">
|
||
|
|
<description><![CDATA[Remove a table from the database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="50" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="50" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="56">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
|
||
|
|
<name>backup_structure</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="63">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="63" 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>backup_data</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="76">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="76" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/odbc/odbc_sql.php" hash="d11ea8c6a612dcfc745eb96a35fbb13e" 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="18" package="Default">
|
||
|
|
<name>ODBC_SQL</name>
|
||
|
|
<full_name>\ODBC_SQL</full_name>
|
||
|
|
<extends>\DB_SQL</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[ODBC SQL Class]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="28" package="">
|
||
|
|
<name>limit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Limit clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="40" package="">
|
||
|
|
<name>random</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="35">
|
||
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="35" 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="52" package="">
|
||
|
|
<name>db_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="47">
|
||
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="47" 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="64" package="">
|
||
|
|
<name>table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="59">
|
||
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="59" 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="76" package="">
|
||
|
|
<name>system_table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="71">
|
||
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="71" 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="88" package="">
|
||
|
|
<name>view_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="83">
|
||
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="83" 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="100" package="">
|
||
|
|
<name>trigger_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="95">
|
||
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="95" 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="112" package="">
|
||
|
|
<name>function_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="107">
|
||
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="107" 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="124" package="">
|
||
|
|
<name>procedure_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="119">
|
||
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="119" 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="136" package="">
|
||
|
|
<name>sequence_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="131">
|
||
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="131" name="return" description="" type="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/odbc/odbc_driver.php" hash="ea50bdc8b48526ac9f55263e76689669" 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="22" package="Default">
|
||
|
|
<name>ODBC</name>
|
||
|
|
<full_name>\ODBC</full_name>
|
||
|
|
<extends>\DB_PDO</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<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="15" name="extends" description="DB_PDO"/>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="27" package="Default">
|
||
|
|
<name>$escape_char</name>
|
||
|
|
<default><![CDATA['']]></default>
|
||
|
|
<docblock line="24">
|
||
|
|
<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="37" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="29">
|
||
|
|
<description><![CDATA[Use ODBC to connect to a database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="29" name="param" description="" type="string" variable="$dsn">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="29" name="param" description="" type="string" variable="$username">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="29" name="param" description="" type="string" variable="$password">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="29" name="param" description="" type="array" variable="$options">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="37">
|
||
|
|
<name>$dsn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="37">
|
||
|
|
<name>$username</name>
|
||
|
|
<default><![CDATA[null]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="37">
|
||
|
|
<name>$password</name>
|
||
|
|
<default><![CDATA[null]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="37">
|
||
|
|
<name>$options</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="50" package="">
|
||
|
|
<name>switch_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="44">
|
||
|
|
<description><![CDATA[Doesn't apply to ODBC]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="44" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="44" name="return" description="" type="bool">
|
||
|
|
<type by_reference="false">bool</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="50">
|
||
|
|
<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="57">
|
||
|
|
<description><![CDATA[Empty the current database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="57" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="57" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</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="76" package="">
|
||
|
|
<name>num_rows</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="71">
|
||
|
|
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="71" name="return" description="" type="int">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/mysql/mysql_util.php" hash="2fc1cb882f14c6fadcd9cc959bc1fe53" 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="18" package="Default">
|
||
|
|
<name>MySQL_Util</name>
|
||
|
|
<full_name>\MySQL_Util</full_name>
|
||
|
|
<extends>\DB_Util</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[MySQL-specific backup, import and creation methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="26" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="&$conn" type="object" variable="$conn">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="26">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="43" package="">
|
||
|
|
<name>create_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="33">
|
||
|
|
<description><![CDATA[Convienience public function for creating a new MySQL table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="33" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$columns">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$constraints">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$indexes">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$columns</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$constraints</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$indexes</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="109" package="">
|
||
|
|
<name>delete_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="103">
|
||
|
|
<description><![CDATA[Convience public function for droping a MySQL table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="103" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="103" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="109">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="121" package="">
|
||
|
|
<name>backup_structure</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="116">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></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="false" static="false" visibility="public" namespace="default" line="135" package="">
|
||
|
|
<name>backup_data</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="129">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="129" name="param" description="" type="array" variable="$exclude">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="129" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="135">
|
||
|
|
<name>$exclude</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/mysql/mysql_driver.php" hash="711af4a70e7e06ec2c839e0513a7a420" 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="20" package="Default">
|
||
|
|
<name>MySQL</name>
|
||
|
|
<full_name>\MySQL</full_name>
|
||
|
|
<extends>\DB_PDO</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[MySQL specific class]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="15" name="extends" description="DB_PDO"/>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="25" package="Default">
|
||
|
|
<name>$escape_char</name>
|
||
|
|
<default><![CDATA['`']]></default>
|
||
|
|
<docblock line="22">
|
||
|
|
<description><![CDATA[Set the backtick as the MySQL escape character]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="35" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="27">
|
||
|
|
<description><![CDATA[Connect to MySQL Database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="27" name="param" description="" type="string" variable="$dsn">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="27" name="param" description="" type="string" variable="$username">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="27" name="param" description="" type="string" variable="$password">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="27" name="param" description="" type="array" variable="$options">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="35">
|
||
|
|
<name>$dsn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="35">
|
||
|
|
<name>$username</name>
|
||
|
|
<default><![CDATA[null]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="35">
|
||
|
|
<name>$password</name>
|
||
|
|
<default><![CDATA[null]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="35">
|
||
|
|
<name>$options</name>
|
||
|
|
<default><![CDATA[array()]]></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[Connect to a different database]]></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="64" package="">
|
||
|
|
<name>truncate</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="59">
|
||
|
|
<description><![CDATA[Empty a table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="59" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="64">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="76" package="">
|
||
|
|
<name>num_rows</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="71">
|
||
|
|
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="71" name="return" description="" type="int">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/mysql/mysql_sql.php" hash="a9e5198fc2f1af65d1162a2c4d9ce563" 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="18" package="Default">
|
||
|
|
<name>MySQL_SQL</name>
|
||
|
|
<full_name>\MySQL_SQL</full_name>
|
||
|
|
<extends>\DB_SQL</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[MySQL specifc SQL]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="28" package="">
|
||
|
|
<name>limit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Limit clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="45" package="">
|
||
|
|
<name>random</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="40">
|
||
|
|
<description><![CDATA[Random ordering keyword]]></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>db_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="52">
|
||
|
|
<description><![CDATA[Returns sql to list other databases]]></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>table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="64">
|
||
|
|
<description><![CDATA[Returns sql to list tables]]></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>system_table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="76">
|
||
|
|
<description><![CDATA[Overridden in MySQL class]]></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="94" package="">
|
||
|
|
<name>view_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="89">
|
||
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="89" 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="106" package="">
|
||
|
|
<name>trigger_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="101">
|
||
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="101" 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="118" package="">
|
||
|
|
<name>function_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="113">
|
||
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="113" 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>procedure_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="125">
|
||
|
|
<description><![CDATA[Return sql to list stored procedures]]></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="142" package="">
|
||
|
|
<name>sequence_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="137">
|
||
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="137" name="return" description="" type="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/sqlite/sqlite_util.php" hash="4b454af7bb62fa27cc6c81d3cb3847da" 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="18" package="Default">
|
||
|
|
<name>SQLite_Util</name>
|
||
|
|
<full_name>\SQLite_Util</full_name>
|
||
|
|
<extends>\DB_Util</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[SQLite-specific backup, import and creation methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="26" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="&$conn" type="object" variable="$conn">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="26">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="42" package="">
|
||
|
|
<name>create_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="33">
|
||
|
|
<description><![CDATA[Convenience public function to create a new table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="33" name="param" description="//Name of the table" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" 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="33" name="param" description="// column => constraint pairs" type="array" variable="$constraints">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="// column => index pairs" type="array" variable="$indexes">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$columns</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$constraints</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
<argument line="42">
|
||
|
|
<name>$indexes</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="98" package="">
|
||
|
|
<name>delete_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="92">
|
||
|
|
<description><![CDATA[SQL to drop the specified table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="92" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="92" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="98">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="111" package="">
|
||
|
|
<name>backup_data</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="105">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="105" name="param" description="" type="array" variable="$excluded">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="105" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="111">
|
||
|
|
<name>$excluded</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="175" package="">
|
||
|
|
<name>backup_structure</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="170">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="170" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/sqlite/sqlite_driver.php" hash="ee83f4857458949ae43ed19fe2599bc2" 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="20" package="Default">
|
||
|
|
<name>SQLite</name>
|
||
|
|
<full_name>\SQLite</full_name>
|
||
|
|
<extends>\DB_PDO</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[SQLite specific class]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="15" name="extends" description="DB_PDO"/>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="25" package="Default">
|
||
|
|
<name>$statement</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="22">
|
||
|
|
<description><![CDATA[Reference to the last executed sql query]]></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="27">
|
||
|
|
<description><![CDATA[Open SQLite Database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="27" name="param" description="" type="string" variable="$dsn">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="27" name="param" description="" type="string" variable="$user">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="27" name="param" description="" type="string" variable="$pass">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="34">
|
||
|
|
<name>$dsn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="34">
|
||
|
|
<name>$user</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="34">
|
||
|
|
<name>$pass</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
|
||
|
|
<name>switch_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="42">
|
||
|
|
<description><![CDATA[Doesn't apply to sqlite]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="42" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="47">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="59" package="">
|
||
|
|
<name>truncate</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="54">
|
||
|
|
<description><![CDATA[Empty a table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="54" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="59">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="77" package="">
|
||
|
|
<name>get_tables</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="72">
|
||
|
|
<description><![CDATA[List tables for the current database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="72" 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="98" package="">
|
||
|
|
<name>get_system_tables</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="93">
|
||
|
|
<description><![CDATA[List system tables for the current database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="93" 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="113" package="">
|
||
|
|
<name>load_database</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="107">
|
||
|
|
<description><![CDATA[Load a database for the current connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="107" name="param" description="" type="string" variable="$db">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="107" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="113">
|
||
|
|
<name>$db</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="113">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="126" package="">
|
||
|
|
<name>unload_database</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="121">
|
||
|
|
<description><![CDATA[Unload a database from the current connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="121" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="126">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="144" package="">
|
||
|
|
<name>num_rows</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="139">
|
||
|
|
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="139" name="return" description="" type="int">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/sqlite/sqlite_sql.php" hash="a969bfad3f227e02f814616954582c37" 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="18" package="Default">
|
||
|
|
<name>SQLite_SQL</name>
|
||
|
|
<full_name>\SQLite_SQL</full_name>
|
||
|
|
<extends>\DB_SQL</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[SQLite Specific SQL]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="28" package="">
|
||
|
|
<name>limit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Limit clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="45" package="">
|
||
|
|
<name>random</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="40">
|
||
|
|
<description><![CDATA[Random ordering keyword]]></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>db_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="52">
|
||
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="52" 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="69" package="">
|
||
|
|
<name>table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="64">
|
||
|
|
<description><![CDATA[Returns sql to list tables]]></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="86" package="">
|
||
|
|
<name>system_table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="81">
|
||
|
|
<description><![CDATA[Overridden in SQLite class]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="81" 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="112" package="">
|
||
|
|
<name>trigger_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="107">
|
||
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="107" 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="124" package="">
|
||
|
|
<name>function_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="119">
|
||
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="119" 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="136" package="">
|
||
|
|
<name>procedure_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="131">
|
||
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="131" 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="148" package="">
|
||
|
|
<name>sequence_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="143">
|
||
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="143" name="return" description="" type="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/firebird/firebird_sql.php" hash="0ad1145b6763bb39f501342323a7e1c8" 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="18" package="Default">
|
||
|
|
<name>Firebird_SQL</name>
|
||
|
|
<full_name>\Firebird_SQL</full_name>
|
||
|
|
<extends>\DB_SQL</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Firebird Specific SQL]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="28" package="">
|
||
|
|
<name>limit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Limit clause]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$limit">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="param" description="" type="int" variable="$offset">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$limit</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="28">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
|
||
|
|
<name>random</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="47">
|
||
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="47" 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="65" package="">
|
||
|
|
<name>db_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="60">
|
||
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="60" 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="77" package="">
|
||
|
|
<name>table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="72">
|
||
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="72" 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="94" package="">
|
||
|
|
<name>system_table_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="89">
|
||
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="89" 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="111" package="">
|
||
|
|
<name>view_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="106">
|
||
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="106" 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>trigger_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="121">
|
||
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="121" 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="141" package="">
|
||
|
|
<name>function_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="136">
|
||
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="136" 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="153" package="">
|
||
|
|
<name>procedure_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="148">
|
||
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="148" 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="181" package="">
|
||
|
|
<name>sequence_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="176">
|
||
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="176" 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="198" package="">
|
||
|
|
<name>column_list</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="192">
|
||
|
|
<description><![CDATA[Return sql to list columns of the specified table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="192" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="192" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="198">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/firebird/firebird_result.php" hash="4e18c6bbf6d41513a6ae2c513a507fdc" 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="20" package="Default">
|
||
|
|
<name>Firebird_Result</name>
|
||
|
|
<full_name>\Firebird_Result</full_name>
|
||
|
|
<extends>\PDOStatement</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Firebird result class to emulate PDOStatement Class - only implements
|
||
|
|
data-fetching methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="private" line="25" package="Default">
|
||
|
|
<name>$statement</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="22">
|
||
|
|
<description><![CDATA[Reference to fbird resource]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="33" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="27">
|
||
|
|
<description><![CDATA[Create the object by passing the resource for
|
||
|
|
the query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="27" name="param" description="" type="resource" variable="$link">
|
||
|
|
<type by_reference="false">resource</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="33">
|
||
|
|
<name>$link</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="51" package="">
|
||
|
|
<name>bindColumn</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="41">
|
||
|
|
<description><![CDATA[Invalidate method for data consistency]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="41" name="param" description="" type="mixed" variable="$column">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="41" name="param" description="&$param" type="mixed" variable="$param">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="41" name="param" description="" type="int" variable="$type">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="41" name="param" description="" type="mixed" variable="$maxlen">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="41" name="param" description="" type="array" variable="$driverdata">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="41" name="return" description="" type="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="51">
|
||
|
|
<name>$column</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="51">
|
||
|
|
<name>$param</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="51">
|
||
|
|
<name>$type</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="51">
|
||
|
|
<name>$maxlen</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="51">
|
||
|
|
<name>$driverdata</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
|
||
|
|
<name>bindParam</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="58">
|
||
|
|
<description><![CDATA[Invalidate method for data consistency]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="58" name="param" description="" type="mixed" variable="$parameter">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="58" name="param" description="&$variable" type="mixed" variable="$variable">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="58" name="param" description="" type="int" variable="$data_type">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="58" name="param" description="" type="mixed" variable="$maxlen">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="58" name="param" description="" type="array" variable="$driverdata">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="58" name="return" description="" type="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="68">
|
||
|
|
<name>$parameter</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="68">
|
||
|
|
<name>$variable</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="68">
|
||
|
|
<name>$data_type</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="68">
|
||
|
|
<name>$maxlen</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="68">
|
||
|
|
<name>$driverdata</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="83" package="">
|
||
|
|
<name>bindValue</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="75">
|
||
|
|
<description><![CDATA[Invalidate method for data consistency]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="75" name="param" description="" type="mixed" variable="$parameter">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="75" name="param" description="&$variable" type="mixed" variable="$variable">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="75" name="param" description="" type="int" variable="$data_type">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="75" name="return" description="" type="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="83">
|
||
|
|
<name>$parameter</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="83">
|
||
|
|
<name>$variable</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="83">
|
||
|
|
<name>$data_type</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="96" package="">
|
||
|
|
<name>execute</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="90">
|
||
|
|
<description><![CDATA[Run a prepared statement query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="90" name="param" description="" type="array" variable="$args">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="90" name="return" description="" type="bool">
|
||
|
|
<type by_reference="false">bool</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="96">
|
||
|
|
<name>$args</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="119" package="">
|
||
|
|
<name>fetch</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="111">
|
||
|
|
<description><![CDATA[Emulate PDO fetch public function]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="111" name="param" description="" type="int" variable="$fetch_style">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="111" name="param" description="" type="mixed" variable="$statement">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="111" name="param" description="" type="mixed" variable="$offset">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="111" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="119">
|
||
|
|
<name>$fetch_style</name>
|
||
|
|
<default><![CDATA[PDO::FETCH_ASSOC]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="119">
|
||
|
|
<name>$statement</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="119">
|
||
|
|
<name>$offset</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="152" package="">
|
||
|
|
<name>fetchAll</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="144">
|
||
|
|
<description><![CDATA[Emulate PDO fetchAll public function]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="144" name="param" description="" type="int" variable="$fetch_style">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="144" name="param" description="" type="mixed" variable="$statement">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="144" name="param" description="" type="mixed" variable="$ctor_args">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="144" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="152">
|
||
|
|
<name>$fetch_style</name>
|
||
|
|
<default><![CDATA[PDO::FETCH_ASSOC]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="152">
|
||
|
|
<name>$statement</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="152">
|
||
|
|
<name>$ctor_args</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="174" package="">
|
||
|
|
<name>fetchColumn</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="168">
|
||
|
|
<description><![CDATA[Emulate PDOStatement::fetchColumn]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="168" name="param" description="" type="int" variable="$column_num">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="168" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="174">
|
||
|
|
<name>$column_num</name>
|
||
|
|
<default><![CDATA[0]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="189" package="">
|
||
|
|
<name>fetchObject</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="182">
|
||
|
|
<description><![CDATA[Emulate PDOStatement::fetchObject, but only for the default use]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="182" name="param" description="" type="string" variable="$class_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="182" name="param" description="" type="array" variable="$ctor_args">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="182" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="189">
|
||
|
|
<name>$class_name</name>
|
||
|
|
<default><![CDATA['stdClass']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="189">
|
||
|
|
<name>$ctor_args</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="201" package="">
|
||
|
|
<name>rowCount</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="196">
|
||
|
|
<description><![CDATA[Return the number of rows affected by the previous query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="196" 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="213" package="">
|
||
|
|
<name>num_rows</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="208">
|
||
|
|
<description><![CDATA[Return the number of rows for the select query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="208" 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="225" package="">
|
||
|
|
<name>errorCode</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="220">
|
||
|
|
<description><![CDATA[Method to emulate PDOStatement->errorCode]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="220" 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="237" package="">
|
||
|
|
<name>errorInfo</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="232">
|
||
|
|
<description><![CDATA[Method to emulate PDO->errorInfo / PDOStatement->errorInfo]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="232" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/firebird/firebird_driver.php" hash="726964c655286fd7cfef3a16e1514145" 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="20" package="Default">
|
||
|
|
<name>Firebird</name>
|
||
|
|
<full_name>\Firebird</full_name>
|
||
|
|
<extends>\DB_PDO</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<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>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="25" package="Default">
|
||
|
|
<name>$statement</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="22">
|
||
|
|
<description><![CDATA[Reference to the last query executed]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="31" package="Default">
|
||
|
|
<name>$statement_link</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="27">
|
||
|
|
<description><![CDATA[Reference to the resource returned by
|
||
|
|
the last query executed]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="36" package="Default">
|
||
|
|
<name>$trans</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="33">
|
||
|
|
<description><![CDATA[Reference to the current transaction]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="41" package="Default">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="38">
|
||
|
|
<description><![CDATA[Reference to the connection resource]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="50" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="43">
|
||
|
|
<description><![CDATA[Open the link to the database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="43" name="param" description="" type="string" variable="$dbpath">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="43" name="param" description="" type="string" variable="$user">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="43" name="param" description="" type="string" variable="$pass">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="50">
|
||
|
|
<name>$dbpath</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="50">
|
||
|
|
<name>$user</name>
|
||
|
|
<default><![CDATA['sysdba']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="50">
|
||
|
|
<name>$pass</name>
|
||
|
|
<default><![CDATA['masterkey']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="83" package="">
|
||
|
|
<name>switch_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="77">
|
||
|
|
<description><![CDATA[Doesn't apply to Firebird]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="77" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="77" name="return" description="" type="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="83">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="95" package="">
|
||
|
|
<name>truncate</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="90">
|
||
|
|
<description><![CDATA[Empty a database table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="90" name="param" description="" type="string" variable="$table">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="95">
|
||
|
|
<name>$table</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="110" package="">
|
||
|
|
<name>query</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="104">
|
||
|
|
<description><![CDATA[Wrapper public function to better match PDO]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="104" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="104" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="110">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="134" package="">
|
||
|
|
<name>prepare</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="127">
|
||
|
|
<description><![CDATA[Emulate PDO prepare]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="127" name="param" description="" type="string" variable="$query">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="127" name="param" description="" type="array" variable="$options">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="127" name="return" description="" type="\$this">
|
||
|
|
<type by_reference="false">\$this</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="134">
|
||
|
|
<name>$query</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="134">
|
||
|
|
<name>$options</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="154" package="">
|
||
|
|
<name>num_rows</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="149">
|
||
|
|
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="149" 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="166" package="">
|
||
|
|
<name>beginTransaction</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="161">
|
||
|
|
<description><![CDATA[Start a database transaction]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="161" 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="183" package="">
|
||
|
|
<name>commit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="178">
|
||
|
|
<description><![CDATA[Commit a database transaction]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="178" 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="195" package="">
|
||
|
|
<name>rollBack</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="190">
|
||
|
|
<description><![CDATA[Rollback a transaction]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="190" 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="209" package="">
|
||
|
|
<name>prepare_execute</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="202">
|
||
|
|
<description><![CDATA[Prepare and execute a query]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="202" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="202" name="param" description="" type="array" variable="$args">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="202" name="return" description="" type="resource">
|
||
|
|
<type by_reference="false">resource</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="209">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="209">
|
||
|
|
<name>$args</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="228" package="">
|
||
|
|
<name>quote</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="221">
|
||
|
|
<description><![CDATA[Method to emulate PDO->quote]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="221" name="param" description="" type="string" variable="$str">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="221" name="param" description="" type="int" variable="$param_type">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="221" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="228">
|
||
|
|
<name>$str</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="228">
|
||
|
|
<name>$param_type</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="245" package="">
|
||
|
|
<name>errorInfo</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="240">
|
||
|
|
<description><![CDATA[Method to emulate PDO->errorInfo / PDOStatement->errorInfo]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="240" 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>errorCode</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="255">
|
||
|
|
<description><![CDATA[Method to emulate PDO->errorCode]]></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="274" package="">
|
||
|
|
<name>prepare_query</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="267">
|
||
|
|
<description><![CDATA[Bind a prepared query with arguments for executing]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="267" name="param" description="" type="string" variable="$sql">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="267" name="param" description="" type="array" variable="$params">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="267" name="return" description="" type="FALSE">
|
||
|
|
<type by_reference="false">FALSE</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="274">
|
||
|
|
<name>$sql</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="274">
|
||
|
|
<name>$params</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/db/drivers/firebird/firebird_util.php" hash="934a008ad9515b672f6e6aef7958583d" 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="18" package="Default">
|
||
|
|
<name>Firebird_Util</name>
|
||
|
|
<full_name>\Firebird_Util</full_name>
|
||
|
|
<extends>\DB_Util</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Firebird-specific backup, import and creation methods]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="26" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="&$conn" type="object" variable="$conn">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="20" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="26">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="43" package="">
|
||
|
|
<name>create_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="33">
|
||
|
|
<description><![CDATA[Convienience public function to generate sql for creating a db table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="33" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$fields">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$constraints">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="param" description="" type="array" variable="$indexes">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="33" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$fields</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$constraints</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
<argument line="43">
|
||
|
|
<name>$indexes</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type>array</type>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="99" package="">
|
||
|
|
<name>delete_table</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="93">
|
||
|
|
<description><![CDATA[Drop the selected table]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="93" name="param" description="" type="string" variable="$name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="93" name="return" description="" type="string">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="99">
|
||
|
|
<name>$name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="111" package="">
|
||
|
|
<name>backup_structure</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="106">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="106" 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="119">
|
||
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="119" name="param" description="" type="array" variable="$exclude">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="119" name="param" description="" type="bool" variable="$system_tables">
|
||
|
|
<type by_reference="false">bool</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="119" 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>
|
||
|
|
<argument line="126">
|
||
|
|
<name>$system_tables</name>
|
||
|
|
<default><![CDATA[FALSE]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/common/functions.php" hash="59d8086bb0f8614b8f25e2196197b599" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<function namespace="default" line="23" package="Default">
|
||
|
|
<name>array_to_object</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="17">
|
||
|
|
<description><![CDATA[Convert an array to an object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="17" name="param" description="" type="array" variable="$array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="17" name="return" description="" type="object">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="23">
|
||
|
|
<name>$array</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
<function namespace="default" line="48" package="Default">
|
||
|
|
<name>alert</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="42">
|
||
|
|
<description><![CDATA[Create info dialog to retun an informational message]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="42" name="param" description="" type="string" variable="$message">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="42" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="48">
|
||
|
|
<name>$message</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
<function namespace="default" line="71" package="Default">
|
||
|
|
<name>error</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="65">
|
||
|
|
<description><![CDATA[Create info dialog to retun an informational message]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="65" name="param" description="" type="string" variable="$message">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="65" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="71">
|
||
|
|
<name>$message</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
<function namespace="default" line="94" package="Default">
|
||
|
|
<name>confirm</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="88">
|
||
|
|
<description><![CDATA[Creates a binary confirmation dialog]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="88" name="param" description="" type="string" variable="$message">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="88" name="return" description="" type="bool">
|
||
|
|
<type by_reference="false">bool</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="94">
|
||
|
|
<name>$message</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
<function namespace="default" line="118" package="Default">
|
||
|
|
<name>about</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="113">
|
||
|
|
<description><![CDATA[Display About menu with version information]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="113" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</function>
|
||
|
|
</file>
|
||
|
|
<file path="sys/widgets/connection_sidebar.php" hash="5e0c7e897ba20b8df7d8875522955a9d" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="default" line="18" package="Default">
|
||
|
|
<name>Connection_Sidebar</name>
|
||
|
|
<full_name>\Connection_Sidebar</full_name>
|
||
|
|
<extends>\GtkVBox</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Widget managing saved database connections]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="23" package="Default">
|
||
|
|
<name>$settings</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Reference to Settings instance]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="28" package="Default">
|
||
|
|
<name>$menu</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="25">
|
||
|
|
<description><![CDATA[Reference to popup menu]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="33" package="Default">
|
||
|
|
<name>$treeview</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="30">
|
||
|
|
<description><![CDATA[Treeview for displaying connections]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="true" visibility="private" line="38" package="Default">
|
||
|
|
<name>$instance</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="35">
|
||
|
|
<description><![CDATA[Singleton instance]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="43" package="Default">
|
||
|
|
<name>$conn_name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="40">
|
||
|
|
<description><![CDATA[Name of current db connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="50" package="">
|
||
|
|
<name>get_instance</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="45">
|
||
|
|
<description><![CDATA[Return the current instance of the class]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="45" name="return" description="" type="\Connection_Sidebar">
|
||
|
|
<type by_reference="false">\Connection_Sidebar</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="66" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="63">
|
||
|
|
<description><![CDATA[Constructor method]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="102" package="">
|
||
|
|
<name>_render</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="97">
|
||
|
|
<description><![CDATA[Renders the connection sidebar widget]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="97" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="161" package="">
|
||
|
|
<name>set_icon</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="152">
|
||
|
|
<description><![CDATA[Sets the icon for the current db type]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="152" name="param" description="Column $col" type="\GtkTreeView" variable="$col">
|
||
|
|
<type by_reference="false">\GtkTreeView</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="152" name="param" description="" type="\GtkCellRenderer" variable="$cell">
|
||
|
|
<type by_reference="false">\GtkCellRenderer</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="152" name="param" description="" type="\GtkTreeModel" variable="$model">
|
||
|
|
<type by_reference="false">\GtkTreeModel</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="152" name="param" description="" type="\GtkTreeIter" variable="$iter">
|
||
|
|
<type by_reference="false">\GtkTreeIter</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="152" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="161">
|
||
|
|
<name>$col</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="161">
|
||
|
|
<name>$cell</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="161">
|
||
|
|
<name>$model</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="161">
|
||
|
|
<name>$iter</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="191" package="">
|
||
|
|
<name>set_label</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="182">
|
||
|
|
<description><![CDATA[Sets the label of the current db connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="182" name="param" description="" type="\GtkTreeViewColumn" variable="$col">
|
||
|
|
<type by_reference="false">\GtkTreeViewColumn</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="182" name="param" description="" type="\GtkCellRenderer" variable="$cell">
|
||
|
|
<type by_reference="false">\GtkCellRenderer</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="182" name="param" description="" type="\GtkTreeModel" variable="$model">
|
||
|
|
<type by_reference="false">\GtkTreeModel</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="182" name="param" description="" type="\GtkTreeIter" variable="$iter">
|
||
|
|
<type by_reference="false">\GtkTreeIter</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="182" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="191">
|
||
|
|
<name>$col</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="191">
|
||
|
|
<name>$cell</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="191">
|
||
|
|
<name>$model</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="191">
|
||
|
|
<name>$iter</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="209" package="">
|
||
|
|
<name>set_status_icon</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="200">
|
||
|
|
<description><![CDATA[Sets the status icon of the current db connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="200" name="param" description="" type="\GtkTreeViewColumn" variable="$col">
|
||
|
|
<type by_reference="false">\GtkTreeViewColumn</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="200" name="param" description="" type="\GtkCellRenderer" variable="$cell">
|
||
|
|
<type by_reference="false">\GtkCellRenderer</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="200" name="param" description="" type="\GtkTreeModel" variable="$model">
|
||
|
|
<type by_reference="false">\GtkTreeModel</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="200" name="param" description="" type="\GtkTreeIter" variable="$iter">
|
||
|
|
<type by_reference="false">\GtkTreeIter</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="200" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="209">
|
||
|
|
<name>$col</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="209">
|
||
|
|
<name>$cell</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="209">
|
||
|
|
<name>$model</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="209">
|
||
|
|
<name>$iter</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="233" package="">
|
||
|
|
<name>new_conn</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="228">
|
||
|
|
<description><![CDATA[Returns window for creating a new database connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="228" name="return" description="object" type="\Add_DB">
|
||
|
|
<type by_reference="false">\Add_DB</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="247" package="">
|
||
|
|
<name>on_button</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="240">
|
||
|
|
<description><![CDATA[Event for mouse clicks on connection sidebar]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="240" name="param" description="" type="\GtkTreeView" variable="$view">
|
||
|
|
<type by_reference="false">\GtkTreeView</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="240" name="param" description="" type="" variable="$event"/>
|
||
|
|
<tag line="240" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="247">
|
||
|
|
<name>$view</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="247">
|
||
|
|
<name>$event</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="281" package="">
|
||
|
|
<name>conn_popup_menu</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="275">
|
||
|
|
<description><![CDATA[Creates and displays a context menu for the selected connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="275" name="param" description="" type="array" variable="$all">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="275" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="281">
|
||
|
|
<name>$all</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="338" package="">
|
||
|
|
<name>refresh</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="333">
|
||
|
|
<description><![CDATA[Recreate sidebar widget to update connections]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="333" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="351" package="">
|
||
|
|
<name>edit_connection</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="346">
|
||
|
|
<description><![CDATA[Update the connection information for an existing connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="346" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="363" package="">
|
||
|
|
<name>remove_connection</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="358">
|
||
|
|
<description><![CDATA[Remove a connection from the connection manager]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="358" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="387" package="">
|
||
|
|
<name>db_connect</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="382">
|
||
|
|
<description><![CDATA[Create connection to a database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="382" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="413" package="">
|
||
|
|
<name>db_disconnect</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="408">
|
||
|
|
<description><![CDATA[Disconnect from a database]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="408" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="431" package="">
|
||
|
|
<name>switch_tab</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="425">
|
||
|
|
<description><![CDATA[Change tabs based on db connection selected]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="425" name="param" description="" type="\GtkTreeView" variable="$view">
|
||
|
|
<type by_reference="false">\GtkTreeView</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="425" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="431">
|
||
|
|
<name>$view</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/widgets/data_grid.php" hash="9c11cad12669fb7531f526d3e5fc33a5" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="default" line="18" package="Default">
|
||
|
|
<name>Data_Grid</name>
|
||
|
|
<full_name>\Data_Grid</full_name>
|
||
|
|
<extends>\GtkTreeView</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Class to simplify dealing with GtkTreeView]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="23" package="Default">
|
||
|
|
<name>$model</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[GtkTreeStore object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="25">
|
||
|
|
<description><![CDATA[Create the object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="25" name="param" description="" type="object" variable="$model">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="30">
|
||
|
|
<name>$model</name>
|
||
|
|
<default><![CDATA[null]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="51" package="">
|
||
|
|
<name>get</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="45">
|
||
|
|
<description><![CDATA[Get the value of the model for the current selection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="45" name="param" description="pos" type="int" variable="$pos">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="45" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="51">
|
||
|
|
<name>$pos</name>
|
||
|
|
<default><![CDATA[0]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
|
||
|
|
<name>reset</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="76">
|
||
|
|
<description><![CDATA[Clear datagrid]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="76" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="105" package="">
|
||
|
|
<name>add_data_col</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="95">
|
||
|
|
<description><![CDATA[Adds a column of data to the model]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="95" name="param" description="" type="\GtkTreeViewColumn" variable="$col">
|
||
|
|
<type by_reference="false">\GtkTreeViewColumn</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="95" name="param" description="" type="\GtkCellRenderer" variable="$cell">
|
||
|
|
<type by_reference="false">\GtkCellRenderer</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="95" name="param" description="" type="\GtkTreeModel" variable="$model">
|
||
|
|
<type by_reference="false">\GtkTreeModel</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="95" name="param" description="" type="\GtkTreeIter" variable="$iter">
|
||
|
|
<type by_reference="false">\GtkTreeIter</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="95" name="param" description="" type="int" variable="$i">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="95" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="105">
|
||
|
|
<name>$col</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="105">
|
||
|
|
<name>$cell</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="105">
|
||
|
|
<name>$model</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="105">
|
||
|
|
<name>$iter</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="105">
|
||
|
|
<name>$i</name>
|
||
|
|
<default><![CDATA[0]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="127" package="">
|
||
|
|
<name>render_data</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="120">
|
||
|
|
<description><![CDATA[Create a datagrid from the provided data array]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="120" name="param" description="" type="array" variable="$data">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="120" name="param" description="" type="array" variable="$events">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="120" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="127">
|
||
|
|
<name>$data</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="127">
|
||
|
|
<name>$events</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/widgets/db_tabs.php" hash="c6bc70a593556d0cc864f37443269c1c" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="default" line="18" package="Default">
|
||
|
|
<name>DB_tabs</name>
|
||
|
|
<full_name>\DB_tabs</full_name>
|
||
|
|
<extends>\GTKNotebook</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Tabbed Container for database properties]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="true" visibility="private" line="24" package="Default">
|
||
|
|
<name>$instance</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Current Tab Widget object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="var" description="" type="\DB_Tabs">
|
||
|
|
<type by_reference="false">\DB_Tabs</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="29" package="Default">
|
||
|
|
<name>$data</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="26">
|
||
|
|
<description><![CDATA[Db Data cache]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="36" package="">
|
||
|
|
<name>get_instance</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="31">
|
||
|
|
<description><![CDATA[Return the db tabs object if it exists, or create and return]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="31" name="return" description="" type="\DB_tabs">
|
||
|
|
<type by_reference="false">\DB_tabs</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="51" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="48">
|
||
|
|
<description><![CDATA[Create the object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="66" package="">
|
||
|
|
<name>add_tab</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="59">
|
||
|
|
<description><![CDATA[Add a new tab with the provided label]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="59" name="param" description="" type="string" variable="$label">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="59" name="param" description="" type="\GObject" variable="$widget">
|
||
|
|
<type by_reference="false">\GObject</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="59" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="66">
|
||
|
|
<name>$label</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="66">
|
||
|
|
<name>$widget</name>
|
||
|
|
<default><![CDATA[NULL]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="87" package="">
|
||
|
|
<name>show_table_data</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="78">
|
||
|
|
<description><![CDATA[Create popup window with table data]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="78" name="param" description="" type="\GTKTreeView" variable="$view">
|
||
|
|
<type by_reference="false">\GTKTreeView</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="78" name="param" description="" type="array" variable="$path">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="78" name="param" description="" type="\GtkTreeviewColumn" variable="$col">
|
||
|
|
<type by_reference="false">\GtkTreeviewColumn</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="78" name="param" description="" type="\Query_Builder" variable="$conn">
|
||
|
|
<type by_reference="false">\Query_Builder</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="78" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="87">
|
||
|
|
<name>$view</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="87">
|
||
|
|
<name>$path</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="87">
|
||
|
|
<name>$col</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="87">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="105" package="">
|
||
|
|
<name>get_db_tabs</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="99">
|
||
|
|
<description><![CDATA[Create tabs for database aspects]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="99" name="param" description="" type="\Query_Builder" variable="$conn">
|
||
|
|
<type by_reference="false">\Query_Builder</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="99" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="105">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="true" visibility="public" namespace="default" line="169" package="">
|
||
|
|
<name>reset</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="163">
|
||
|
|
<description><![CDATA[Remove current tabs]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="163" name="param" description="" type="string" variable="$conn_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="163" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="169">
|
||
|
|
<name>$conn_name</name>
|
||
|
|
<default><![CDATA['']]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="true" visibility="private" namespace="default" line="198" package="">
|
||
|
|
<name>_add_tab</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="188">
|
||
|
|
<description><![CDATA[Simplify adding tabs to the Notebook object]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="188" name="param" description="" type="object" variable="$conn">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="188" name="param" description="" type="string" variable="$tab_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="188" name="param" description="" type="string" variable="$col_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="188" name="param" description="" type="string" variable="$method">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="188" name="param" description="" type="array" variable="$events">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="188" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="198">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="198">
|
||
|
|
<name>$tab_name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="198">
|
||
|
|
<name>$col_name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="198">
|
||
|
|
<name>$method</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="198">
|
||
|
|
<name>$events</name>
|
||
|
|
<default><![CDATA[array()]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="true" visibility="private" namespace="default" line="251" package="">
|
||
|
|
<name>_add_row_tab</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="243">
|
||
|
|
<description><![CDATA[Add a multidimensional array to a tab]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="243" name="param" description="" type="object" variable="$conn">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="243" name="param" description="" type="string" variable="$tab_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="243" name="param" description="" type="string" variable="$method">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="243" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="251">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="251">
|
||
|
|
<name>$tab_name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="251">
|
||
|
|
<name>$method</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="286" package="">
|
||
|
|
<name>_get_db_info</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="279">
|
||
|
|
<description><![CDATA[Returns cached database data for the tab and connection specified]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="279" name="param" description="" type="string" variable="$conn_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="279" name="param" description="" type="string" variable="$tab_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="279" name="return" description="" type="mixed">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="286">
|
||
|
|
<name>$conn_name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="286">
|
||
|
|
<name>$tab_name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="313" package="">
|
||
|
|
<name>_set_db_info</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="306">
|
||
|
|
<description><![CDATA[Sets cached database data for the tab and connection specified]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="306" name="param" description="" type="string" variable="$conn_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="306" name="param" description="" type="string" variable="$tab_name">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="306" name="param" description="" type="mixed" variable="$data">
|
||
|
|
<type by_reference="false">mixed</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="313">
|
||
|
|
<name>$conn_name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="313">
|
||
|
|
<name>$tab_name</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="313">
|
||
|
|
<name>$data</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/widgets/db_info_widget.php" hash="09259cfac48caa35b0df4e562fe8aa47" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="default" line="18" package="Default">
|
||
|
|
<name>DB_Info_Widget</name>
|
||
|
|
<full_name>\DB_Info_Widget</full_name>
|
||
|
|
<extends>\GtkTable</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Widget for adding / editing database connections]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="private" line="24" package="Default">
|
||
|
|
<name>$settings</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Alias to Settings::get_instance]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="var" description="" type="\Settings">
|
||
|
|
<type by_reference="false">\Settings</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="29" package="Default">
|
||
|
|
<name>$conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="26">
|
||
|
|
<description><![CDATA[Connection name]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="34" package="Default">
|
||
|
|
<name>$conn_db</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="31">
|
||
|
|
<description><![CDATA[Connection database name]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="39" package="Default">
|
||
|
|
<name>$dbtype</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="36">
|
||
|
|
<description><![CDATA[Connection database type]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="44" package="Default">
|
||
|
|
<name>$host</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="41">
|
||
|
|
<description><![CDATA[Connection database host]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="49" package="Default">
|
||
|
|
<name>$user</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="46">
|
||
|
|
<description><![CDATA[Connection user name]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="54" package="Default">
|
||
|
|
<name>$pass</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="51">
|
||
|
|
<description><![CDATA[Connection password]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="59" package="Default">
|
||
|
|
<name>$db_file</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="56">
|
||
|
|
<description><![CDATA[Connection database file]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="64" package="Default">
|
||
|
|
<name>$port</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="61">
|
||
|
|
<description><![CDATA[Connection port]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="69" package="Default">
|
||
|
|
<name>$old_conn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="66">
|
||
|
|
<description><![CDATA[Reference to last connection name]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="74" package="Default">
|
||
|
|
<name>$lblconn</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="71">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="79" package="Default">
|
||
|
|
<name>$lblconn_db</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="76">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="84" package="Default">
|
||
|
|
<name>$lbldbtype</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="81">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="89" package="Default">
|
||
|
|
<name>$lblhost</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="86">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="94" package="Default">
|
||
|
|
<name>$lbluser</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="91">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="99" package="Default">
|
||
|
|
<name>$lblpass</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="96">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="104" package="Default">
|
||
|
|
<name>$lbldatabase</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="101">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="109" package="Default">
|
||
|
|
<name>$lbldb_file</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="106">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="protected" line="114" package="Default">
|
||
|
|
<name>$lblport</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="111">
|
||
|
|
<description><![CDATA[Labels]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="125" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="120">
|
||
|
|
<description><![CDATA[No params = add, params = edit]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="120" name="param" description="" type="object" variable="$db">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="125">
|
||
|
|
<name>$db</name>
|
||
|
|
<default><![CDATA[null]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="211" package="">
|
||
|
|
<name>change_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="206">
|
||
|
|
<description><![CDATA[Set defaults for new database type]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="206" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="280" package="">
|
||
|
|
<name>set_db</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="275">
|
||
|
|
<description><![CDATA[Like change_db function, but save current values]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="275" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="325" package="">
|
||
|
|
<name>db_add</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="320">
|
||
|
|
<description><![CDATA[Adds the database to the settings file]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="320" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="360" package="">
|
||
|
|
<name>db_edit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="355">
|
||
|
|
<description><![CDATA[Edit an existing database connection]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="355" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="398" package="">
|
||
|
|
<name>test_conn</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="393">
|
||
|
|
<description><![CDATA[Test a db connection, and display a popup with the result of the test]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="393" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="445" package="">
|
||
|
|
<name>get_available_dbs</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="440">
|
||
|
|
<description><![CDATA[Checks what database drivers are available]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="440" name="return" description="" type="array">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="503" package="">
|
||
|
|
<name>_add_row</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="494">
|
||
|
|
<description><![CDATA[Simple helper function for adding a row to the GtkTable]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="494" name="param" description="" type="string" variable="$label">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="494" name="param" description="" type="string" variable="$vname">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="494" name="param" description="&$y1" type="int" variable="$y1">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="494" name="param" description="&$y2" type="int" variable="$y2">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="494" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="503">
|
||
|
|
<name>$label</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="503">
|
||
|
|
<name>$vname</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="503">
|
||
|
|
<name>$y1</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="503">
|
||
|
|
<name>$y2</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="524" package="">
|
||
|
|
<name>_layout</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="519">
|
||
|
|
<description><![CDATA[Table layout]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="519" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/windows/add_db.php" hash="0222fe7979ab77d622703845b11144d3" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="default" line="18" package="Default">
|
||
|
|
<name>Add_DB</name>
|
||
|
|
<full_name>\Add_DB</full_name>
|
||
|
|
<extends>\GtkWindow</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Window controlling addition of database connections]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="23" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Create the window]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/windows/edit_db.php" hash="7ef40e491c07e3732a6b458020182033" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="default" line="18" package="Default">
|
||
|
|
<name>Edit_DB</name>
|
||
|
|
<full_name>\Edit_DB</full_name>
|
||
|
|
<extends>\GtkWindow</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Window controlling modifications of database connections]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="25" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Connection editing window]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="20" name="param" description="" type="object" variable="$db_params">
|
||
|
|
<type by_reference="false">object</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="25">
|
||
|
|
<name>$db_params</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/windows/db_table_data.php" hash="b166e0e3d151a415eec24f68ac4551ad" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="default" line="18" package="Default">
|
||
|
|
<name>DB_Table_Data</name>
|
||
|
|
<full_name>\DB_Table_Data</full_name>
|
||
|
|
<extends>\GTKWindow</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Popup window to display database table data]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="protected" line="23" package="Default">
|
||
|
|
<name>$win</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="20">
|
||
|
|
<description><![CDATA[Reference to the scrolled window]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="31" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="25">
|
||
|
|
<description><![CDATA[Create and populate the window]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="25" name="param" description="" type="array" variable="$data">
|
||
|
|
<type by_reference="false">array</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="25" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="31">
|
||
|
|
<name>$data</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="sys/windows/main.php" hash="5281b8239bd465b5768d1c0372d3c79b" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<class final="false" abstract="false" namespace="default" line="20" package="Default">
|
||
|
|
<name>Main</name>
|
||
|
|
<full_name>\Main</full_name>
|
||
|
|
<extends>\GtkWindow</extends>
|
||
|
|
<docblock line="15">
|
||
|
|
<description><![CDATA[Main Window Class]]></description>
|
||
|
|
<long-description><![CDATA[<p>Creates and displays the main interface window</p>]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
<property final="false" static="false" visibility="private" line="25" package="Default">
|
||
|
|
<name>$settings</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="22">
|
||
|
|
<description><![CDATA[Reference to settings instance]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<property final="false" static="false" visibility="private" line="30" package="Default">
|
||
|
|
<name>$connection_sidebar</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<docblock line="27">
|
||
|
|
<description><![CDATA[Reference to connection sidebar instance]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</property>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="35" package="">
|
||
|
|
<name>__construct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="32">
|
||
|
|
<description><![CDATA[Create and display the main window on startup]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
|
||
|
|
<name>__destruct</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="68">
|
||
|
|
<description><![CDATA[Some cleanup for when the main window is closed]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="68" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="95" package="">
|
||
|
|
<name>quit</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="90">
|
||
|
|
<description><![CDATA[Exits the GTK loop]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="90" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="108" package="">
|
||
|
|
<name>_main_layout</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="102">
|
||
|
|
<description><![CDATA[Layout the main interface
|
||
|
|
Create menus, hboxes, vboxs and other widgets]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="102" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="150" package="">
|
||
|
|
<name>_create_menu</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="145">
|
||
|
|
<description><![CDATA[Create the menu for the program]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="145" name="return" description="" type="\GtkMenuBar">
|
||
|
|
<type by_reference="false">\GtkMenuBar</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
</file>
|
||
|
|
<file path="index.php" hash="31e7100561353444d61d9a06ad415219" package="Default">
|
||
|
|
<docblock line="2">
|
||
|
|
<description><![CDATA[OpenSQLManager]]></description>
|
||
|
|
<long-description><![CDATA[<p>Free Database manager for Open Source Databases</p>]]></long-description>
|
||
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
||
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012"/>
|
||
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/OpenSQLManager" link="https://github.com/aviat4ion/OpenSQLManager"/>
|
||
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
||
|
|
</docblock>
|
||
|
|
<include line="126" type="Require Once" package="Default">
|
||
|
|
<name>/db/autoload.php</name>
|
||
|
|
</include>
|
||
|
|
<constant namespace="default" line="33" package="Default">
|
||
|
|
<name>BASE_DIR</name>
|
||
|
|
<value><![CDATA[dirname(__FILE__).'/sys']]></value>
|
||
|
|
</constant>
|
||
|
|
<constant namespace="default" line="34" package="Default">
|
||
|
|
<name>SETTINGS_DIR</name>
|
||
|
|
<value><![CDATA[dirname(__FILE__)]]></value>
|
||
|
|
</constant>
|
||
|
|
<constant namespace="default" line="35" package="Default">
|
||
|
|
<name>PROGRAM_NAME</name>
|
||
|
|
<value><![CDATA['OpenSQLManager']]></value>
|
||
|
|
</constant>
|
||
|
|
<constant namespace="default" line="36" package="Default">
|
||
|
|
<name>VERSION</name>
|
||
|
|
<value><![CDATA['0.1.0pre']]></value>
|
||
|
|
</constant>
|
||
|
|
<function namespace="default" line="43" package="Default">
|
||
|
|
<name>log_fatal</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="40">
|
||
|
|
<description><![CDATA[Log fatal errors]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
</docblock>
|
||
|
|
</function>
|
||
|
|
<function namespace="default" line="87" package="Default">
|
||
|
|
<name>exception_error_handler</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="78">
|
||
|
|
<description><![CDATA[Error handler to convert errors to exceptions]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="78" name="param" description="" type="int" variable="$errno">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="78" name="param" description="" type="string" variable="$errstr">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="78" name="param" description="" type="string" variable="$errfile">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="78" name="param" description="" type="int" variable="$errline">
|
||
|
|
<type by_reference="false">int</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="78" name="throws" description="" type="\ErrorException">
|
||
|
|
<type by_reference="false">\ErrorException</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="87">
|
||
|
|
<name>$errno</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="87">
|
||
|
|
<name>$errstr</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="87">
|
||
|
|
<name>$errfile</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
<argument line="87">
|
||
|
|
<name>$errline</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
<function namespace="default" line="107" package="Default">
|
||
|
|
<name>do_include</name>
|
||
|
|
<type>function</type>
|
||
|
|
<docblock line="100">
|
||
|
|
<description><![CDATA[Bulk directory loading workaround for use
|
||
|
|
with array_map and glob]]></description>
|
||
|
|
<long-description><![CDATA[]]></long-description>
|
||
|
|
<tag line="100" name="param" description="" type="string" variable="$path">
|
||
|
|
<type by_reference="false">string</type>
|
||
|
|
</tag>
|
||
|
|
<tag line="100" name="return" description="" type="void">
|
||
|
|
<type by_reference="false">void</type>
|
||
|
|
</tag>
|
||
|
|
</docblock>
|
||
|
|
<argument line="107">
|
||
|
|
<name>$path</name>
|
||
|
|
<default><![CDATA[]]></default>
|
||
|
|
<type/>
|
||
|
|
</argument>
|
||
|
|
</function>
|
||
|
|
</file>
|
||
|
|
<package name="" full_name=""/>
|
||
|
|
<package name="Default" full_name="Default"/>
|
||
|
|
<namespace name="default" full_name="default"/>
|
||
|
|
<marker count="0">todo</marker>
|
||
|
|
<marker count="0">fixme</marker>
|
||
|
|
<deprecated count="0"/>
|
||
|
|
</project>
|