-
Notifications
You must be signed in to change notification settings - Fork 165
Expand file tree
/
Copy pathgetnotify.xml
More file actions
134 lines (127 loc) · 4 KB
/
getnotify.xml
File metadata and controls
134 lines (127 loc) · 4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c142be811735a5542c8a2e4c4ed2f81e8cc3acc6 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="pdo-pgsql.getnotify" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Pdo\Pgsql::getNotify</refname>
<refpurpose>Renvoie une notification asynchrone</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Pdo\\Pgsql">
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>Pdo\Pgsql::getNotify</methodname>
<methodparam choice="opt"><type>int</type><parameter>fetchMode</parameter><initializer><constant>PDO::FETCH_DEFAULT</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeoutMilliseconds</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<simpara>
Renvoie un jeu de résultats représentant une notification asynchrone en attente.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>fetchMode</parameter></term>
<listitem>
<para>
Le format sous lequel le jeu de résultats doit être,
une des constantes suivantes:
<simplelist>
<member><constant>PDO::FETCH_DEFAULT</constant></member>
<member><constant>PDO::FETCH_BOTH</constant></member>
<member><constant>PDO::FETCH_ASSOC</constant></member>
<member><constant>PDO::FETCH_NUM</constant></member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeoutMilliseconds</parameter></term>
<listitem>
<simpara>
Le temps d'attente pour une réponse, en millisecondes.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Si une ou plusieurs notifications sont en attente, retourne une seule ligne,
avec les champs <literal>message</literal> et <literal>pid</literal>,
sinon retourne &false;.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
Une <exceptionname>ValueError</exceptionname> est lancée si
<parameter>fetchMode</parameter> n'est pas une des constantes
<constant>PDO::FETCH_<replaceable>*</replaceable></constant>
valides.
</simpara>
<simpara>
Une <exceptionname>ValueError</exceptionname> est lancée si
<parameter>timeoutMilliseconds</parameter> est inférieur à <literal>0</literal>.
</simpara>
<simpara>
Une <exceptionname>Warning</exceptionname> est lancée si
<parameter>timeoutMilliseconds</parameter> est supérieur à la valeur
qui peut être contenue dans un entier signé 32 bits, auquel cas ce sera
la valeur maximale d'un entier signé 32 bits.
</simpara>
</refsect1>
<!-- TODO?
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="pdo-pgsql.getnotify.example.basic">
<title><methodname>Pdo\Pgsql::getNotify</methodname> example</title>
<simpara>
Description.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
echo "Code example";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Code example
]]>
</screen>
</example>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>PDO::query</methodname></member>
<member><methodname>PDOStatement::fetch</methodname></member>
<member><methodname>PDOStatement::fetchAll</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->