# RegexIterator クラス

(PHP 5 >= 5.2.0, PHP 7)

## はじめに

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

## クラス概要

RegexIterator extends FilterIterator {
/* 定数 */
const integer MATCH = 0 ;
const integer GET_MATCH = 1 ;
const integer ALL_MATCHES = 2 ;
const integer SPLIT = 3 ;
const integer REPLACE = 4 ;
const integer USE_KEY = 1 ;
/* メソッド */
public __construct ( Iterator `$iterator` , string `$regex` [, int `$mode` = self::MATCH [, int `$flags` = 0 [, int `$preg_flags` = 0 ]]] )
public accept ( void ) : bool
public getFlags ( void ) : int
public getMode ( void ) : int
public getPregFlags ( void ) : int
public getRegex ( void ) : string
public setFlags ( int `$flags` ) : void
public setMode ( int `$mode` ) : void
public setPregFlags ( int `$preg_flags` ) : void
/* 継承したメソッド */
public abstract FilterIterator::accept ( void ) : bool
public FilterIterator::__construct ( Iterator `$iterator` )
public FilterIterator::current ( void ) : mixed
public FilterIterator::getInnerIterator ( void ) : Iterator
public FilterIterator::key ( void ) : mixed
public FilterIterator::next ( void ) : void
public FilterIterator::rewind ( void ) : void
public FilterIterator::valid ( void ) : bool
}

## 定義済み定数

## RegexIterator の操作モード

`RegexIterator::ALL_MATCHES`

  現在のエントリにマッチするものをすべて返します (preg_match_all() を参照ください)。

`RegexIterator::GET_MATCH`

  現在のエントリに最初にマッチしたものを返します (preg_match() を参照ください)。

`RegexIterator::MATCH`

  現在のエントリに対するマッチ (フィルタ) のみを行います (preg_match() を参照ください)。

`RegexIterator::REPLACE`

  現在のエントリを置換します (preg_replace() を参照ください。まだ完全には実装されていません)。

`RegexIterator::SPLIT`

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

## RegexIterator のフラグ

`RegexIterator::USE_KEY`

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

## 目次

- RegexIterator::accept — 受け入れ状況を取得する
- RegexIterator::__construct — 新しい RegexIterator を作成する
- RegexIterator::getFlags — フラグを取得する
- RegexIterator::getMode — 操作モードを返す
- RegexIterator::getPregFlags — 正規表現フラグを返す
- RegexIterator::getRegex — 現在の正規表現を返す
- RegexIterator::setFlags — フラグを設定する
- RegexIterator::setMode — 操作モードを設定する
- RegexIterator::setPregFlags — 正規表現フラグを設定する