# RegexIterator クラス

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

## はじめに

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

## クラス概要

class RegexIterator extends FilterIterator {
/* 定数 */
public const int USE_KEY;
public const int INVERT_MATCH;
public const int MATCH;
public const int GET_MATCH;
public const int ALL_MATCHES;
public const int SPLIT;
public const int REPLACE;
/* プロパティ */
public ?string $replacement = null;
/* メソッド */
public function __construct(
Iterator `$iterator`,
string `$pattern`,
int `$mode` = `RegexIterator::MATCH`,
int `$flags` = 0,
int `$pregFlags` = 0
)
public function accept(): bool
public function getFlags(): int
public function getMode(): int
public function getPregFlags(): int
public function getRegex(): string
public function setFlags(int `$flags`): void
public function setMode(int `$mode`): void
public function setPregFlags(int `$pregFlags`): void
/* 継承したメソッド */
public function FilterIterator::accept(): bool
public function FilterIterator::current(): mixed
public function FilterIterator::key(): mixed
public function FilterIterator::next(): void
public function FilterIterator::rewind(): void
public function FilterIterator::valid(): bool
public function IteratorIterator::current(): mixed
public function IteratorIterator::getInnerIterator(): ?Iterator
public function IteratorIterator::key(): mixed
public function IteratorIterator::next(): void
public function IteratorIterator::rewind(): void
public function IteratorIterator::valid(): 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::INVERT_MATCH`

  RegexIterator::accept() の戻り値を反転させます。

## プロパティ

replacement

## 目次

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

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open