Document pg_last_notice(, option)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344147 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2018-02-01 11:55:49 +00:00
parent 2313b40f70
commit 5ad34a5a05
2 changed files with 53 additions and 2 deletions

View file

@ -508,6 +508,43 @@
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-notice-last">
<term>
<constant>PGSQL_NOTICE_LAST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Used by <function>pg_last_notice</function>.
Available since PHP 7.1.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-notice-all">
<term>
<constant>PGSQL_NOTICE_ALL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Used by <function>pg_last_notice</function>.
Available since PHP 7.1.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-notice-clear">
<term>
<constant>PGSQL_NOTICE_CLEAR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Used by <function>pg_last_notice</function>.
Available since PHP 7.1.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.pgsql-status-long">
<term>
<constant>PGSQL_STATUS_LONG</constant>

View file

@ -12,7 +12,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_last_notice</methodname>
<type>mixed</type><methodname>pg_last_notice</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>option</parameter><initializer>PGSQL_NOTICE_LAST</initializer></methodparam>
</methodsynopsis>
@ -51,6 +51,16 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
One of <constant>PGSQL_NOTICE_LAST</constant> (to return last notice),
<constant>PGSQL_NOTICE_ALL</constant> (to return all notices),
or <constant>PGSQL_NOTICE_CLEAR</constant> (to clear notices).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@ -59,7 +69,11 @@
&reftitle.returnvalues;
<para>
A <type>string</type> containing the last notice on the
given <parameter>connection</parameter>, or &false; on error.
given <parameter>connection</parameter> with
<constant>PGSQL_NOTICE_LAST</constant>,
an <type>array</type> with <constant>PGSQL_NOTICE_ALL</constant>,
a <type>boolean</type> with <constant>PGSQL_NOTICE_CLEAR</constant>,
or &false; on error.
</para>
</refsect1>