sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use our current docbook style for oop methods.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@299165 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Daniel Convissor 2010-05-09 02:32:24 +00:00
parent c87cff5fed
commit 1471b2ec6e
46 changed files with 210 additions and 380 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
reference/maxdb/functions/maxdb-autocommit.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>auto_commit</methodname>
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::auto_commit</methodname>
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_autocommit</function> is used to turn on or off auto-commit mode
on queries for the database connection represented by the <parameter>link</parameter>

16
reference/maxdb/functions/maxdb-change-user.xml
View file

@ -18,16 +18,12 @@
<methodparam><type>string</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>change_user</methodname>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>database</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::change_user</methodname>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_change_user</function> is used to change the user of the specified
database connection as given by the <parameter>link</parameter> parameter and to set the

12
reference/maxdb/functions/maxdb-character-set-name.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>character_set_name</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>string</type><methodname>maxdb::character_set_name</methodname>
<void />
</methodsynopsis>
<para>
Returns the current character set for the database connection specified by the
<parameter>link</parameter> parameter.

12
reference/maxdb/functions/maxdb-close.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>close</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::close</methodname>
<void />
</methodsynopsis>
<para>
The <function>maxdb_close</function> function closes a previously opened database
connection specified by the <parameter>link</parameter> parameter.

12
reference/maxdb/functions/maxdb-commit.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>commit</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::commit</methodname>
<void />
</methodsynopsis>
<para>
Commits the current transaction for the database connection specified by the
<parameter>link</parameter> parameter.

21
reference/maxdb/functions/maxdb-connect.xml
View file

@ -20,18 +20,15 @@
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<constructorsynopsis>
<methodname>maxdb::__construct</methodname>
<methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</constructorsynopsis>
<para>
The <function>maxdb_connect</function> function attempts to open a connection to the MaxDB Server
running on <parameter>host</parameter> which can be either a host name or an IP address. Passing the

12
reference/maxdb/functions/maxdb-data-seek.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>data_seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_result::data_seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
The <function>maxdb_data_seek</function> function seeks to an arbitrary result pointer
specified by the <parameter>offset</parameter> in the result set represented by

9
reference/maxdb/functions/maxdb-disable-reads-from-master.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>disable_reads_from_master</methodname>
<methodsynopsis>
<type>void</type><methodname>maxdb::disable_reads_from_master</methodname>
<void />
</methodsynopsis>
</classsynopsis>
</methodsynopsis>
&warn.undocumented.func;

12
reference/maxdb/functions/maxdb-fetch-array.xml
View file

@ -16,14 +16,10 @@
<methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>mixed</type>
<methodname>fetch_array</methodname>
<methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_result::fetch_array</methodname>
<methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array that corresponds to the fetched row or &null; if there are no more rows for the
resultset represented by the <parameter>result</parameter> parameter.

14
reference/maxdb/functions/maxdb-fetch-assoc.xml
View file

@ -3,7 +3,7 @@
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.maxdb-fetch-assoc">
<refnamediv>
<refname>maxdb_fetch_assoc</refname>
<refname>maxdb::fetch_assoc</refname>
<refname>maxdb_result::fetch_assoc</refname>
<refpurpose>Fetch a result row as an associative array</refpurpose>
</refnamediv>
@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>array</type>
<methodname>fetch_assoc</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>array</type><methodname>maxdb_result::fetch_assoc</methodname>
<void />
</methodsynopsis>
<para>
Returns an associative array that corresponds to the fetched row or &null; if there are
no more rows.

12
reference/maxdb/functions/maxdb-fetch-field-direct.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>mixed</type>
<methodname>fetch_field_direct</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_result::fetch_field_direct</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_fetch_field_direct</function> returns an resource which contains
field definition information from specified resultset. The value of fieldnr must be in the

11
reference/maxdb/functions/maxdb-fetch-field.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>fetch_field</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_result::fetch_field</methodname>
<void/>
</methodsynopsis>
<para>
The <function>maxdb_fetch_field</function> returns the definition of one column
of a result set as an resource. Call this function repeatedly to retrieve

12
reference/maxdb/functions/maxdb-fetch-fields.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>mixed</type>
<methodname>fetch_fields</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_result::fetch_fields</methodname>
<void/>
</methodsynopsis>
<para>
This function serves an identical purpose to the <function>maxdb_fetch_field</function>
function with the single difference that, instead of returning one resource at a time for

11
reference/maxdb/functions/maxdb-fetch-object.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>object</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>object</type><methodname>fetch_object</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>object</type><methodname>maxdb_result::fetch_object</methodname>
<void />
</methodsynopsis>
<para>
The <function>maxdb_fetch_object</function> will return the current row result set
as an object where the attributes of the object represent the names of the fields found

12
reference/maxdb/functions/maxdb-fetch-row.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>mixed</type>
<methodname>fetch_row</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_result::fetch_row</methodname>
<void />
</methodsynopsis>
<para>
Returns an array that corresponds to the fetched row, or &null; if there are no more rows.
</para>

12
reference/maxdb/functions/maxdb-field-count.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>int</type>
<methodname>field_count</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>int</type><methodname>maxdb::field_count</methodname>
<void />
</methodsynopsis>
<para>
Returns the number of columns for the most recent query on the connection
represented by the <parameter>link</parameter> parameter. This function

11
reference/maxdb/functions/maxdb-field-seek.xml
View file

@ -16,13 +16,10 @@
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>field_seek</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_result::field_seek</methodname>
<methodparam><type>int</type><parameter>fieldnr</parameter></methodparam>
</methodsynopsis>
<para>
Sets the field cursor to the given offset. The next call to <function>maxdb_fetch_field</function>
will retrieve the field definition of the column associated with that offset.

12
reference/maxdb/functions/maxdb-free-result.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>result</classname></ooclass>
<methodsynopsis>
<type>void</type>
<methodname>free</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>void</type><methodname>maxdb_result::free</methodname>
<void />
</methodsynopsis>
<para>
The <function>maxdb_free_result</function> function frees the memory
associated with the result represented by the

12
reference/maxdb/functions/maxdb-kill.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>int</type><parameter>processid</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>kill</methodname>
<methodparam><type>int</type><parameter>processid</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::kill</methodname>
<methodparam><type>int</type><parameter>processid</parameter></methodparam>
</methodsynopsis>
<para>
This function is used to disconnect from a MaxDB server specified
by the <parameter>processid</parameter> parameter.

12
reference/maxdb/functions/maxdb-multi-query.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>multi_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::multi_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
The <function>maxdb_multi_query</function> works like the function
<function>maxdb_query</function>. Multiple queries are not yet supported.

14
reference/maxdb/functions/maxdb-options.xml
View file

@ -17,15 +17,11 @@
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>options</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::options</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_options</function> can be used to set extra connect options
and affect behavior for a connection.

11
reference/maxdb/functions/maxdb-ping.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>ping</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::ping</methodname>
<void/>
</methodsynopsis>
<para>
Checks whether the connection to the server is working. If it has gone
down, and global option <literal>maxdb.reconnect</literal> is enabled

11
reference/maxdb/functions/maxdb-prepare.xml
View file

@ -16,13 +16,10 @@
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>resource</type><methodname>prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>maxdb_stmt</type><methodname>maxdb::prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_prepare</function> prepares the SQL query pointed to by the
null-terminated string query, and returns a statement handle to be used for

12
reference/maxdb/functions/maxdb-query.xml
View file

@ -17,14 +17,10 @@
<methodparam choice='opt'><type>int</type><parameter>resultmode</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>mixed</type>
<methodname>query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>maxdb::query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
The <function>maxdb_query</function> function is used to simplify the
act of performing a query against the database represented by the

22
reference/maxdb/functions/maxdb-real-connect.xml
View file

@ -21,19 +21,15 @@
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>real_connect</methodname>
<methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::real_connect</methodname>
<methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_real_connect</function> attempts to establish a
connection to a MaxDB database engine running on

12
reference/maxdb/functions/maxdb-real-escape-string.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>real_escape_sring</methodname>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>string</type><methodname>maxdb::real_escape_sring</methodname>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
<para>
This function is used to create a legal SQL string that you can use in a SQL statement.
The string <literal>escapestr</literal> is encoded to an escaped SQL string, taking into

12
reference/maxdb/functions/maxdb-real-query.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>real_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::real_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
The <function>maxdb_real_query</function> is functionally identical
with the <function>maxdb_query</function>.

11
reference/maxdb/functions/maxdb-rpl-query-type.xml
View file

@ -14,13 +14,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>int</type><methodname>rpl_query_type</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>int</type><methodname>maxdb::rpl_query_type</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;

11
reference/maxdb/functions/maxdb-send-query.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>send_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::send_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;

19
reference/maxdb/functions/maxdb-ssl-set.xml
View file

@ -20,17 +20,14 @@
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>ssl_set</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb::ssl_set</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;

11
reference/maxdb/functions/maxdb-stat.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>maxdb->stat</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>string</type><methodname>maxdb::stat</methodname>
<void />
</methodsynopsis>
<para>
<function>maxdb_stat</function> returns a string containing several
information about the MaxDB server running.

30
reference/maxdb/functions/maxdb-stmt-bind-param.xml
View file

@ -18,16 +18,12 @@
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>bind_param</methodname>
<methodparam><type>string</type><parameter>types</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::bind_param</methodname>
<methodparam><type>string</type><parameter>types</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>Procedural style (extended syntax):</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_bind_param</methodname>
@ -36,15 +32,11 @@
<methodparam><type>array</type><parameter role="reference">var</parameter></methodparam>
</methodsynopsis>
<para>&style.oop; (extended syntax):</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>bind_param</methodname>
<methodparam><type>string</type><parameter>types</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">var</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::bind_param</methodname>
<methodparam><type>string</type><parameter>types</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">var</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_stmt_bind_param</function> is used to bind variables for the
parameter markers in the SQL statement that was passed to

14
reference/maxdb/functions/maxdb-stmt-bind-result.xml
View file

@ -17,15 +17,11 @@
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>bind_result</methodname>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::bind_result</methodname>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_stmt_bind_result</function> is used to associate (bind) columns in the result
set to variables. When <function>maxdb_stmt_fetch</function> is called to fetch data, the MaxDB

11
reference/maxdb/functions/maxdb-stmt-close-long-data.xml
View file

@ -16,13 +16,10 @@
<methodparam><type>int</type><parameter>param_nr</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt->close_long_data</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::close_long_data</methodname>
<void />
</methodsynopsis>
<para>
This function has to be called after a sequence of
<function>maxdb_stmt_send_long_data</function>, that was started

11
reference/maxdb/functions/maxdb-stmt-close.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt->close</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::close</methodname>
<void />
</methodsynopsis>
<para>
Closes a prepared statement. <function>maxdb_stmt_close</function> also deallocates the
statement handle pointed to by <parameter>stmt</parameter>.

12
reference/maxdb/functions/maxdb-stmt-data-seek.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>data_seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::data_seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
The <function>maxdb_stmt_data_seek</function> function seeks to an arbitrary result pointer
specified by the <parameter>offset</parameter> in the statement result set represented by

12
reference/maxdb/functions/maxdb-stmt-execute.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>execute</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::execute</methodname>
<void />
</methodsynopsis>
<para>
The <function>maxdb_stmt_execute</function> function executes a query that has been previously
prepared using the <function>maxdb_prepare</function> function represented by the

11
reference/maxdb/functions/maxdb-stmt-fetch.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>fetch</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::fetch</methodname>
<void />
</methodsynopsis>
<para>
<function>maxdb_stmt_fetch</function> returns row data using the variables
bound by <function>maxdb_stmt_bind_result</function>.

12
reference/maxdb/functions/maxdb-stmt-free-result.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>void</type>
<methodname>free_result</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>void</type><methodname>maxdb_stmt::free_result</methodname>
<void />
</methodsynopsis>
<para>
The <function>maxdb_stmt_free_result</function> function frees the result memory
associated with the statement represented by the

12
reference/maxdb/functions/maxdb-stmt-prepare.xml
View file

@ -16,14 +16,10 @@
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>mixed</type>
<methodname>prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_stmt::prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
<function>maxdb_stmt_prepare</function> prepares the SQL query pointed to by the
null-terminated string query. The statement resource has to be allocated by

11
reference/maxdb/functions/maxdb-stmt-reset.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>reset</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::reset</methodname>
<void />
</methodsynopsis>
&warn.undocumented.func;

11
reference/maxdb/functions/maxdb-stmt-result-metadata.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>resource</type><methodname>result_metadata</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>resource</type><methodname>maxdb_stmt::result_metadata</methodname>
<void />
</methodsynopsis>
<para>
If a statement passed to <function>maxdb_prepare</function> is one that produces
a result set, <function>maxdb_stmt_result_metadata</function> returns the result resource

13
reference/maxdb/functions/maxdb-stmt-send-long-data.xml
View file

@ -17,14 +17,11 @@
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>stmt_send_long_data</methodname>
<methodparam><type>int</type><parameter>param_nr</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt::stmt_send_long_data</methodname>
<methodparam><type>int</type><parameter>param_nr</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
Allows to send parameter data to the server in pieces (or chunks).
This function can be called multiple times to send the parts of a character or

12
reference/maxdb/functions/maxdb-stmt-store-result.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>object</type>
<methodname>store_result</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>object</type><methodname>maxdb::store_result</methodname>
<void />
</methodsynopsis>
<para>
<function>maxdb_stmt_store_result</function> has no functionally effect
and should not be used for retrieving data from MaxDB server.

12
reference/maxdb/functions/maxdb-store-result.xml
View file

@ -15,14 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>object</type>
<methodname>store_result</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>object</type><methodname>maxdb::store_result</methodname>
<void />
</methodsynopsis>
<para>
This function has no functionally effect.
</para>

11
reference/maxdb/functions/maxdb-use-result.xml
View file

@ -15,13 +15,10 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<classsynopsis>
<ooclass><classname>maxdb</classname></ooclass>
<methodsynopsis>
<type>resource</type><methodname>use_result</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<type>resource</type><methodname>maxdb::use_result</methodname>
<void />
</methodsynopsis>
<para>
<function>maxdb_use_result</function> has no effect.
</para>