PHP設計模式漫談之迭代器模式

原文出處:blogspot

今天《PHP設計模式漫談》系列的主角是迭代器（Iterator）模式，它在一個很常見的過程上提供了一個抽象：位於物件圖不明部分的一組物件（或標量）集合上的迭代。迭代有幾種不同的具體執行方法：在陣列屬性，集合物件，陣列，甚至一個查詢結果集之上迭代。

在物件的世界裡，迭代器模式要維持類似陣列的功能，看作是一個非侵入性物件刻面（facet），Client類往往分離自真實物件實現，指iterator介面。只要有可能，我們可以給迭代器傳送一個引用，代替將來可能發生變化的具體或抽象類。

圖1 迭代器模式

參與者：

◆客戶端（Client）：引用迭代器模式的方法在一組值或物件上執行一個迴圈。

◆迭代器（Iterator）：在迭代過程上的抽象，包括next()，isFinished()，current()等方法。

◆具體迭代器（ConcreteIterators）：在一個特定的物件集，如陣列，樹，組合，集合等上實現迭代。

通過Traversable介面，PHP原生態支援迭代器模式，這個介面由Iterator和IteratorAggregate做了擴充套件，這兩個子介面不僅是定義了一套標準的方法，每個Traversable物件都可以原封不動地傳遞給foreach()，foreach是迭代器的主要客戶端，Iterator實現是真正的迭代器，而IteratorAggregate是有其它職責的Traversable物件，它通過getIterator()方法返回一個Iterator。

標準PHP庫是PHP中繫結的唯一通用目的物件導向庫，定義了額外的介面和公用類。OuterIterator實現裝飾一個Iterator，CachingIterator和LimitIterator是這個介面的兩個例子。

RecursiveIterator是Iterator介面為樹形結構實現的一個擴充套件，它定義了一組額外的方法檢查迭代中當前元素的子物件是否存在。RecursiveArrayIterator和RecursiveDirectoryIterator是這個介面的實現示例，這些型別的迭代器可以原樣使用，或是用一個RecursiveIteratorIterator橋接到一個普通的迭代器契約。這個OuterIterator實現將會根據構造引數執行深度優先或廣度優先遍歷。

使用RecursiveIteratorIterator時，可以將其傳遞給foreach，請看後面的程式碼示例，瞭解RecursiveIterators的不同用法和它們的超集Iterator。最後，SeekableIterators向契約新增了一個seek()方法，它可以用於移動Iterator的內部狀態到一個特定的迭代點。

注意，迭代器是比物件集更好的抽象，因為我們可以讓InfiniteIterators，NoRewindIterators等，不用與普通陣列陣列與一致，因此，Iterator缺少count()函式等功能。

在PHP官方手冊中可以找到完整的SPL迭代器列表。得益於對PHP的強力支援，使用迭代器模式的大部分工作都包括在標準實現中，下面的程式碼示例就利用了標準Iterator和RecursiveIterators的功能。

<?php 
/** 
 
* Collection that wraps a numeric array. 
 
* All five public methods are needed to implement 
 
* the Iterator interface. 
 
*/
class Collection implements Iterator 
{ 
 private $_content; 
 private $_index = 0; 
 
 public function __construct(array $content) 
 { 
 $this->_content = $content; 
 } 
 
 public function rewind() 
 { 
 $this->_index = 0; 
 } 
 
 public function valid() 
 { 
 return isset($this->_content[$this->_index]); 
 } 
 
 public function current() 
 { 
 return $this->_content[$this->_index]; 
 } 
 
 public function key() 
 { 
 return $this->_index; 
 } 
 
 public function next() 
 { 
 $this->_index++; 
 } 
} 
 
$arrayarray = array('A', 'B', 'C', 'D'); 
echo "Collection: "; 
foreach (new Collection($array) as $key => $value) { 
 echo "$key => $value. "; 
} 
echo "\n";

/** 
 
* Usually IteratorAggregate is the interface to implement. 
 
* It has only one method, which must return an Iterator 
 
* already defined as another class (e.g. ArrayIterator) 
 
* Iterator gives a finer control over the algorithm, 
 
* because all the hook points of Iterator' contract 
 
* are available for implementation. 
 
*/
class NumbersSet implements IteratorAggregate 
{ 
 private $_content; 
 
 public function __construct(array $content) 
 { 
 $this->_content = $content; 
 } 
 
 public function contains($number) 
 { 
 return in_array($number, $this->_content); 
 } 
 
 
/** 
 
* Only this method is necessary to implement IteratorAggregate. 
 
* @return Iterator 
 
*/
 public function getIterator() 
 { 
 return new ArrayIterator($this->_content); 
 } 
} 
 
echo "NumbersSet: "; 
foreach (new NumbersSet($array) as $key => $value) { 
 echo "$key => $value. "; 
} 
echo "\n";

// let's play with RecursiveIterator implementations 
$it = new RecursiveArrayIterator(array( 
 'A', 
 'B', 
 array( 
 'C', 
 'D'
 ), 
 array( 
 array( 
 'E', 
 'F'
 ), 
 array( 
 'G', 
 'H', 
 'I'
 ) 
 ) 
)); 
// $it is a RecursiveIterator but also an Iterator, 
// so it loops normally over the four elements 
// of the array. 
echo "Foreach over a RecursiveIterator: "; 
foreach ($it as $value) { 
 echo $value; 
 
// but RecursiveIterators specify additional 
 
// methods to explore children nodes 
 $children = $it->hasChildren() ? '{Yes}' : '{No}'; 
 echo $children, ' '; 
} 
echo "\n"; 
// we can bridge it to a different contract via 
// a RecursiveIteratorIterator, whose cryptic name 
// should be read as 'an Iterator that spans over 
// a RecursiveIterator'. 
echo "Foreach over a RecursiveIteratorIterator: "; 
foreach (new RecursiveIteratorIterator($it) as $value) { 
 echo $value; 
} 
echo "\n";