6311 lines
276 KiB
XML
6311 lines
276 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<project version="2.0.0a2" title="Query">
|
|
<file path="classes/query_parser.php" hash="1c64042730f9b7aef4ad7ed401e2a274" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Query">
|
|
<name>Query_Parser</name>
|
|
<full_name>\Query_Parser</full_name>
|
|
<extends/>
|
|
<docblock line="16">
|
|
<description><![CDATA[Utility Class to parse sql clauses for properly escaping identifiers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="private" line="29" package="Default">
|
|
<name>$match_patterns</name>
|
|
<default><![CDATA[array(
|
|
'function' => '([a-zA-Z0-9_]+\((.*?)\))',
|
|
'identifier' => '([a-zA-Z0-9_-]+\.?)+',
|
|
'operator' => '=|AND|&&?|~|\|\|?|\^|/|>=?|<=?|-|%|OR|\+|NOT|\!=?|<>|XOR'
|
|
)]]></default>
|
|
<docblock line="24">
|
|
<description><![CDATA[Regex patterns for various syntax components]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="var" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="40" package="Default">
|
|
<name>$matches</name>
|
|
<default><![CDATA[array(
|
|
'functions' => array(),
|
|
'identifiers' => array(),
|
|
'operators' => array(),
|
|
'combined' => array(),
|
|
)]]></default>
|
|
<docblock line="35">
|
|
<description><![CDATA[Regex matches]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="35" name="var" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="47">
|
|
<description><![CDATA[Constructor/entry point into parser]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="47" name="param" description="string" type="" variable="$sql"/>
|
|
</docblock>
|
|
<argument line="52">
|
|
<name>$sql</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="74" package="">
|
|
<name>parse_join</name>
|
|
<type>function</type>
|
|
<docblock line="69">
|
|
<description><![CDATA[Public parser method for seting the parse string]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="69" name="param" description="string" type="" variable="$sql"/>
|
|
</docblock>
|
|
<argument line="74">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="private" namespace="default" line="88" package="">
|
|
<name>filter_array</name>
|
|
<type>function</type>
|
|
<docblock line="82">
|
|
<description><![CDATA[Returns a more useful match array]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="82" name="param" description="array" type="" variable="$array"/>
|
|
<tag line="82" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="88">
|
|
<name>$array</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="classes/db_pdo.php" hash="7dd92d54828bc8d3bdda32110461a26d" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<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>
|
|
<parse_markers>
|
|
<error line="27" code="50018">No DocBlock was found for property $statement</error>
|
|
<error line="30" code="50018">No DocBlock was found for property $escape_char</error>
|
|
<error line="33" code="50018">No DocBlock was found for property $sql</error>
|
|
<error line="36" code="50018">No DocBlock was found for property $util</error>
|
|
<error line="39" code="50018">No DocBlock was found for property $last_query</error>
|
|
<error line="42" code="50018">No DocBlock was found for property $table_prefix</error>
|
|
</parse_markers>
|
|
<class final="false" abstract="true" namespace="default" line="24" package="Query\Query">
|
|
<name>DB_PDO</name>
|
|
<full_name>\DB_PDO</full_name>
|
|
<extends>\PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Base Database class]]></description>
|
|
<long-description><![CDATA[<p>Extends PDO to simplify cross-database issues</p>]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="27" package="Default">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="30" package="Default">
|
|
<name>$escape_char</name>
|
|
<default><![CDATA['"']]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="33" package="Default">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="36" package="Default">
|
|
<name>$util</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="39" package="Default">
|
|
<name>$last_query</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="42" package="Default">
|
|
<name>$table_prefix</name>
|
|
<default><![CDATA['']]></default>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="44">
|
|
<description><![CDATA[PDO constructor wrapper]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="44" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="44" name="param" description="" type="string" variable="$username">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="44" name="param" description="" type="string" variable="$password">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="44" name="param" description="" type="array" variable="$driver_options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="52">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="52">
|
|
<name>$username</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="52">
|
|
<name>$password</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="52">
|
|
<name>$driver_options</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="88" package="">
|
|
<name>prepare_query</name>
|
|
<type>function</type>
|
|
<docblock line="81">
|
|
<description><![CDATA[Simplifies prepared statements for database queries]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="81" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="81" name="param" description="" type="array" variable="$data">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="81" name="return" description="PDOStatement / FALSE" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="88">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="88">
|
|
<name>$data</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="139" package="">
|
|
<name>prepare_execute</name>
|
|
<type>function</type>
|
|
<docblock line="132">
|
|
<description><![CDATA[Create and execute a prepared statement with the provided parameters]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="132" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="132" name="param" description="" type="array" variable="$params">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="132" name="return" description="" type="\PDOStatement">
|
|
<type by_reference="false">\PDOStatement</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="139">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="139">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="155" package="">
|
|
<name>get_query_data</name>
|
|
<type>function</type>
|
|
<docblock line="149">
|
|
<description><![CDATA[Retreives the data from a select query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="149" name="param" description="" type="\PDOStatement" variable="$statement">
|
|
<type by_reference="false">\PDOStatement</type>
|
|
</tag>
|
|
<tag line="149" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="155">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="174" package="">
|
|
<name>affected_rows</name>
|
|
<type>function</type>
|
|
<docblock line="168">
|
|
<description><![CDATA[Returns number of rows affected by an INSERT, UPDATE, DELETE type query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="168" name="param" description="" type="\PDOStatement" variable="$statement">
|
|
<type by_reference="false">\PDOStatement</type>
|
|
</tag>
|
|
<tag line="168" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="174">
|
|
<name>$statement</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="192" package="">
|
|
<name>get_last_error</name>
|
|
<type>function</type>
|
|
<docblock line="187">
|
|
<description><![CDATA[Return the last error for the current database connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="187" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="207" package="">
|
|
<name>quote_table</name>
|
|
<type>function</type>
|
|
<docblock line="201">
|
|
<description><![CDATA[Quote database table name, and set prefix]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="201" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="201" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="207">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="244" package="">
|
|
<name>_prefix</name>
|
|
<type>function</type>
|
|
<docblock line="238">
|
|
<description><![CDATA[Sets the table prefix on the passed string]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="238" name="param" description="" type="string" variable="$str">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="238" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="244">
|
|
<name>$str</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="263" package="">
|
|
<name>quote_ident</name>
|
|
<type>function</type>
|
|
<docblock line="257">
|
|
<description><![CDATA[Surrounds the string with the databases identifier escape characters]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="257" name="param" description="" type="mixed" variable="$ident">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="257" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="263">
|
|
<name>$ident</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="310" package="">
|
|
<name>_quote</name>
|
|
<type>function</type>
|
|
<docblock line="304">
|
|
<description><![CDATA[Helper method for quote_ident]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="304" name="param" description="" type="mixed" variable="$str">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="304" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="310">
|
|
<name>$str</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="336" package="">
|
|
<name>empty_table</name>
|
|
<type>function</type>
|
|
<docblock line="329">
|
|
<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="329" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="329" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="336">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="350" package="">
|
|
<name>get_schemas</name>
|
|
<type>function</type>
|
|
<docblock line="345">
|
|
<description><![CDATA[Return schemas for databases that list them]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="345" 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="362" package="">
|
|
<name>get_tables</name>
|
|
<type>function</type>
|
|
<docblock line="357">
|
|
<description><![CDATA[Return list of tables for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="357" 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="374" package="">
|
|
<name>get_dbs</name>
|
|
<type>function</type>
|
|
<docblock line="369">
|
|
<description><![CDATA[Return list of dbs for the current connection, if possible]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="369" 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="386" package="">
|
|
<name>get_views</name>
|
|
<type>function</type>
|
|
<docblock line="381">
|
|
<description><![CDATA[Return list of views for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="381" 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="398" package="">
|
|
<name>get_sequences</name>
|
|
<type>function</type>
|
|
<docblock line="393">
|
|
<description><![CDATA[Return list of sequences for the current database, if they exist]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="393" 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="410" package="">
|
|
<name>get_functions</name>
|
|
<type>function</type>
|
|
<docblock line="405">
|
|
<description><![CDATA[Return list of function for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="405" 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="422" package="">
|
|
<name>get_procedures</name>
|
|
<type>function</type>
|
|
<docblock line="417">
|
|
<description><![CDATA[Return list of stored procedures for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="417" 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="434" package="">
|
|
<name>get_triggers</name>
|
|
<type>function</type>
|
|
<docblock line="429">
|
|
<description><![CDATA[Return list of triggers for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="429" 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="447" package="">
|
|
<name>get_system_tables</name>
|
|
<type>function</type>
|
|
<docblock line="441">
|
|
<description><![CDATA[Retreives an array of non-user-created tables for
|
|
the connection/database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="441" 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="460" package="">
|
|
<name>get_columns</name>
|
|
<type>function</type>
|
|
<docblock line="454">
|
|
<description><![CDATA[Retrieve column information for the current database table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="454" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="454" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="460">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="472" package="">
|
|
<name>get_types</name>
|
|
<type>function</type>
|
|
<docblock line="467">
|
|
<description><![CDATA[Retrieve list of data types for the database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="467" 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="486" package="">
|
|
<name>driver_query</name>
|
|
<type>function</type>
|
|
<docblock line="479">
|
|
<description><![CDATA[Method to simplify retreiving db results for meta-data queries]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="479" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="479" name="param" description="" type="bool" variable="$filtered_index">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="479" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="486">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="486">
|
|
<name>$filtered_index</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="516" package="">
|
|
<name>num_rows</name>
|
|
<type>function</type>
|
|
<docblock line="510">
|
|
<description><![CDATA[Return the number of rows returned for a SELECT query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="510" name="see" description="\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110" refers="\http://us3.php.net/manual/en/pdostatement.rowcount.php#87110"/>
|
|
<tag line="510" 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="540" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="534">
|
|
<description><![CDATA[Empty the passed table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="534" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="534" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="540">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="classes/query_builder.php" hash="c6d0516df04257774de596c04dd26627" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<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>
|
|
<parse_markers>
|
|
<error line="30" code="50018">No DocBlock was found for property $select_string</error>
|
|
<error line="33" code="50018">No DocBlock was found for property $from_string</error>
|
|
<error line="36" code="50018">No DocBlock was found for property $set_string</error>
|
|
<error line="39" code="50018">No DocBlock was found for property $order_string</error>
|
|
<error line="42" code="50018">No DocBlock was found for property $group_string</error>
|
|
<error line="49" code="50018">No DocBlock was found for property $set_array_keys</error>
|
|
<error line="52" code="50018">No DocBlock was found for property $order_array</error>
|
|
<error line="55" code="50018">No DocBlock was found for property $group_array</error>
|
|
<error line="62" code="50018">No DocBlock was found for property $values</error>
|
|
<error line="65" code="50018">No DocBlock was found for property $where_values</error>
|
|
<error line="68" code="50018">No DocBlock was found for property $limit</error>
|
|
<error line="71" code="50018">No DocBlock was found for property $offset</error>
|
|
<error line="74" code="50018">No DocBlock was found for property $sql</error>
|
|
<error line="85" code="50018">No DocBlock was found for property $query_map</error>
|
|
<error line="88" code="50018">No DocBlock was found for property $having_map</error>
|
|
<error line="91" code="50018">No DocBlock was found for property $conn_name</error>
|
|
<error line="94" code="50018">No DocBlock was found for property $queries</error>
|
|
</parse_markers>
|
|
<class final="false" abstract="false" namespace="default" line="23" package="Query\Query">
|
|
<name>Query_Builder</name>
|
|
<full_name>\Query_Builder</full_name>
|
|
<extends/>
|
|
<implements>\iQuery_Builder</implements>
|
|
<docblock line="16">
|
|
<description><![CDATA[Convienience class for creating sql queries - also the class that
|
|
instantiates the specific db driver]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="30" package="Default">
|
|
<name>$select_string</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="33" package="Default">
|
|
<name>$from_string</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="36" package="Default">
|
|
<name>$set_string</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="39" package="Default">
|
|
<name>$order_string</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="42" package="Default">
|
|
<name>$group_string</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="49" package="Default">
|
|
<name>$set_array_keys</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="52" package="Default">
|
|
<name>$order_array</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="55" package="Default">
|
|
<name>$group_array</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="62" package="Default">
|
|
<name>$values</name>
|
|
<default><![CDATA[array()]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="65" package="Default">
|
|
<name>$where_values</name>
|
|
<default><![CDATA[array()]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="68" package="Default">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="71" package="Default">
|
|
<name>$offset</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="74" package="Default">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="85" package="Default">
|
|
<name>$query_map</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="88" package="Default">
|
|
<name>$having_map</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="91" package="Default">
|
|
<name>$conn_name</name>
|
|
<default><![CDATA[""]]></default>
|
|
</property>
|
|
<property final="false" static="false" visibility="public" line="94" package="Default">
|
|
<name>$queries</name>
|
|
<default><![CDATA[]]></default>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="106" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="100">
|
|
<description><![CDATA[Constructor]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="100" name="param" description="" type="\DB_PDO" variable="$db">
|
|
<type by_reference="false">\DB_PDO</type>
|
|
</tag>
|
|
<tag line="100" name="param" description="- the connection parameters" type="object" variable="$params">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="106">
|
|
<name>$db</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="106">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="135" package="">
|
|
<name>select</name>
|
|
<type>function</type>
|
|
<docblock line="129">
|
|
<description><![CDATA[Specifies rows to select in a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="129" name="param" description="" type="string" variable="$fields">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="129" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="135">
|
|
<name>$fields</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="181" package="">
|
|
<name>_select</name>
|
|
<type>function</type>
|
|
<docblock line="174">
|
|
<description><![CDATA[Method to simplify select_ methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="174" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="174" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="174" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="181">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="181">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="202" package="">
|
|
<name>select_max</name>
|
|
<type>function</type>
|
|
<docblock line="195">
|
|
<description><![CDATA[Selects the maximum value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="195" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="195" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="195" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="202">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="202">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="218" package="">
|
|
<name>select_min</name>
|
|
<type>function</type>
|
|
<docblock line="211">
|
|
<description><![CDATA[Selects the minimum value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="211" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="211" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="211" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="218">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="218">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="234" package="">
|
|
<name>select_avg</name>
|
|
<type>function</type>
|
|
<docblock line="227">
|
|
<description><![CDATA[Selects the average value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="227" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="227" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="227" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="234">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="234">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="250" package="">
|
|
<name>select_sum</name>
|
|
<type>function</type>
|
|
<docblock line="243">
|
|
<description><![CDATA[Selects the sum of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="243" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="243" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="243" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="250">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="250">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="264" package="">
|
|
<name>distinct</name>
|
|
<type>function</type>
|
|
<docblock line="259">
|
|
<description><![CDATA[Adds the 'distinct' keyword to a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="259" 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="279" package="">
|
|
<name>from</name>
|
|
<type>function</type>
|
|
<docblock line="273">
|
|
<description><![CDATA[Specify the database table to select from]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="273" name="param" description="" type="string" variable="$tblname">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="273" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="279">
|
|
<name>$tblname</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="309" package="">
|
|
<name>_like</name>
|
|
<type>function</type>
|
|
<docblock line="299">
|
|
<description><![CDATA[Simplify 'like' methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="299" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="299" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="299" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="299" name="param" description="" type="string" variable="$like">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="299" name="param" description="" type="string" variable="$conj">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="299" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="309">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="309">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="309">
|
|
<name>$pos</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="309">
|
|
<name>$like</name>
|
|
<default><![CDATA['LIKE']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="309">
|
|
<name>$conj</name>
|
|
<default><![CDATA['AND']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="351" package="">
|
|
<name>like</name>
|
|
<type>function</type>
|
|
<docblock line="343">
|
|
<description><![CDATA[Creates a Like clause in the sql statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="343" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="343" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="343" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="343" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="351">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="351">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="351">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="366" package="">
|
|
<name>or_like</name>
|
|
<type>function</type>
|
|
<docblock line="358">
|
|
<description><![CDATA[Generates an OR Like clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="358" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="358" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="358" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="358" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="366">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="366">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="366">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="381" package="">
|
|
<name>not_like</name>
|
|
<type>function</type>
|
|
<docblock line="373">
|
|
<description><![CDATA[Generates a NOT LIKE clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="373" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="373" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="373" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="373" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="381">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="381">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="381">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="396" package="">
|
|
<name>or_not_like</name>
|
|
<type>function</type>
|
|
<docblock line="388">
|
|
<description><![CDATA[Generates a OR NOT LIKE clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="388" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="388" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="388" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="388" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="396">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="396">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="396">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="413" package="">
|
|
<name>_having</name>
|
|
<type>function</type>
|
|
<docblock line="405">
|
|
<description><![CDATA[Simplify building having clauses]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="405" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="405" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="405" name="param" description="" type="string" variable="$conj">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="405" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="413">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="413">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="413">
|
|
<name>$conj</name>
|
|
<default><![CDATA['AND']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="448" package="">
|
|
<name>having</name>
|
|
<type>function</type>
|
|
<docblock line="441">
|
|
<description><![CDATA[Generates a 'Having' clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="441" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="441" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="441" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="448">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="448">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="462" package="">
|
|
<name>or_having</name>
|
|
<type>function</type>
|
|
<docblock line="455">
|
|
<description><![CDATA[Generates a 'Having' clause prefixed with 'OR']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="455" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="455" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="455" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="462">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="462">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="478" package="">
|
|
<name>_where</name>
|
|
<type>function</type>
|
|
<docblock line="471">
|
|
<description><![CDATA[Do all the repeditive stuff for where/having type methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="471" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="471" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="471" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="478">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="478">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="511" package="">
|
|
<name>_where_string</name>
|
|
<type>function</type>
|
|
<docblock line="503">
|
|
<description><![CDATA[Simplify generating where string]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="503" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="503" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="503" name="param" description="" type="string" variable="$conj">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="503" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="511">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="511">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="511">
|
|
<name>$conj</name>
|
|
<default><![CDATA['AND']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="549" package="">
|
|
<name>_where_in</name>
|
|
<type>function</type>
|
|
<docblock line="540">
|
|
<description><![CDATA[Simplify where_in methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="540" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="540" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="540" name="param" description="string" type="" variable="$in"/>
|
|
<tag line="540" name="param" description="string" type="" variable="$conj"/>
|
|
<tag line="540" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="549">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="549">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="549">
|
|
<name>$in</name>
|
|
<default><![CDATA['IN']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="549">
|
|
<name>$conj</name>
|
|
<default><![CDATA['AND']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="581" package="">
|
|
<name>where</name>
|
|
<type>function</type>
|
|
<docblock line="572">
|
|
<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="572" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="572" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="572" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="581">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="581">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="595" package="">
|
|
<name>or_where</name>
|
|
<type>function</type>
|
|
<docblock line="588">
|
|
<description><![CDATA[Where clause prefixed with "OR"]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="588" name="param" description="" type="string" variable="$key">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="588" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="588" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="595">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="595">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="609" package="">
|
|
<name>where_in</name>
|
|
<type>function</type>
|
|
<docblock line="602">
|
|
<description><![CDATA[Where clause with 'IN' statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="602" name="param" description="" type="mixed" variable="$field">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="602" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="602" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="609">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="609">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="623" package="">
|
|
<name>or_where_in</name>
|
|
<type>function</type>
|
|
<docblock line="616">
|
|
<description><![CDATA[Where in statement prefixed with "or"]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="616" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="616" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="616" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="623">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="623">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="637" package="">
|
|
<name>where_not_in</name>
|
|
<type>function</type>
|
|
<docblock line="630">
|
|
<description><![CDATA[WHERE NOT IN (FOO) clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="630" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="630" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="630" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="637">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="637">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="651" package="">
|
|
<name>or_where_not_in</name>
|
|
<type>function</type>
|
|
<docblock line="644">
|
|
<description><![CDATA[OR WHERE NOT IN (FOO) clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="644" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="644" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="644" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="651">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="651">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="667" package="">
|
|
<name>set</name>
|
|
<type>function</type>
|
|
<docblock line="660">
|
|
<description><![CDATA[Sets values for inserts / updates / deletes]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="660" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="660" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="660" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="667">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="667">
|
|
<name>$val</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="706" package="">
|
|
<name>join</name>
|
|
<type>function</type>
|
|
<docblock line="698">
|
|
<description><![CDATA[Creates a join phrase in a compiled query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="698" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="698" name="param" description="" type="string" variable="$condition">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="698" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="698" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="706">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="706">
|
|
<name>$condition</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="706">
|
|
<name>$type</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="748" package="">
|
|
<name>group_by</name>
|
|
<type>function</type>
|
|
<docblock line="742">
|
|
<description><![CDATA[Group the results by the selected field(s)]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="742" name="param" description="" type="mixed" variable="$field">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="742" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="748">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="773" package="">
|
|
<name>order_by</name>
|
|
<type>function</type>
|
|
<docblock line="766">
|
|
<description><![CDATA[Order the results by the selected field(s)]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="766" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="766" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="766" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="773">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="773">
|
|
<name>$type</name>
|
|
<default><![CDATA[""]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="810" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="803">
|
|
<description><![CDATA[Set a limit on the current sql statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="803" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="803" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="803" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="810">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="810">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="827" package="">
|
|
<name>group_start</name>
|
|
<type>function</type>
|
|
<docblock line="822">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="822" 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="846" package="">
|
|
<name>or_group_start</name>
|
|
<type>function</type>
|
|
<docblock line="840">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping,
|
|
prefixed with 'OR']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="840" 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="865" package="">
|
|
<name>or_not_group_start</name>
|
|
<type>function</type>
|
|
<docblock line="859">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping,
|
|
prefixed with 'OR NOT']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="859" 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="883" package="">
|
|
<name>group_end</name>
|
|
<type>function</type>
|
|
<docblock line="878">
|
|
<description><![CDATA[Ends a query group]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="878" 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="907" package="">
|
|
<name>get</name>
|
|
<type>function</type>
|
|
<docblock line="898">
|
|
<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="898" name="param" description="" type="" variable="$table"/>
|
|
<tag line="898" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="898" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="898" name="return" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="907">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="907">
|
|
<name>$limit</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="907">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="943" package="">
|
|
<name>get_where</name>
|
|
<type>function</type>
|
|
<docblock line="934">
|
|
<description><![CDATA[Convience method for get() with a where clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="934" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="934" name="param" description="" type="array" variable="$where">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="934" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="934" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="934" name="return" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="943">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="943">
|
|
<name>$where</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="943">
|
|
<name>$limit</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="943">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="960" package="">
|
|
<name>count_all</name>
|
|
<type>function</type>
|
|
<docblock line="954">
|
|
<description><![CDATA[Retreive the number of rows in the selected table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="954" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="954" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="960">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="976" package="">
|
|
<name>count_all_results</name>
|
|
<type>function</type>
|
|
<docblock line="969">
|
|
<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="969" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="969" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="976">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1009" package="">
|
|
<name>insert</name>
|
|
<type>function</type>
|
|
<docblock line="1002">
|
|
<description><![CDATA[Creates an insert clause, and executes it]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1002" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1002" name="param" description="" type="mixed" variable="$data">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="1002" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1009">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1009">
|
|
<name>$data</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1029" package="">
|
|
<name>update</name>
|
|
<type>function</type>
|
|
<docblock line="1022">
|
|
<description><![CDATA[Creates an update clause, and executes it]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1022" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1022" name="param" description="" type="mixed" variable="$data">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="1022" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1029">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1029">
|
|
<name>$data</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1049" package="">
|
|
<name>delete</name>
|
|
<type>function</type>
|
|
<docblock line="1042">
|
|
<description><![CDATA[Deletes data from a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1042" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1042" name="param" description="" type="mixed" variable="$where">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="1042" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1049">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1049">
|
|
<name>$where</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1071" package="">
|
|
<name>get_compiled_select</name>
|
|
<type>function</type>
|
|
<docblock line="1064">
|
|
<description><![CDATA[Returns the generated 'select' sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1064" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1064" name="param" description="" type="bool" variable="$reset">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="1064" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1071">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1071">
|
|
<name>$reset</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1091" package="">
|
|
<name>get_compiled_insert</name>
|
|
<type>function</type>
|
|
<docblock line="1084">
|
|
<description><![CDATA[Returns the generated 'insert' sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1084" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1084" name="param" description="" type="bool" variable="$reset">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="1084" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1091">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1091">
|
|
<name>$reset</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1105" package="">
|
|
<name>get_compiled_update</name>
|
|
<type>function</type>
|
|
<docblock line="1098">
|
|
<description><![CDATA[Returns the generated 'update' sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1098" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1098" name="param" description="" type="bool" variable="$reset">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="1098" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1105">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1105">
|
|
<name>$reset</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1119" package="">
|
|
<name>get_compiled_delete</name>
|
|
<type>function</type>
|
|
<docblock line="1112">
|
|
<description><![CDATA[Returns the generated 'delete' sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1112" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1112" name="param" description="" type="bool" variable="$reset">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="1112" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1119">
|
|
<name>$table</name>
|
|
<default><![CDATA[""]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1119">
|
|
<name>$reset</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="1134" package="">
|
|
<name>_get_compile</name>
|
|
<type>function</type>
|
|
<docblock line="1126">
|
|
<description><![CDATA[Helper function for returning sql strings]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1126" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1126" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1126" name="param" description="bool" type="" variable="$reset"/>
|
|
<tag line="1126" name="resturn" description="string"/>
|
|
</docblock>
|
|
<argument line="1134">
|
|
<name>$type</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1134">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1134">
|
|
<name>$reset</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1156" package="">
|
|
<name>reset_query</name>
|
|
<type>function</type>
|
|
<docblock line="1151">
|
|
<description><![CDATA[Clear out the class variables, so the next query can be run]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1151" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="1190" package="">
|
|
<name>_run</name>
|
|
<type>function</type>
|
|
<docblock line="1182">
|
|
<description><![CDATA[Executes the compiled query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1182" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1182" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1182" name="param" description="" type="bool" variable="$simple">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="1182" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1190">
|
|
<name>$type</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1190">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1190">
|
|
<name>$simple</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="1244" package="">
|
|
<name>__call</name>
|
|
<type>function</type>
|
|
<docblock line="1237">
|
|
<description><![CDATA[Calls a function further down the inheritence chain]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1237" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1237" name="param" description="" type="array" variable="$params">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="1237" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1244">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1244">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="protected" namespace="default" line="1263" package="">
|
|
<name>_compile</name>
|
|
<type>function</type>
|
|
<docblock line="1256">
|
|
<description><![CDATA[String together the sql statements for sending to the db]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="1256" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1256" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="1256" name="return" description="" type="\$string">
|
|
<type by_reference="false">\$string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="1263">
|
|
<name>$type</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="1263">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="classes/idb_sql.php" hash="85065c2ec86f3f26e8489d24e87c77cc" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
<tag line="2" name="package" description="Query"/>
|
|
</docblock>
|
|
<interface namespace="default" line="22" package="Query\Query">
|
|
<name>iDB_SQL</name>
|
|
<full_name>\iDB_SQL</full_name>
|
|
<extends/>
|
|
<docblock line="16">
|
|
<description><![CDATA[parent for database manipulation subclasses]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="33" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Get database specific sql for limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="abstract" description=""/>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="33">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="33">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="33">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="41" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="35">
|
|
<description><![CDATA[Get the sql for random ordering]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="35" name="abstract" 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="48" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="43">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="43" 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="55" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="50">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="50" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="57">
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="57" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="64">
|
|
<description><![CDATA[Returns sql to list views]]></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="76" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="71">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="71" 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="83" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="78">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="78" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="85">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="85" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="97" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="92">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="92" 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="104" package="">
|
|
<name>type_list</name>
|
|
<type>function</type>
|
|
<docblock line="99">
|
|
<description><![CDATA[Return sql to list database field types]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="99" 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="113" package="">
|
|
<name>column_list</name>
|
|
<type>function</type>
|
|
<docblock line="106">
|
|
<description><![CDATA[Get information about the columns in the
|
|
specified table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="106" name="param" description="string" type="" variable="$table"/>
|
|
<tag line="106" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="113">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</interface>
|
|
</file>
|
|
<file path="classes/iquery_builder.php" hash="4efeb1d0e37a7c01d7fabc070ec3b83e" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<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>
|
|
<interface namespace="default" line="22" package="Query\Query">
|
|
<name>iQuery_Builder</name>
|
|
<full_name>\iQuery_Builder</full_name>
|
|
<extends/>
|
|
<docblock line="16">
|
|
<description><![CDATA[Interface defining the Query Builder class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="34" package="">
|
|
<name>select</name>
|
|
<type>function</type>
|
|
<docblock line="28">
|
|
<description><![CDATA[Specifies rows to select in a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="28" name="param" description="" type="string" variable="$fields">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="28" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="34">
|
|
<name>$fields</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="45" package="">
|
|
<name>select_max</name>
|
|
<type>function</type>
|
|
<docblock line="38">
|
|
<description><![CDATA[Selects the maximum value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="38" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="38" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="38" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="45">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="45">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
|
|
<name>select_min</name>
|
|
<type>function</type>
|
|
<docblock line="49">
|
|
<description><![CDATA[Selects the minimum value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="49" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="49" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="49" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="56">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="56">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="67" package="">
|
|
<name>select_avg</name>
|
|
<type>function</type>
|
|
<docblock line="60">
|
|
<description><![CDATA[Selects the average value of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="60" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="60" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="60" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="67">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="67">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="78" package="">
|
|
<name>select_sum</name>
|
|
<type>function</type>
|
|
<docblock line="71">
|
|
<description><![CDATA[Selects the sum of a field from a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="71" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="71" name="param" description="" type="string" variable="$as">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="71" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="78">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="78">
|
|
<name>$as</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="87" package="">
|
|
<name>distinct</name>
|
|
<type>function</type>
|
|
<docblock line="82">
|
|
<description><![CDATA[Adds the 'distinct' keyword to a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="82" 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="97" package="">
|
|
<name>from</name>
|
|
<type>function</type>
|
|
<docblock line="91">
|
|
<description><![CDATA[Specify the database table to select from]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="91" name="param" description="" type="string" variable="$tblname">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="91" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="97">
|
|
<name>$tblname</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="111" package="">
|
|
<name>like</name>
|
|
<type>function</type>
|
|
<docblock line="103">
|
|
<description><![CDATA[Creates a Like clause in the sql statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="103" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="103" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="103" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="103" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="111">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="111">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="111">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="123" package="">
|
|
<name>or_like</name>
|
|
<type>function</type>
|
|
<docblock line="115">
|
|
<description><![CDATA[Generates an OR Like clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="115" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="115" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="115" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="115" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="123">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="123">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="123">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="135" package="">
|
|
<name>not_like</name>
|
|
<type>function</type>
|
|
<docblock line="127">
|
|
<description><![CDATA[Generates a NOT LIKE clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="127" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="127" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="127" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="127" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="135">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="135">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="135">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="147" package="">
|
|
<name>or_not_like</name>
|
|
<type>function</type>
|
|
<docblock line="139">
|
|
<description><![CDATA[Generates a OR NOT LIKE clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="139" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="139" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="139" name="param" description="" type="string" variable="$pos">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="139" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="147">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="147">
|
|
<name>$val</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="147">
|
|
<name>$pos</name>
|
|
<default><![CDATA['both']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="160" package="">
|
|
<name>having</name>
|
|
<type>function</type>
|
|
<docblock line="153">
|
|
<description><![CDATA[Generates a 'Having' clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="153" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="153" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="153" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="160">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="160">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="171" package="">
|
|
<name>or_having</name>
|
|
<type>function</type>
|
|
<docblock line="164">
|
|
<description><![CDATA[Generates a 'Having' clause prefixed with 'OR']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="164" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="164" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="164" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="171">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="171">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="186" package="">
|
|
<name>where</name>
|
|
<type>function</type>
|
|
<docblock line="177">
|
|
<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="177" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="177" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="177" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="186">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="186">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="197" package="">
|
|
<name>or_where</name>
|
|
<type>function</type>
|
|
<docblock line="190">
|
|
<description><![CDATA[Where clause prefixed with "OR"]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="190" name="param" description="" type="string" variable="$key">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="190" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="190" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="197">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="197">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="208" package="">
|
|
<name>where_in</name>
|
|
<type>function</type>
|
|
<docblock line="201">
|
|
<description><![CDATA[Where clause with 'IN' statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="201" name="param" description="" type="mixed" variable="$field">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="201" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="201" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="208">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="208">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="219" package="">
|
|
<name>or_where_in</name>
|
|
<type>function</type>
|
|
<docblock line="212">
|
|
<description><![CDATA[Where in statement prefixed with "or"]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="212" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="212" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="212" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="219">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="219">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="230" package="">
|
|
<name>where_not_in</name>
|
|
<type>function</type>
|
|
<docblock line="223">
|
|
<description><![CDATA[WHERE NOT IN (FOO) clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="223" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="223" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="223" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="230">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="230">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="241" package="">
|
|
<name>or_where_not_in</name>
|
|
<type>function</type>
|
|
<docblock line="234">
|
|
<description><![CDATA[OR WHERE NOT IN (FOO) clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="234" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="234" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="234" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="241">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="241">
|
|
<name>$val</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="254" package="">
|
|
<name>set</name>
|
|
<type>function</type>
|
|
<docblock line="247">
|
|
<description><![CDATA[Sets values for inserts / updates / deletes]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="247" name="param" description="" type="mixed" variable="$key">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="247" name="param" description="" type="mixed" variable="$val">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="247" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="254">
|
|
<name>$key</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="254">
|
|
<name>$val</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="266" package="">
|
|
<name>join</name>
|
|
<type>function</type>
|
|
<docblock line="258">
|
|
<description><![CDATA[Creates a join phrase in a compiled query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="258" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="258" name="param" description="" type="string" variable="$condition">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="258" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="258" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="266">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="266">
|
|
<name>$condition</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="266">
|
|
<name>$type</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="276" package="">
|
|
<name>group_by</name>
|
|
<type>function</type>
|
|
<docblock line="270">
|
|
<description><![CDATA[Group the results by the selected field(s)]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="270" name="param" description="" type="mixed" variable="$field">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="270" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="276">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="287" package="">
|
|
<name>order_by</name>
|
|
<type>function</type>
|
|
<docblock line="280">
|
|
<description><![CDATA[Order the results by the selected field(s)]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="280" name="param" description="" type="string" variable="$field">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="280" name="param" description="" type="string" variable="$type">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="280" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="287">
|
|
<name>$field</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="287">
|
|
<name>$type</name>
|
|
<default><![CDATA[""]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="298" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="291">
|
|
<description><![CDATA[Set a limit on the current sql statement]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="291" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="291" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="291" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="298">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="298">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="309" package="">
|
|
<name>group_start</name>
|
|
<type>function</type>
|
|
<docblock line="304">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="304" 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="319" package="">
|
|
<name>or_group_start</name>
|
|
<type>function</type>
|
|
<docblock line="313">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping,
|
|
prefixed with 'OR']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="313" 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="329" package="">
|
|
<name>or_not_group_start</name>
|
|
<type>function</type>
|
|
<docblock line="323">
|
|
<description><![CDATA[Adds a paren to the current query for query grouping,
|
|
prefixed with 'OR NOT']]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="323" 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="338" package="">
|
|
<name>group_end</name>
|
|
<type>function</type>
|
|
<docblock line="333">
|
|
<description><![CDATA[Ends a query group]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="333" 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="353" package="">
|
|
<name>get</name>
|
|
<type>function</type>
|
|
<docblock line="344">
|
|
<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="344" name="param" description="" type="" variable="$table"/>
|
|
<tag line="344" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="344" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="344" name="return" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="353">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="353">
|
|
<name>$limit</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="353">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="366" package="">
|
|
<name>get_where</name>
|
|
<type>function</type>
|
|
<docblock line="357">
|
|
<description><![CDATA[Convience method for get() with a where clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="357" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="357" name="param" description="" type="array" variable="$where">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="357" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="357" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="357" name="return" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="366">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="366">
|
|
<name>$where</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="366">
|
|
<name>$limit</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="366">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="376" package="">
|
|
<name>count_all</name>
|
|
<type>function</type>
|
|
<docblock line="370">
|
|
<description><![CDATA[Retreive the number of rows in the selected table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="370" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="370" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="376">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="387" package="">
|
|
<name>count_all_results</name>
|
|
<type>function</type>
|
|
<docblock line="380">
|
|
<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="380" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="380" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="387">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="398" package="">
|
|
<name>insert</name>
|
|
<type>function</type>
|
|
<docblock line="391">
|
|
<description><![CDATA[Creates an insert clause, and executes it]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="391" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="391" name="param" description="" type="mixed" variable="$data">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="391" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="398">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="398">
|
|
<name>$data</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="409" package="">
|
|
<name>update</name>
|
|
<type>function</type>
|
|
<docblock line="402">
|
|
<description><![CDATA[Creates an update clause, and executes it]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="402" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="402" name="param" description="" type="mixed" variable="$data">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="402" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="409">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="409">
|
|
<name>$data</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="420" package="">
|
|
<name>delete</name>
|
|
<type>function</type>
|
|
<docblock line="413">
|
|
<description><![CDATA[Deletes data from a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="413" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="413" name="param" description="" type="mixed" variable="$where">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="413" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="420">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="420">
|
|
<name>$where</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="433" package="">
|
|
<name>get_compiled_select</name>
|
|
<type>function</type>
|
|
<docblock line="426">
|
|
<description><![CDATA[Returns the generated 'select' sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="426" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="426" name="param" description="" type="bool" variable="$reset">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="426" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="433">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="433">
|
|
<name>$reset</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="444" package="">
|
|
<name>get_compiled_insert</name>
|
|
<type>function</type>
|
|
<docblock line="437">
|
|
<description><![CDATA[Returns the generated 'insert' sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="437" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="437" name="param" description="" type="bool" variable="$reset">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="437" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="444">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="444">
|
|
<name>$reset</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="455" package="">
|
|
<name>get_compiled_update</name>
|
|
<type>function</type>
|
|
<docblock line="448">
|
|
<description><![CDATA[Returns the generated 'update' sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="448" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="448" name="param" description="" type="bool" variable="$reset">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="448" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="455">
|
|
<name>$table</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="455">
|
|
<name>$reset</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="466" package="">
|
|
<name>get_compiled_delete</name>
|
|
<type>function</type>
|
|
<docblock line="459">
|
|
<description><![CDATA[Returns the generated 'delete' sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="459" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="459" name="param" description="" type="bool" variable="$reset">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="459" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="466">
|
|
<name>$table</name>
|
|
<default><![CDATA[""]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="466">
|
|
<name>$reset</name>
|
|
<default><![CDATA[TRUE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="477" package="">
|
|
<name>reset_query</name>
|
|
<type>function</type>
|
|
<docblock line="472">
|
|
<description><![CDATA[Clear out the class variables, so the next query can be run]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="472" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</interface>
|
|
</file>
|
|
<file path="classes/db_util.php" hash="dc7951c57dc06ec5a1a997f40caf14fc" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="true" namespace="default" line="22" package="Query\Query">
|
|
<name>DB_Util</name>
|
|
<full_name>\DB_Util</full_name>
|
|
<extends/>
|
|
<docblock line="16">
|
|
<description><![CDATA[Abstract class defining database / table creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="private" line="27" package="Default">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="24">
|
|
<description><![CDATA[Reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="34" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="29">
|
|
<description><![CDATA[Save a reference to the connection object for later use]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="29" name="param" description="" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="34">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
|
|
<name>__call</name>
|
|
<type>function</type>
|
|
<docblock line="41">
|
|
<description><![CDATA[Enable calling driver methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="41" name="param" description="" type="string" variable="$method">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="41" name="param" description="" type="array" variable="$args">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="47">
|
|
<name>$method</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$args</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="71" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="61">
|
|
<description><![CDATA[Get database-specific sql to create a new table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="61" name="abstract" description=""/>
|
|
<tag line="61" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="61" name="param" description="" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="61" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="61" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="61" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="71">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="71">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="71">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="71">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="80" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="73">
|
|
<description><![CDATA[Get database-specific sql to drop a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="73" name="abstract" description=""/>
|
|
<tag line="73" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="73" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="80">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="88" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="82">
|
|
<description><![CDATA[Return an SQL file with the database table structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="82" name="abstract" description=""/>
|
|
<tag line="82" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="true" static="false" visibility="public" namespace="default" line="96" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="90">
|
|
<description><![CDATA[Return an SQL file with the database data as insert statements]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="90" name="abstract" description=""/>
|
|
<tag line="90" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="autoload.php" hash="b4809418736de74a636101819f2ba2fa" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<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>
|
|
<include line="31" type="Require" package="Default">
|
|
<name>common.php</name>
|
|
</include>
|
|
<constant namespace="default" line="23" package="Default">
|
|
<name>QBASE_PATH</name>
|
|
<value><![CDATA[dirname(__FILE__).'/']]></value>
|
|
<docblock line="20">
|
|
<description><![CDATA[Reference to root path]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</constant>
|
|
<constant namespace="default" line="28" package="Default">
|
|
<name>QDRIVER_PATH</name>
|
|
<value><![CDATA[QBASE_PATH.'drivers/']]></value>
|
|
<docblock line="25">
|
|
<description><![CDATA[Path to driver classes]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</constant>
|
|
<function namespace="default" line="38" package="Query">
|
|
<name>query_autoload</name>
|
|
<type>function</type>
|
|
<docblock line="33">
|
|
<description><![CDATA[Load a Query class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="33" name="param" description="" type="string" variable="$class">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="38">
|
|
<name>$class</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</function>
|
|
</file>
|
|
<file path="common.php" hash="e43f78d39a7599eb44291581225c6346" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<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>
|
|
<function namespace="default" line="49" package="Query">
|
|
<name>do_include</name>
|
|
<type>function</type>
|
|
<docblock line="42">
|
|
<description><![CDATA[Bulk directory loading workaround for use
|
|
with array_map and glob]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="42" name="param" description="" type="string" variable="$path">
|
|
<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="49">
|
|
<name>$path</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</function>
|
|
<function namespace="default" line="65" package="Query">
|
|
<name>mb_trim</name>
|
|
<type>function</type>
|
|
<docblock line="59">
|
|
<description><![CDATA[Multibyte-safe trim function]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="59" name="param" description="string" type="" variable="$string"/>
|
|
<tag line="59" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="65">
|
|
<name>$string</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</function>
|
|
<function namespace="default" line="80" package="Query">
|
|
<name>db_filter</name>
|
|
<type>function</type>
|
|
<docblock line="73">
|
|
<description><![CDATA[Filter out db rows into one array]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="73" name="param" description="" type="array" variable="$array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="73" name="param" description="" type="mixed" variable="$index">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="73" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="80">
|
|
<name>$array</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="80">
|
|
<name>$index</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</function>
|
|
<function namespace="default" line="100" package="Query">
|
|
<name>Query</name>
|
|
<type>function</type>
|
|
<docblock line="94">
|
|
<description><![CDATA[Connection function]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="94" name="param" description="" type="mixed" variable="$params">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="94" name="return" description="" type="\Query_Builder">
|
|
<type by_reference="false">\Query_Builder</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="100">
|
|
<name>$params</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</function>
|
|
<class final="false" abstract="false" namespace="default" line="26" package="Query\Query">
|
|
<name>BadDBDriverException</name>
|
|
<full_name>\BadDBDriverException</full_name>
|
|
<extends>\InvalidArgumentException</extends>
|
|
<docblock line="20">
|
|
<description><![CDATA[Generic exception for bad drivers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="20" name="package" description="Query"/>
|
|
<tag line="20" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
</class>
|
|
<class final="false" abstract="false" namespace="default" line="36" package="Query\Query">
|
|
<name>BadConnectionException</name>
|
|
<full_name>\BadConnectionException</full_name>
|
|
<extends>\UnexpectedValueException</extends>
|
|
<docblock line="30">
|
|
<description><![CDATA[Generic exception for bad connection strings]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="30" name="package" description="Query"/>
|
|
<tag line="30" name="subpackage" description="Query"/>
|
|
</docblock>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/pgsql/pgsql_sql.php" hash="bea02a83072eb50b121f16fca0c2fbda" 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 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="21" package="Query\Drivers">
|
|
<name>PgSQL_SQL</name>
|
|
<full_name>\PgSQL_SQL</full_name>
|
|
<extends/>
|
|
<implements>\iDB_SQL</implements>
|
|
<docblock line="15">
|
|
<description><![CDATA[PostgreSQL specifc SQL]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="15" name="package" description="Query"/>
|
|
<tag line="15" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="31" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="23">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="23" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="23" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="23" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="23" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="31">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="31">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="31">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="50" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="45">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="45" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="57">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="57" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="78" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="73">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="73" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="96" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="91">
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="91" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="114" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="109">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="109" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="132" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="127">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="127" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="149" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="144">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="144" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="161" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="156">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="156" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="174">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="174" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="197" package="">
|
|
<name>column_list</name>
|
|
<type>function</type>
|
|
<docblock line="191">
|
|
<description><![CDATA[Return sql to list columns of the specified table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="191" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="191" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="197">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="220" package="">
|
|
<name>type_list</name>
|
|
<type>function</type>
|
|
<docblock line="215">
|
|
<description><![CDATA[SQL to show list of field types]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="215" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/pgsql/pgsql_util.php" hash="232394fcf8ef0d57611093d5efbc134d" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<markers>
|
|
<todo line="114">Implement Backup function</todo>
|
|
</markers>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>PgSQL_Util</name>
|
|
<full_name>\PgSQL_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Posgres-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="35">
|
|
<description><![CDATA[Database-specific method to create a new table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="35" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="35" name="param" description="" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="35" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="35" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="35" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="44">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="44">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="44">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="44">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="100" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="94">
|
|
<description><![CDATA[Database-specific SQL for dropping a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="94" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="94" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="100">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="112" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="107">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="107" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="126" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="120">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="120" name="param" description="" type="array" variable="$exclude">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="120" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="126">
|
|
<name>$exclude</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/pgsql/pgsql_driver.php" hash="ccdbd5f862a41d8abd68dfb34871dbc7" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>PgSQL</name>
|
|
<full_name>\PgSQL</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[PostgreSQL specifc class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Connect to a PosgreSQL database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="string" variable="$username">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="string" variable="$password">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="array" variable="$options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$username</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$password</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$options</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="44">
|
|
<description><![CDATA[Empty a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="44" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="49">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
|
|
<name>get_schemas</name>
|
|
<type>function</type>
|
|
<docblock line="57">
|
|
<description><![CDATA[Get a list of schemas for the current connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="57" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/odbc/odbc_util.php" hash="0da2deb78a60f9b28089224504656b06" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>ODBC_Util</name>
|
|
<full_name>\ODBC_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[ODBC-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="46" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="37">
|
|
<description><![CDATA[Database-specific method to create a new table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="37" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="46">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="60" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="54">
|
|
<description><![CDATA[Remove a table from the database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="54" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="54" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="60">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="72" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="67">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="67" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="85" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="80">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="80" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/odbc/odbc_sql.php" hash="ac4940ca98cd75ee33e89a4ae17e3515" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>ODBC_SQL</name>
|
|
<full_name>\ODBC_SQL</full_name>
|
|
<extends/>
|
|
<implements>\iDB_SQL</implements>
|
|
<docblock line="16">
|
|
<description><![CDATA[ODBC SQL Class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="44" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="39">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="39" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="51">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="51" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="68" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="63">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="63" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="80" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="75">
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="75" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="92" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="87">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="87" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="104" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="99">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="99" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="111">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="111" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="123">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="123" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="140" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="135">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="135" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="152" package="">
|
|
<name>type_list</name>
|
|
<type>function</type>
|
|
<docblock line="147">
|
|
<description><![CDATA[SQL to show list of field types]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="147" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="165" package="">
|
|
<name>column_list</name>
|
|
<type>function</type>
|
|
<docblock line="159">
|
|
<description><![CDATA[SQL to show infromation about columns in a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="159" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="159" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="165">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/odbc/odbc_driver.php" hash="21b5bca5c1acff6950b123062a68f087" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="24" package="Query\Drivers">
|
|
<name>ODBC</name>
|
|
<full_name>\ODBC</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[ODBC Database Driver]]></description>
|
|
<long-description><![CDATA[<p>For general database access for databases not specified by the main drivers</p>]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="29" package="Default">
|
|
<name>$escape_char</name>
|
|
<default><![CDATA['']]></default>
|
|
<docblock line="26">
|
|
<description><![CDATA[Don't define the escape char - or define it in sub-drivers in a refactor]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="31">
|
|
<description><![CDATA[Use ODBC to connect to a database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="31" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$username">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$password">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="array" variable="$options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="39">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$username</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$password</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$options</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="46">
|
|
<description><![CDATA[Empty the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="46" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="46" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="52">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/mysql/mysql_util.php" hash="3ca27484a6d5aedd3cb6e56d9f33290a" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>MySQL_Util</name>
|
|
<full_name>\MySQL_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[MySQL-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="37">
|
|
<description><![CDATA[Convienience public function for creating a new MySQL table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="37" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="47">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="113" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="107">
|
|
<description><![CDATA[Convience public function for droping a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="107" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="107" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="113">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="125" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="120">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="120" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="161" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="155">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="155" name="param" description="" type="array" variable="$exclude">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="155" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="161">
|
|
<name>$exclude</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/mysql/mysql_driver.php" hash="e403f5fd4a9308feb81a0cfbf452b56a" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>MySQL</name>
|
|
<full_name>\MySQL</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[MySQL specific class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="29" package="Default">
|
|
<name>$escape_char</name>
|
|
<default><![CDATA['`']]></default>
|
|
<docblock line="24">
|
|
<description><![CDATA[Set the backtick as the MySQL escape character]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="var" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="39" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="31">
|
|
<description><![CDATA[Connect to MySQL Database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="31" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$username">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$password">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="array" variable="$options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="39">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$username</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$password</name>
|
|
<default><![CDATA[null]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="39">
|
|
<name>$options</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="63" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="58">
|
|
<description><![CDATA[Empty a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="58" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="63">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/mysql/mysql_sql.php" hash="258d785515fbe83118a1cebb1eee8415" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>MySQL_SQL</name>
|
|
<full_name>\MySQL_SQL</full_name>
|
|
<extends/>
|
|
<implements>\iDB_SQL</implements>
|
|
<docblock line="16">
|
|
<description><![CDATA[MySQL specifc SQL]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="44">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="44" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="56">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="56" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="74" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="68">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="68" name="param" description="" type="string" variable="$database">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="68" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="74">
|
|
<name>$database</name>
|
|
<default><![CDATA['']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="85">
|
|
<description><![CDATA[Overridden in MySQL class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="85" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="103" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="98">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="98" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="110">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="110" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="127" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="122">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="122" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="139" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="134">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="134" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="151" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="146">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="146" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="163" package="">
|
|
<name>type_list</name>
|
|
<type>function</type>
|
|
<docblock line="158">
|
|
<description><![CDATA[SQL to show list of field types]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="158" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="176" package="">
|
|
<name>column_list</name>
|
|
<type>function</type>
|
|
<docblock line="170">
|
|
<description><![CDATA[SQL to show infromation about columns in a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="170" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="170" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="176">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/sqlite/sqlite_util.php" hash="eb3c58fa8bf9bb273ac838b13c2aded7" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>SQLite_Util</name>
|
|
<full_name>\SQLite_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[SQLite-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="46" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="37">
|
|
<description><![CDATA[Convenience public function to create a new table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="37" name="param" description="//Name of the table" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="//columns as straight array and/or column => type pairs" type="array" variable="$columns">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="// column => constraint pairs" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="// column => index pairs" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="46">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$columns</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="46">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="96">
|
|
<description><![CDATA[SQL to drop the specified table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="96" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="96" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="102">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="109">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="109" name="param" description="" type="array" variable="$excluded">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="109" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="115">
|
|
<name>$excluded</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="179" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="174">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="174" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/sqlite/sqlite_driver.php" hash="618f0a64de20f7d6d70f7d3fe2a2c7de" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>SQLite</name>
|
|
<full_name>\SQLite</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[SQLite specific class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="29" package="Default">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="24">
|
|
<description><![CDATA[Reference to the last executed sql query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="var" description="" type="\PDOStatement">
|
|
<type by_reference="false">\PDOStatement</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="38" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="31">
|
|
<description><![CDATA[Open SQLite Database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="31" name="param" description="" type="string" variable="$dsn">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$user">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="31" name="param" description="" type="string" variable="$pass">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="38">
|
|
<name>$dsn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="38">
|
|
<name>$user</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="38">
|
|
<name>$pass</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="51" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="46">
|
|
<description><![CDATA[Empty a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="46" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="51">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
|
|
<name>get_tables</name>
|
|
<type>function</type>
|
|
<docblock line="64">
|
|
<description><![CDATA[List tables for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="64" 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="90" package="">
|
|
<name>get_system_tables</name>
|
|
<type>function</type>
|
|
<docblock line="85">
|
|
<description><![CDATA[List system tables for the current database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="85" 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="105" package="">
|
|
<name>load_database</name>
|
|
<type>function</type>
|
|
<docblock line="99">
|
|
<description><![CDATA[Load a database for the current connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="99" name="param" description="" type="string" variable="$db">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="99" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="105">
|
|
<name>$db</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="105">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="118" package="">
|
|
<name>unload_database</name>
|
|
<type>function</type>
|
|
<docblock line="113">
|
|
<description><![CDATA[Unload a database from the current connection]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="113" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="118">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/sqlite/sqlite_sql.php" hash="dbbc1ce8cef16ff39e46f65bc790d103" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>SQLite_SQL</name>
|
|
<full_name>\SQLite_SQL</full_name>
|
|
<extends/>
|
|
<implements>\iDB_SQL</implements>
|
|
<docblock line="16">
|
|
<description><![CDATA[SQLite Specific SQL]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="49" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="44">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="44" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="61" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="56">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="56" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="73" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="68">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="68" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="90" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="85">
|
|
<description><![CDATA[Overridden in SQLite class]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="85" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="102" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="97">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="97" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="116" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="111">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="111" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="123">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="123" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="140" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="135">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="135" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="152" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="147">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="147" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="164" package="">
|
|
<name>type_list</name>
|
|
<type>function</type>
|
|
<docblock line="159">
|
|
<description><![CDATA[SQL to show list of field types]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="159" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="177" package="">
|
|
<name>column_list</name>
|
|
<type>function</type>
|
|
<docblock line="171">
|
|
<description><![CDATA[SQL to show infromation about columns in a table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="171" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="171" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="177">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/firebird/firebird_sql.php" hash="5b89505f92346d7e500f3c90524f93ae" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>Firebird_SQL</name>
|
|
<full_name>\Firebird_SQL</full_name>
|
|
<extends/>
|
|
<implements>\iDB_SQL</implements>
|
|
<docblock line="16">
|
|
<description><![CDATA[Firebird Specific SQL]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="32" package="">
|
|
<name>limit</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Limit clause]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$limit">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="param" description="" type="int" variable="$offset">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="32">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$limit</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="32">
|
|
<name>$offset</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="56" package="">
|
|
<name>random</name>
|
|
<type>function</type>
|
|
<docblock line="51">
|
|
<description><![CDATA[Random ordering keyword]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="51" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="69" package="">
|
|
<name>db_list</name>
|
|
<type>function</type>
|
|
<docblock line="64">
|
|
<description><![CDATA[Returns sql to list other databases]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="64" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="81" package="">
|
|
<name>table_list</name>
|
|
<type>function</type>
|
|
<docblock line="76">
|
|
<description><![CDATA[Returns sql to list tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="76" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="98" package="">
|
|
<name>system_table_list</name>
|
|
<type>function</type>
|
|
<docblock line="93">
|
|
<description><![CDATA[Returns sql to list system tables]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="93" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
|
|
<name>view_list</name>
|
|
<type>function</type>
|
|
<docblock line="110">
|
|
<description><![CDATA[Returns sql to list views]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="110" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
|
|
<name>trigger_list</name>
|
|
<type>function</type>
|
|
<docblock line="125">
|
|
<description><![CDATA[Returns sql to list triggers]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="125" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="145" package="">
|
|
<name>function_list</name>
|
|
<type>function</type>
|
|
<docblock line="140">
|
|
<description><![CDATA[Return sql to list functions]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="140" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="157" package="">
|
|
<name>procedure_list</name>
|
|
<type>function</type>
|
|
<docblock line="152">
|
|
<description><![CDATA[Return sql to list stored procedures]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="152" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="185" package="">
|
|
<name>sequence_list</name>
|
|
<type>function</type>
|
|
<docblock line="180">
|
|
<description><![CDATA[Return sql to list sequences]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="180" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="202" package="">
|
|
<name>column_list</name>
|
|
<type>function</type>
|
|
<docblock line="196">
|
|
<description><![CDATA[Return sql to list columns of the specified table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="196" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="196" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="202">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="248" package="">
|
|
<name>type_list</name>
|
|
<type>function</type>
|
|
<docblock line="243">
|
|
<description><![CDATA[SQL to show list of field types]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="243" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/firebird/firebird_result.php" hash="5cafa2a143446cc562525a98e3fe5b53" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="23" package="Query\Drivers">
|
|
<name>Firebird_Result</name>
|
|
<full_name>\Firebird_Result</full_name>
|
|
<extends>\PDOStatement</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Firebird result class to emulate PDOStatement Class - only implements
|
|
data-fetching methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="private" line="30" package="Default">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="25">
|
|
<description><![CDATA[Reference to fbird resource]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="25" name="var" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="37" package="Default">
|
|
<name>$row</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="32">
|
|
<description><![CDATA[Current row in result array]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="32" name="var" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="private" line="44" package="Default">
|
|
<name>$result</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<docblock line="39">
|
|
<description><![CDATA[Data pulled from query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="39" name="param" description="mixed" type="" variable=""/>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="52" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="46">
|
|
<description><![CDATA[Create the object by passing the resource for
|
|
the query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="46" name="param" description="" type="resource" variable="$link">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="52">
|
|
<name>$link</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="83" package="">
|
|
<name>bindColumn</name>
|
|
<type>function</type>
|
|
<docblock line="73">
|
|
<description><![CDATA[Invalidate method for data consistency]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="73" name="param" description="" type="mixed" variable="$column">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="73" name="param" description="&$param" type="mixed" variable="$param">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="73" name="param" description="" type="int" variable="$type">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="73" name="param" description="" type="mixed" variable="$maxlen">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="73" name="param" description="" type="array" variable="$driverdata">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="73" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="83">
|
|
<name>$column</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="83">
|
|
<name>$param</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="83">
|
|
<name>$type</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="83">
|
|
<name>$maxlen</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="83">
|
|
<name>$driverdata</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="100" package="">
|
|
<name>bindParam</name>
|
|
<type>function</type>
|
|
<docblock line="90">
|
|
<description><![CDATA[Invalidate method for data consistency]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="90" name="param" description="" type="mixed" variable="$parameter">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="90" name="param" description="&$variable" type="mixed" variable="$variable">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="90" name="param" description="" type="int" variable="$data_type">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="90" name="param" description="" type="mixed" variable="$maxlen">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="90" name="param" description="" type="array" variable="$driverdata">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="90" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="100">
|
|
<name>$parameter</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="100">
|
|
<name>$variable</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="100">
|
|
<name>$data_type</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="100">
|
|
<name>$maxlen</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="100">
|
|
<name>$driverdata</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
|
|
<name>bindValue</name>
|
|
<type>function</type>
|
|
<docblock line="107">
|
|
<description><![CDATA[Invalidate method for data consistency]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="107" name="param" description="" type="mixed" variable="$parameter">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="107" name="param" description="&$variable" type="mixed" variable="$variable">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="107" name="param" description="" type="int" variable="$data_type">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="107" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="115">
|
|
<name>$parameter</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="115">
|
|
<name>$variable</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="115">
|
|
<name>$data_type</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="128" package="">
|
|
<name>execute</name>
|
|
<type>function</type>
|
|
<docblock line="122">
|
|
<description><![CDATA[Run a prepared statement query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="122" name="param" description="" type="array" variable="$args">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="122" name="return" description="" type="bool">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="128">
|
|
<name>$args</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="151" package="">
|
|
<name>fetch</name>
|
|
<type>function</type>
|
|
<docblock line="143">
|
|
<description><![CDATA[Emulate PDO fetch public function]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="143" name="param" description="" type="int" variable="$fetch_style">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="143" name="param" description="" type="mixed" variable="$statement">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="143" name="param" description="" type="mixed" variable="$offset">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="143" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="151">
|
|
<name>$fetch_style</name>
|
|
<default><![CDATA[PDO::FETCH_ASSOC]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="151">
|
|
<name>$statement</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="151">
|
|
<name>$offset</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="201" package="">
|
|
<name>fetchAll</name>
|
|
<type>function</type>
|
|
<docblock line="193">
|
|
<description><![CDATA[Emulate PDO fetchAll public function]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="193" name="param" description="" type="int" variable="$fetch_style">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="193" name="param" description="" type="mixed" variable="$statement">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="193" name="param" description="" type="mixed" variable="$ctor_args">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
<tag line="193" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="201">
|
|
<name>$fetch_style</name>
|
|
<default><![CDATA[PDO::FETCH_ASSOC]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="201">
|
|
<name>$statement</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="201">
|
|
<name>$ctor_args</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="223" package="">
|
|
<name>fetchColumn</name>
|
|
<type>function</type>
|
|
<docblock line="217">
|
|
<description><![CDATA[Emulate PDOStatement::fetchColumn]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="217" name="param" description="" type="int" variable="$column_num">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="217" name="return" description="" type="mixed">
|
|
<type by_reference="false">mixed</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="223">
|
|
<name>$column_num</name>
|
|
<default><![CDATA[0]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="238" package="">
|
|
<name>fetchObject</name>
|
|
<type>function</type>
|
|
<docblock line="231">
|
|
<description><![CDATA[Emulate PDOStatement::fetchObject, but only for the default use]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="231" name="param" description="" type="string" variable="$class_name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="231" name="param" description="" type="array" variable="$ctor_args">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="231" name="return" description="" type="\stdClass">
|
|
<type by_reference="false">\stdClass</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="238">
|
|
<name>$class_name</name>
|
|
<default><![CDATA['stdClass']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="238">
|
|
<name>$ctor_args</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="250" package="">
|
|
<name>rowCount</name>
|
|
<type>function</type>
|
|
<docblock line="245">
|
|
<description><![CDATA[Return the number of rows affected by the previous query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="245" name="return" description="" type="int">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="270" package="">
|
|
<name>errorCode</name>
|
|
<type>function</type>
|
|
<docblock line="265">
|
|
<description><![CDATA[Method to emulate PDOStatement->errorCode]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="265" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="282" package="">
|
|
<name>errorInfo</name>
|
|
<type>function</type>
|
|
<docblock line="277">
|
|
<description><![CDATA[Method to emulate PDO->errorInfo / PDOStatement->errorInfo]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="277" name="return" description="" type="array">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/firebird/firebird_driver.php" hash="b3d355826e6725b4fd55b75fb49e47d6" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<class final="false" abstract="false" namespace="default" line="24" package="Query\Drivers">
|
|
<name>Firebird</name>
|
|
<full_name>\Firebird</full_name>
|
|
<extends>\DB_PDO</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Firebird Database class]]></description>
|
|
<long-description><![CDATA[<p>PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.</p>]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<property final="false" static="false" visibility="protected" line="31" package="Default">
|
|
<name>$statement</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="26">
|
|
<description><![CDATA[Reference to the last query executed]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="26" name="var" description="" type="object">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="39" package="Default">
|
|
<name>$statement_link</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="33">
|
|
<description><![CDATA[Reference to the resource returned by
|
|
the last query executed]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="33" name="var" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="46" package="Default">
|
|
<name>$trans</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="41">
|
|
<description><![CDATA[Reference to the current transaction]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="41" name="var" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<property final="false" static="false" visibility="protected" line="53" package="Default">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<docblock line="48">
|
|
<description><![CDATA[Reference to the connection resource]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="48" name="var" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
</property>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="62" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="55">
|
|
<description><![CDATA[Open the link to the database]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="55" name="param" description="" type="string" variable="$dbpath">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="55" name="param" description="" type="string" variable="$user">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="55" name="param" description="" type="string" variable="$pass">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="62">
|
|
<name>$dbpath</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="62">
|
|
<name>$user</name>
|
|
<default><![CDATA['sysdba']]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="62">
|
|
<name>$pass</name>
|
|
<default><![CDATA['masterkey']]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="94" package="">
|
|
<name>truncate</name>
|
|
<type>function</type>
|
|
<docblock line="89">
|
|
<description><![CDATA[Empty a database table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="89" name="param" description="" type="string" variable="$table">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="94">
|
|
<name>$table</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="109" package="">
|
|
<name>query</name>
|
|
<type>function</type>
|
|
<docblock line="103">
|
|
<description><![CDATA[Wrapper public function to better match PDO]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="103" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="103" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="109">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="135" package="">
|
|
<name>prepare</name>
|
|
<type>function</type>
|
|
<docblock line="128">
|
|
<description><![CDATA[Emulate PDO prepare]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="128" name="param" description="" type="string" variable="$query">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="128" name="param" description="" type="array" variable="$options">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="128" name="return" description="" type="\$this">
|
|
<type by_reference="false">\$this</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="135">
|
|
<name>$query</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="135">
|
|
<name>$options</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="157" package="">
|
|
<name>beginTransaction</name>
|
|
<type>function</type>
|
|
<docblock line="152">
|
|
<description><![CDATA[Start a database transaction]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="152" 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="174" package="">
|
|
<name>commit</name>
|
|
<type>function</type>
|
|
<docblock line="169">
|
|
<description><![CDATA[Commit a database transaction]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="169" 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="186" package="">
|
|
<name>rollBack</name>
|
|
<type>function</type>
|
|
<docblock line="181">
|
|
<description><![CDATA[Rollback a transaction]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="181" 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="200" package="">
|
|
<name>prepare_execute</name>
|
|
<type>function</type>
|
|
<docblock line="193">
|
|
<description><![CDATA[Prepare and execute a query]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="193" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="193" name="param" description="" type="array" variable="$args">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="193" name="return" description="" type="resource">
|
|
<type by_reference="false">resource</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="200">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="200">
|
|
<name>$args</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="219" package="">
|
|
<name>quote</name>
|
|
<type>function</type>
|
|
<docblock line="212">
|
|
<description><![CDATA[Method to emulate PDO->quote]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="212" name="param" description="" type="string" variable="$str">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="212" name="param" description="" type="int" variable="$param_type">
|
|
<type by_reference="false">int</type>
|
|
</tag>
|
|
<tag line="212" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="219">
|
|
<name>$str</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="219">
|
|
<name>$param_type</name>
|
|
<default><![CDATA[NULL]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="236" package="">
|
|
<name>errorInfo</name>
|
|
<type>function</type>
|
|
<docblock line="231">
|
|
<description><![CDATA[Method to emulate PDO->errorInfo / PDOStatement->errorInfo]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="231" 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="251" package="">
|
|
<name>errorCode</name>
|
|
<type>function</type>
|
|
<docblock line="246">
|
|
<description><![CDATA[Method to emulate PDO->errorCode]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="246" 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="265" package="">
|
|
<name>prepare_query</name>
|
|
<type>function</type>
|
|
<docblock line="258">
|
|
<description><![CDATA[Bind a prepared query with arguments for executing]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="258" name="param" description="" type="string" variable="$sql">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="258" name="param" description="" type="array" variable="$params">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="258" name="return" description="" type="NULL">
|
|
<type by_reference="false">NULL</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="265">
|
|
<name>$sql</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="265">
|
|
<name>$params</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<file path="drivers/firebird/firebird_util.php" hash="4bb834086d2cff626c27e2c405616e00" package="Query">
|
|
<docblock line="2">
|
|
<description><![CDATA[Query]]></description>
|
|
<long-description><![CDATA[<p>Free Query Builder / Database Abstraction Layer</p>]]></long-description>
|
|
<tag line="2" name="package" description="Query"/>
|
|
<tag line="2" name="author" description="Timothy J. Warren"/>
|
|
<tag line="2" name="copyright" description="Copyright (c) 2012 - 2013"/>
|
|
<tag line="2" name="link" description="https://github.com/aviat4ion/Query" link="https://github.com/aviat4ion/Query"/>
|
|
<tag line="2" name="license" description="http://philsturgeon.co.uk/code/dbad-license"/>
|
|
</docblock>
|
|
<markers>
|
|
<todo line="117">Implement Backup structure function</todo>
|
|
</markers>
|
|
<class final="false" abstract="false" namespace="default" line="22" package="Query\Drivers">
|
|
<name>Firebird_Util</name>
|
|
<full_name>\Firebird_Util</full_name>
|
|
<extends>\DB_Util</extends>
|
|
<docblock line="16">
|
|
<description><![CDATA[Firebird-specific backup, import and creation methods]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="16" name="package" description="Query"/>
|
|
<tag line="16" name="subpackage" description="Drivers"/>
|
|
</docblock>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="30" package="">
|
|
<name>__construct</name>
|
|
<type>function</type>
|
|
<docblock line="24">
|
|
<description><![CDATA[Save a reference to the current connection object]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="24" name="param" description="&$conn" type="object" variable="$conn">
|
|
<type by_reference="false">object</type>
|
|
</tag>
|
|
<tag line="24" name="return" description="" type="void">
|
|
<type by_reference="false">void</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="30">
|
|
<name>$conn</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="47" package="">
|
|
<name>create_table</name>
|
|
<type>function</type>
|
|
<docblock line="37">
|
|
<description><![CDATA[Convienience public function to generate sql for creating a db table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="37" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$fields">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$constraints">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="param" description="" type="array" variable="$indexes">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="37" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="47">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$fields</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$constraints</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
<argument line="47">
|
|
<name>$indexes</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type>array</type>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="103" package="">
|
|
<name>delete_table</name>
|
|
<type>function</type>
|
|
<docblock line="97">
|
|
<description><![CDATA[Drop the selected table]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="97" name="param" description="" type="string" variable="$name">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
<tag line="97" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="103">
|
|
<name>$name</name>
|
|
<default><![CDATA[]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="115" package="">
|
|
<name>backup_structure</name>
|
|
<type>function</type>
|
|
<docblock line="110">
|
|
<description><![CDATA[Create an SQL backup file for the current database's structure]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="110" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
</method>
|
|
<method final="false" abstract="false" static="false" visibility="public" namespace="default" line="130" package="">
|
|
<name>backup_data</name>
|
|
<type>function</type>
|
|
<docblock line="123">
|
|
<description><![CDATA[Create an SQL backup file for the current database's data]]></description>
|
|
<long-description><![CDATA[]]></long-description>
|
|
<tag line="123" name="param" description="" type="array" variable="$exclude">
|
|
<type by_reference="false">array</type>
|
|
</tag>
|
|
<tag line="123" name="param" description="" type="bool" variable="$system_tables">
|
|
<type by_reference="false">bool</type>
|
|
</tag>
|
|
<tag line="123" name="return" description="" type="string">
|
|
<type by_reference="false">string</type>
|
|
</tag>
|
|
</docblock>
|
|
<argument line="130">
|
|
<name>$exclude</name>
|
|
<default><![CDATA[array()]]></default>
|
|
<type/>
|
|
</argument>
|
|
<argument line="130">
|
|
<name>$system_tables</name>
|
|
<default><![CDATA[FALSE]]></default>
|
|
<type/>
|
|
</argument>
|
|
</method>
|
|
</class>
|
|
</file>
|
|
<package name="" full_name=""/>
|
|
<package name="Default" full_name="Default"/>
|
|
<package name="Query" full_name="Query">
|
|
<package name="Drivers" full_name="Query\Drivers"/>
|
|
<package name="Query" full_name="Query\Query"/>
|
|
</package>
|
|
<namespace name="default" full_name="default"/>
|
|
<marker count="2">todo</marker>
|
|
<marker count="0">fixme</marker>
|
|
<deprecated count="0"/>
|
|
</project>
|