reference/pgsql/functions/pg-get-result.xml
c2eca73ef79ebe78cebb34053e41b565af504c4f
...
...
@@ -1,7 +1,7 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
3
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.58 -->
4
-
<refentry xml:id='function.pg-get-result' xmlns="http://docbook.org/ns/docbook">
4
+
<refentry xml:id="function.pg-get-result" xmlns="http://docbook.org/ns/docbook">
5
5
<refnamediv>
6
6
<refname>pg_get_result</refname>
7
7
<refpurpose>
...
...
@@ -12,11 +12,11 @@
12
12
<refsect1 role="description">
13
13
&reftitle.description;
14
14
<methodsynopsis>
15
-
<type>resource</type><methodname>pg_get_result</methodname>
16
-
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
15
+
<type class="union"><type>PgSql\Result</type><type>false</type></type><methodname>pg_get_result</methodname>
16
+
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
-
<function>pg_get_result</function> gets the result resource from
19
+
<function>pg_get_result</function> gets an <classname>PgSql\Result</classname> instance from
20
20
an asynchronous query executed by
21
21
<function>pg_send_query</function>, <function>pg_send_query_params</function> or
22
22
<function>pg_send_execute</function>.
...
...
@@ -36,9 +36,7 @@
36
36
<varlistentry>
37
37
<term><parameter>connection</parameter></term>
38
38
<listitem>
39
-
<para>
40
-
PostgreSQL database connection resource.
41
-
</para>
39
+
&pgsql.parameter.connection;
42
40
</listitem>
43
41
</varlistentry>
44
42
</variablelist>
...
...
@@ -48,10 +46,28 @@
48
46
<refsect1 role="returnvalues">
49
47
&reftitle.returnvalues;
50
48
<para>
51
-
The result <type>resource</type>, or &false; if no more results are available.
49
+
An <classname>PgSql\Result</classname> instance, or &false; if no more results are available.
52
50
</para>
53
51
</refsect1>
54
52

53
+
<refsect1 role="changelog">
54
+
&reftitle.changelog;
55
+
<informaltable>
56
+
<tgroup cols="2">
57
+
<thead>
58
+
<row>
59
+
<entry>&Version;</entry>
60
+
<entry>&Description;</entry>
61
+
</row>
62
+
</thead>
63
+
<tbody>
64
+
&pgsql.changelog.return-result-object;
65
+
&pgsql.changelog.connection-object;
66
+
</tbody>
67
+
</tgroup>
68
+
</informaltable>
69
+
</refsect1>
70
+

55
71
<refsect1 role="examples">
56
72
&reftitle.examples;
57
73
<para>
...
...
@@ -101,7 +117,6 @@ Resource id #4 has 1 records
101
117
</para>
102
118
</refsect1>
103
119
</refentry>
104
-

105
120
<!-- Keep this comment at the end of the file
106
121
Local variables:
107
122
mode: sgml
108
123