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

<reference xml:id="class.regexiterator" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

<title>RegexIterator クラス</title>

<titleabbrev>RegexIterator</titleabbrev>

<partintro>

<section xml:id="regexiterator.intro">

&reftitle.intro;

<para>

このイテレータを使うと、別のイテレータを正規表現でフィルタリングすることができます。

</para>

</section>

<section xml:id="regexiterator.synopsis">

&reftitle.classsynopsis;

<classsynopsis class="class">

<ooclass>

<classname>RegexIterator</classname>

</ooclass>

<ooclass>

<modifier>extends</modifier>

<classname>FilterIterator</classname>

</ooclass>

<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="regexiterator.constants.use-key">RegexIterator::USE_KEY</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="regexiterator.constants.invert-match">RegexIterator::INVERT_MATCH</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="regexiterator.constants.match">RegexIterator::MATCH</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="regexiterator.constants.get-match">RegexIterator::GET_MATCH</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="regexiterator.constants.all-matches">RegexIterator::ALL_MATCHES</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="regexiterator.constants.split">RegexIterator::SPLIT</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="regexiterator.constants.replace">RegexIterator::REPLACE</varname>

</fieldsynopsis>

<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>

<fieldsynopsis>

<modifier>public</modifier>

<type class="union"><type>string</type><type>null</type></type>

<varname linkend="regexiterator.props.replacement">replacement</varname>

<initializer>null</initializer>

</fieldsynopsis>

<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.regexiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='RegexIterator'])">

<xi:fallback/>

</xi:include>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.regexiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='RegexIterator'])">

<xi:fallback/>

</xi:include>

<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filteriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='FilterIterator'])">

<xi:fallback/>

</xi:include>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='IteratorIterator'])">

<xi:fallback/>

</xi:include>

</classsynopsis>

</section>

<section xml:id="regexiterator.constants">

&reftitle.constants;

<section xml:id="regexiterator.constants.operation-modes">

<title>RegexIterator の操作モード</title>

<variablelist>

<varlistentry xml:id="regexiterator.constants.all-matches">

<term><constant>RegexIterator::ALL_MATCHES</constant></term>

<listitem>

<para>

現在のエントリにマッチするものをすべて返します

(<function>preg_match_all</function> を参照ください)。

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="regexiterator.constants.get-match">

<term><constant>RegexIterator::GET_MATCH</constant></term>

<listitem>

<para>

現在のエントリに最初にマッチしたものを返します

(<function>preg_match</function> を参照ください)。

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="regexiterator.constants.match">

<term><constant>RegexIterator::MATCH</constant></term>

<listitem>

<para>

現在のエントリに対するマッチ (フィルタ) のみを行います

(<function>preg_match</function> を参照ください)。

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="regexiterator.constants.replace">

<term><constant>RegexIterator::REPLACE</constant></term>

<listitem>

<para>

現在のエントリを置換します

(<function>preg_replace</function> を参照ください。まだ完全には実装されていません)。

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="regexiterator.constants.split">

<term><constant>RegexIterator::SPLIT</constant></term>

<listitem>

<para>

現在のエントリで分割した値を返します (<function>preg_split</function> を参照ください)。

</para>

</listitem>

</varlistentry>

</variablelist>

</section>

<section xml:id="regexiterator.constants.flags">

<title>RegexIterator のフラグ</title>

<variablelist>

<varlistentry xml:id="regexiterator.constants.use-key">

<term><constant>RegexIterator::USE_KEY</constant></term>

<listitem>

<para>

特別なフラグ: エントリの値ではなく、キーにマッチさせます。

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="regexiterator.constants.invert-match">

<term><constant>RegexIterator::INVERT_MATCH</constant></term>

<listitem>

<para>

<methodname>RegexIterator::accept</methodname>

の戻り値を反転させます。

</para>

</listitem>

</varlistentry>

</variablelist>

</section>

</section>

<section xml:id="regexiterator.props">

&reftitle.properties;

<variablelist>

<varlistentry xml:id="regexiterator.props.replacement">

<term>

<varname>replacement</varname>

</term>

<listitem>

<para/>

</listitem>

</varlistentry>

</variablelist>

</section>

</partintro>

&reference.spl.entities.regexiterator;

</reference>