<?xml version="1.0" encoding="UTF-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: hirokawa Status: ready -->

<refentry xml:id="function.stream-filter-register" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>stream_filter_register</refname>

<refpurpose>ユーザー定義のストリームフィルタを登録する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>stream_filter_register</methodname>

<methodparam><type>string</type><parameter>filter_name</parameter></methodparam>

<methodparam><type>string</type><parameter>class</parameter></methodparam>

</methodsynopsis>

<para>

<function>stream_filter_register</function> は、<function>fopen</function>

や <function>fread</function> などのファイルシステムの関数で利用可能な

登録されているどの種類のストリームとも一緒に使うことのできる

カスタムフィルタを登録します。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>filter_name</parameter></term>

<listitem>

<para>

登録するフィルタ名。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>class</parameter></term>

<listitem>

<para>

フィルタを実装するには、まず、<classname>php_user_filter</classname>

を継承したクラスのメンバ関数を実装しなくてはなりません。

<literal>PHP</literal> は、書き込みまたは読み出し操作を

カスタムフィルタの付加されたストリームに対して行う際に、まず

データをそのフィルタに(そして、付加されている他のすべてのフィルタにも)

渡し、指示どおりストリームのデータが変更されるようにします。

メソッドの実装は、<classname>php_user_filter</classname> の説明の通りにしなければなりません。

さもないと、定義されていない動作をします。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success;

</para>

<para>

<function>stream_filter_register</function> は、

指定された <parameter>filter_name</parameter> がすでに定義されている場合、

&false; を返します。

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><filename>foo-bar.txt</filename> ストリームの文字を大文字化するフィルタ</title>

<para>

下記の例は、読み込まれたり書き出されたりするデータに含まれるすべての英文字を

大文字化する <literal>strtoupper</literal> ストリームを実装し、<literal>foo-bar.txt</literal>

ストリームに適用するものです。

</para>

<programlisting role="php">

<![CDATA[

<?php

/* フィルタクラスを定義する */

class strtoupper_filter extends php_user_filter {

function filter($in, $out, &$consumed, $closing)

{

while ($bucket = stream_bucket_make_writeable($in)) {

$bucket->data = strtoupper($bucket->data);

$consumed += $bucket->datalen;

stream_bucket_append($out, $bucket);

}

return PSFS_PASS_ON;

}

}

/* PHP にフィルタを登録する */

stream_filter_register("strtoupper", "strtoupper_filter")

or die("Failed to register filter");

$fp = fopen("foo-bar.txt", "w");

/* フィルタを開いたストリームに付加する */

stream_filter_append($fp, "strtoupper");

fwrite($fp, "Line1\n");

fwrite($fp, "Word - 2\n");

fwrite($fp, "Easy As 123\n");

fclose($fp);

/* ファイルを読み出し出力する

*/

readfile("foo-bar.txt");

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

LINE1

WORD - 2

EASY AS 123

]]>

</screen>

</example>

</para>

<para>

<example>

<title>複数のフィルタ名に対応する一般的なフィルタクラスを登録する</title>

<programlisting role="php">

<![CDATA[

<?php

/* フィルタクラスを定義する */

class string_filter extends php_user_filter {

var $mode;

function filter($in, $out, &$consumed, $closing)

{

while ($bucket = stream_bucket_make_writeable($in)) {

if ($this->mode == 1) {

$bucket->data = strtoupper($bucket->data);

} elseif ($this->mode == 0) {

$bucket->data = strtolower($bucket->data);

}

$consumed += $bucket->datalen;

stream_bucket_append($out, $bucket);

}

return PSFS_PASS_ON;

}

function onCreate()

{

if ($this->filtername == 'str.toupper') {

$this->mode = 1;

} elseif ($this->filtername == 'str.tolower') {

$this->mode = 0;

} else {

/* その他の str.* フィルタが問い合わせられた場合は

失敗を報告し、PHP が検索を続けられるようにする */

return false;

}

return true;

}

}

/* PHP にフィルタを登録する */

stream_filter_register("str.*", "string_filter")

or die("Failed to register filter");

$fp = fopen("foo-bar.txt", "w");

/* フィルタを開いたストリームに付加する

ここで str.tolower をバインドすることも可能 */

stream_filter_append($fp, "str.toupper");

fwrite($fp, "Line1\n");

fwrite($fp, "Word - 2\n");

fwrite($fp, "Easy As 123\n");

fclose($fp);

/* ファイルを読み出し出力する

*/

readfile("foo-bar.txt");

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

LINE1

WORD - 2

EASY AS 123

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>stream_wrapper_register</function></member>

<member><function>stream_filter_append</function></member>

<member><function>stream_filter_prepend</function></member>

</simplelist>

</para>

</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

-->