mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 07:02:08 +01:00
2d197d5a6c
* php/doc-en#4288 を反映（PDOのディレクトリ構成変更） * php/doc-en#4298 を反映（不要セクションの削除） * Update EN-Revision * php/doc-en#4330 を反映（PDOの階層構造の変更）
114 lines
3.6 KiB
XML
114 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 9ec2c28f9400490fe1b70fb88e50e23de97905f1 Maintainer: KentarouTakeda Status: ready -->
|
|
<!-- CREDITS: KentarouTakeda -->
|
|
<refentry xml:id="pdo-pgsql.setnoticecallback" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>Pdo\Pgsql::setNoticeCallback</refname>
|
|
<refpurpose>バックエンドが生成する通知および警告メッセージを処理するコールバックを設定する</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="Pdo\\Pgsql">
|
|
<modifier>public</modifier> <type>void</type><methodname>Pdo\Pgsql::setNoticeCallback</methodname>
|
|
<methodparam><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
バックエンドが生成する通知および警告メッセージを処理するためのコールバックを設定します。
|
|
これには、PostgreSQL 本体が出力するメッセージや、
|
|
ユーザー定義 SQL 関数で <literal>RAISE</literal> されたメッセージも含まれます。
|
|
これらのメッセージを実際に受信できるかは、バックエンド側の設定
|
|
<literal>client_min_messages</literal> に依存する点に注意してください。
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>callback</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
&null; を渡すと、ハンドラはデフォルトの状態にリセットされます。
|
|
</simpara>
|
|
<para>
|
|
それ以外の場合、ハンドラは次のシグネチャを持つコールバック関数です:
|
|
<methodsynopsis>
|
|
<type>void</type><methodname><replaceable>handler</replaceable></methodname>
|
|
<methodparam><type>string</type><parameter>message</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<variablelist role="function_parameters">
|
|
<varlistentry>
|
|
<term><parameter>message</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
バックエンドが生成したメッセージ
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
&return.void;
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example xml:id="pdo-pgsql.setnoticecallback.example.basic">
|
|
<title><methodname>Pdo\Pgsql::setNoticeCallback</methodname> の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$pdo = new Pdo\Pgsql('pgsql:dbname=test host=localhost', $user, $pass);
|
|
|
|
$pdo->exec('CREATE TABLE parent(id int primary key)');
|
|
$pdo->exec('CREATE TABLE child(id int references parent)');
|
|
|
|
$pdo->setNoticeCallback(function ($message) {
|
|
echo $message;
|
|
});
|
|
|
|
$pdo->exec('TRUNCATE parent CASCADE');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
NOTICE: truncate cascades to table "child"
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|