RegexIterator

&reftitle.intro; This iterator can be used to filter another iterator based on a regular expression.

&reftitle.classsynopsis; RegexIterator RegexIterator extends FilterIterator &Constants; 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 &Methods; &InheritedMethods;

&reftitle.constants;

RegexIterator::ALL_MATCHES Return all matches for the current entry (see preg_match_all). RegexIterator::GET_MATCH Return the first match for the current entry (see preg_match). RegexIterator::MATCH Only execute match (filter) for the current entry (see preg_match). RegexIterator::REPLACE Replace the current entry (see preg_replace; Not fully implemented yet) RegexIterator::SPLIT Returns the split values for the current entry (see preg_split).

RegexIterator::USE_KEY Special flag: Match the entry key instead of the entry value.

&reference.spl.entities.regexiterator;