mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2025-01-03 01:19:38 +01:00
Re-extracted class docs.
This commit is contained in:
parent
d208d887fc
commit
d53e7dd1fc
@ -7,8 +7,13 @@
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="create_prepared_statement">
|
||||
<return type="PreparedStatement" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="database_connect">
|
||||
<return type="void" />
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="connection_str" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
|
||||
248
modules/database/doc_classes/PreparedStatement.xml
Normal file
248
modules/database/doc_classes/PreparedStatement.xml
Normal file
@ -0,0 +1,248 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="PreparedStatement" inherits="Reference" version="4.4">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="bind_blob">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="PoolByteArray" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_double">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="float" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_float">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="float" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_int">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_int64">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_null">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_parameter_count">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_parameter_index">
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_parameter_name">
|
||||
<return type="String" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_text">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_value">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="bind_zeroblob">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="num" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_bindings">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_blob">
|
||||
<return type="PoolByteArray" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_count">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_database_name">
|
||||
<return type="String" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_decltype">
|
||||
<return type="String" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_double">
|
||||
<return type="float" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_float">
|
||||
<return type="float" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_int">
|
||||
<return type="int" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_int64">
|
||||
<return type="int" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_name">
|
||||
<return type="String" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_origin_name">
|
||||
<return type="String" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_table_name">
|
||||
<return type="String" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_text">
|
||||
<return type="String" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_type">
|
||||
<return type="int" enum="PreparedStatement.Type" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="column_value">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="data_count">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="finalize">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connection" qualifiers="const">
|
||||
<return type="DatabaseConnection" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_expanded_sql">
|
||||
<return type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_normalized_sql">
|
||||
<return type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="prepare">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="reset">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="step">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="sql" type="String" setter="set_sql" getter="get_sql">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
<constant name="TYPE_NULL" value="0" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_BLOB" value="1" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_FLOAT" value="2" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_DOUBLE" value="3" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_INT" value="4" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_INT64" value="5" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_TEXT" value="6" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_VARCHAR" value="7" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_VALUE" value="8" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_BYTES" value="9" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_TYPE" value="10" enum="Type">
|
||||
</constant>
|
||||
<constant name="TYPE_UNKNOWN" value="11" enum="Type">
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
@ -53,6 +53,11 @@
|
||||
Closes the current [code]ORDER BY[/code] statement. (Usually by removing the last [code],[/code]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_prepared_statement">
|
||||
<return type="PreparedStatement" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="cset">
|
||||
<return type="QueryBuilder" />
|
||||
<description>
|
||||
@ -382,10 +387,21 @@
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="prepare">
|
||||
<method name="psph">
|
||||
<return type="QueryBuilder" />
|
||||
<description>
|
||||
Part of the unfinished prepared statement api.
|
||||
</description>
|
||||
</method>
|
||||
<method name="psphi">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="psphr">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="raw_id" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="reset">
|
||||
@ -425,30 +441,6 @@
|
||||
Adds a statement to select and return the last inserted row's id.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_paramf">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="float" />
|
||||
<description>
|
||||
Part of the unfinished prepared statement api.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_parami">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="int" />
|
||||
<description>
|
||||
Part of the unfinished prepared statement api.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_params">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="value" type="String" />
|
||||
<description>
|
||||
Part of the unfinished prepared statement api.
|
||||
</description>
|
||||
</method>
|
||||
<method name="setpb">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
@ -488,6 +480,26 @@
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="setph">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="setphi">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
<argument index="1" name="id" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="setphr">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
<argument index="1" name="raw_id" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="setpi">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
@ -596,6 +608,23 @@
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="valph">
|
||||
<return type="QueryBuilder" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="valphi">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="valphr">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="raw_id" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="vals">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="param" type="String" />
|
||||
@ -667,6 +696,26 @@
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="wph">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="wphi">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
<argument index="1" name="id" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="wphr">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
<argument index="1" name="raw_id" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="wpi">
|
||||
<return type="QueryBuilder" />
|
||||
<argument index="0" name="col" type="String" />
|
||||
|
||||
@ -201,6 +201,11 @@
|
||||
result += "REFERENCES " + table + " (" + name + ") ";
|
||||
</description>
|
||||
</method>
|
||||
<method name="reset">
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="run">
|
||||
<return type="QueryResult" />
|
||||
<description>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user