1.6 SPL - FilterIterator

Olá Pessoal,

Fiquei alguns dias sem postar pois estava reescrevendo o conteúdo, como daqui para frente algumas coisas ficam mesmo mais complexas, resolvi simplificar os códigos para que o entendimento seja melhor.

Da última vez, falamos sobre um design pattern chamado Iterator, sobre as interfaces Iterator e IteratorAggregate, hoje vamos começar a demonstrar alguns iteratores da SPL, o primeiro será o FilterIterator.

Como o próprio nome sugere FilterIterator é um iterator com o objetivo de filtrar dados de um conjunto de elementos, imaginem a seguinte situação:

$lista = array( 10 , 30 , 2 , 9 , 7 , 0 , 1 , 8 , 6 , 10 );

Temos nessa lista, vários números entre pares e impares. Muitas vezes estamos diante de situações como essa, onde possuímos diversos valores, mas somente alguns desses nos interessam como, por exemplo, apenas os pares.

Para nossa felicidade, a SPL nos oferece a FilterIterator, uma classe abstrata que servirá como base para criação de filtros reutilizáveis, por exemplo, vamos imaginar que queremos apenas os números pares daquela lista:

EvenFilterIterator.php

class EvenFilterIterator extends FilterIterator {

public function accept(){
$item = $this->getInnerIterator()->current();

return ( $item % 2 ) == 0;
}
}

Como é notório, nossa classe EvenFilterIterator possui apenas 1 método, esse método é chamado automaticamente pela FilterIterator quando estamos percorrendo os elementos de uma lista, vamos ver como funciona:

<?php
$lista = array( 10 , 30 , 2 , 9 , 7 , 0 , 1 , 8 , 6 , 10 );

foreach ( new EvenFilterIterator( new ArrayIterator( $lista ) ) as $item ){
var_dump( $item );
}

A saída será:

int(10)

int(30) int(2) int(0) int(8) int(6) int(10)

Vejam só, temos um filtro para números pares, totalmente reutilizável, agora, imaginem que tenhamos na nossa lista, vários tipos de elementos:

$lista = array( 'Teste' , 10 , true , null , 'email@teste.com' , 9 , 7 , 'João Batista Neto' , false , 12.75 , 'fulano@dominio.com' , 10 );

E, se quisermos apenas as strings dessa lista ?

StringFilterIterator.php

class StringFilterIterator extends FilterIterator {

public function accept(){
return is_string( $this->getInnerIterator()->current() );
}
}

Pronto, temos um filtro para strings reutilizável, vamos ver o resultado:

<?php
$lista = array( 'Teste' , 10 , true , null , 'email@teste.com' , 9 , 7 , 'João Batista Neto' , false , 12.75 , 'fulano@dominio.com' , 10 );

foreach ( new StringFilterIterator( new ArrayIterator( $lista ) ) as $item ){
var_dump( $item );
}

A saída:

string(5) "Teste"

string(15) "email@teste.com" string(18) "João Batista Neto" string(18) "fulano@dominio.com"

Mas, todas as strings também não nos interessa, queremos apenas o que é email. Simples:

EmailFilterIterator.php

class EmailFilterIterator extends FilterIterator {

public function accept(){
return filter_var( $this->getInnerIterator()->current() , FILTER_VALIDATE_EMAIL );
}
}

Pronto, agora é só iterar nossa lista:

<?php
$lista = array( 'Teste' , 10 , true , null , 'email@teste.com' , 9 , 7 , 'João Batista Neto' , false , 12.75 , 'fulano@dominio.com' , 10 );

foreach ( new EmailFilterIterator( new StringFilterIterator( new ArrayIterator( $lista ) ) ) as $item ){
var_dump( $item );
}

Saída:

string(15) "email@teste.com"

string(18) "fulano@dominio.com"

Bom, funciona assim:

1. A FilterIterator é uma classe abstrata que deixa a responsabilidade da definição do método accept() para que implementemos.
2. O método construtor da FilterIterator precisa necessariamente receber um Iterator, por isso utilizamos ArrayIterator para nossa array.
3. Quando passamos um Iterator qualquer para o construtor, esse Iterator fica encapsulado na FilterIterator, para que possamos acessá-lo, precisamos usar o método getInnetIterator(), que faz justamente isso, retorna o Iterator que passamos para o construtor.
4. O método accept() é chamado a cada volta do Iterator, se retornar TRUE então o valor é válido, caso contrário o valor é ignorado e o próximo item do InnerIterator é testado.

Com isso, podemos criar vários tipos de filtros reutilizáveis e, para utilizá-los, basta encadear os filtros que queremos para, em poucas linhas, tenhamos o resultado esperado.

Bom, por hora é só, no próximo tópico da série PHP Orientado a Objetos, continuaremos falando sobre a SPL.

/applications/core/interface/imageproxy/imageproxy.php?img=http://forum.imasters.com.br/public/style_emoticons/default/wink.gif&key=0566fd943552bcff9cb1b879403ca34b5ff8f67befaac7fe4648006e9f764689" alt="Imagem Postada" class="bbc_emoticon">

Índice /applications/core/interface/imageproxy/imageproxy.php?img=http://forum.imasters.com.br/public/style_emoticons/default/seta.gif&key=e2d72b30771339c36df1f88688ecc571784dab60a19e2c7c2ff398c277802ac0" alt="Imagem Postada" class="bbc_emoticon">

public function accept() {
	return substr( $this->getInnerIterator()->current(), 0, 4 ) == 'cur_';
}
}

$array = array( 'sar_3', 'cur_40', 'cur_41', 'cur_115', 'dar_56', 'aar_57' );
$teste = new RemoveItemFilterIterator( new ArrayIterator( $array ) );