オブジェクトの反復処理
PHP 5 は、たとえば foreach 命令などによる反復処理を可能とするよう オブジェクトを定義する手段を提供します。 デフォルトで、 全ての アクセス権限がある プロパティは、反復処理に使用することができます。
例1 Simple Object Iteration
<?phpclass MyClass{ public $var1 = 'value 1'; public $var2 = 'value 2'; public $var3 = 'value 3'; protected $protected = 'protected var'; private $private = 'private var'; function iterateVisible() { echo "MyClass::iterateVisible:\n"; foreach ($this as $key => $value) { print "$key => $value\n"; } }}$class = new MyClass();foreach($class as $key => $value) { print "$key => $value\n";}echo "\n";$class->iterateVisible();?>
上の例の出力は以下となります。
var1 => value 1 var2 => value 2 var3 => value 3 MyClass::iterateVisible: var1 => value 1 var2 => value 2 var3 => value 3 protected => protected var private => private var
出力からわかるように、 foreach による反復処理がすべての アクセス権がある プロパティについて行われています。
さらに、Iterator
インターフェイス
も実装できます。
これを実装すれば、オブジェクトの反復処理の方法や処理中に取得できる値を決めることができます。
例2 Iteratorを実装するオブジェクトの反復処理
<?phpclass MyIterator implements Iterator{ private $var = array(); public function __construct($array) { if (is_array($array)) { $this->var = $array; } } public function rewind() { echo "rewinding\n"; reset($this->var); } public function current() { $var = current($this->var); echo "current: $var\n"; return $var; } public function key() { $var = key($this->var); echo "key: $var\n"; return $var; } public function next() { $var = next($this->var); echo "next: $var\n"; return $var; } public function valid() { $key = key($this->var); $var = ($key !== NULL && $key !== FALSE); echo "valid: $var\n"; return $var; }}$values = array(1,2,3);$it = new MyIterator($values);foreach ($it as $a => $b) { print "$a: $b\n";}?>
上の例の出力は以下となります。
rewinding valid: 1 current: 1 key: 0 0: 1 next: 2 valid: 1 current: 2 key: 1 1: 2 next: 3 valid: 1 current: 3 key: 2 2: 3 next: valid:
Iterator のすべてのメソッドを実装するかわりに、 IteratorAggregate インターフェイス を使うこともできます。 IteratorAggregate で実装を要するメソッドは IteratorAggregate::getIterator() だけで、 このメソッドは Iterator を実装したクラスのインスタンスを返す必要があります。
例3 IteratorAggregateを実装するオブジェクトの反復処理
<?phpclass MyCollection implements IteratorAggregate{ private $items = array(); private $count = 0; // Required definition of interface IteratorAggregate public function getIterator() { return new MyIterator($this->items); } public function add($value) { $this->items[$this->count++] = $value; }}$coll = new MyCollection();$coll->add('value 1');$coll->add('value 2');$coll->add('value 3');foreach ($coll as $key => $val) { echo "key/value: [$key -> $val]\n\n";}?>
上の例の出力は以下となります。
rewinding current: value 1 valid: 1 current: value 1 key: 0 key/value: [0 -> value 1] next: value 2 current: value 2 valid: 1 current: value 2 key: 1 key/value: [1 -> value 2] next: value 3 current: value 3 valid: 1 current: value 3 key: 2 key/value: [2 -> value 3] next: current: valid:
注意:
より詳細なイタレータの例については、 SPL 拡張モジュール を参照ください。
注意:
PHP 5.5 以降を使っている場合は、 ジェネレータ についても調べてみるといいでしょう。 これも、イテレータを定義する方法の一つとして使えます。
