資訊專欄INFORMATION COLUMN
摘要：界面包含四個必須部署的方法下面就是一個部署界面的實例使用方法如下運行結果如下可以看到，雖然是一個，但是完全可以像那樣操作。示例如下類也支持類方法和方法類和類類和類，只支持遍歷一維數組。
這幾天，我在學習PHP語言中的SPL。
這個東西應該屬于PHP中的高級內容，看上去很復雜，但是非常有用，所以我做了長篇筆記。不然記不住，以后要用的時候，還是要從頭學起。
由于這是供自己參考的筆記，不是教程，所以寫得比較簡單，沒有多解釋。但是我想，如果你是一個熟練的PHP5程序員，應該足以看懂下面的材料，而且會發現它很有用。現在除此之外，網上根本沒有任何深入的SPL中文介紹。
===============================
第一部 簡介 1、什么是SPL？SPL是Standard PHP Library（PHP標準庫）的縮寫。
根據官方定義，它是"a collection of interfaces and classes that are meant to solve standard problems"。但是，目前在使用中，SPL更多地被看作是一種使object（物體）模仿array（數組）行為的interfaces和classes。
2、什么是Iterator？SPL的核心概念就是Iterator。通俗地說，Iterator能夠使許多不同的數據結構，都能有統一的操作界面，比如一個數據庫的結果集、同一個目錄中的文件集、或者一個文本中每一行構成的集合。
如果按照普通情況，遍歷一個MySQL的結果集，程序需要這樣寫：
// Fetch the "aggregate structure"
$result = mysql_query("SELECT * FROM users");
// Iterate over the structure
while ( $row = mysql_fetch_array($result) ) {
// do stuff with the row here
}
讀出一個目錄中的內容，需要這樣寫：
// Fetch the "aggregate structure"
$dh = opendir("/home/harryf/files");
// Iterate over the structure
while ( $file = readdir($dh) ) {
// do stuff with the file here
}
讀出一個文本文件的內容，需要這樣寫：
// Fetch the "aggregate structure"
$dh = opendir("/home/harryf/files");
// Iterate over the structure
while ( $file = readdir($dh) ) {
// do stuff with the file here
}
上面三段代碼，雖然處理的是不同的resource（資源），但是功能都是遍歷結果集（loop over contents），因此Iterator的基本思想，就是將這三種不同的操作統一起來，用同樣的命令界面，處理不同的資源。
第二部分 SPL Interfaces 3、Iterator 接口SPL規定，所有部署了Iterator界面的class，都可以用在foreach Loop中。Iterator界面中包含5個必須部署的方法：
* current()
This method returns the current index"s value. You are solely
responsible for tracking what the current index is as the
interface does not do this for you.
* key()
This method returns the value of the current index"s key. For
foreach loops this is extremely important so that the key
value can be populated.
* next()
This method moves the internal index forward one entry.
* rewind()
This method should reset the internal index to the first element.
* valid()
This method should return true or false if there is a current
element. It is called after rewind() or next().
下面就是一個部署了Iterator界面的class示例：
/**
* An iterator for native PHP arrays, re-inventing the wheel
*
* Notice the "implements Iterator" - important!
*/
class ArrayReloaded implements Iterator {
/**
* A native PHP array to iterate over
*/
private $array = array();
/**
* A switch to keep track of the end of the array
*/
private $valid = FALSE;
/**
* Constructor
* @param array native PHP array to iterate over
*/
function __construct($array) {
$this->array = $array;
}
/**
* Return the array "pointer" to the first element
* PHP"s reset() returns false if the array has no elements
*/
function rewind(){
$this->valid = (FALSE !== reset($this->array));
}
/**
* Return the current array element
*/
function current(){
return current($this->array);
}
/**
* Return the key of the current array element
*/
function key(){
return key($this->array);
}
/**
* Move forward by one
* PHP"s next() returns false if there are no more elements
*/
function next(){
$this->valid = (FALSE !== next($this->array));
}
/**
* Is the current element valid?
*/
function valid(){
return $this->valid;
}
}
使用方法如下：
// Create iterator object
$colors = new ArrayReloaded(array ("red","green","blue",));
// Iterate away!
foreach ( $colors as $color ) {
echo $color."
";
}
你也可以在foreach循環中使用key()方法：
// Display the keys as well
foreach ( $colors as $key => $color ) {
echo "$key: $color
";
}
除了foreach循環外，也可以使用while循環，
// Reset the iterator - foreach does this automatically
$colors->rewind();
// Loop while valid
while ( $colors->valid() ) {
echo $colors->key().": ".$colors->current()."
";
$colors->next();
}
根據測試，while循環要稍快于foreach循環，因為運行時少了一層中間調用。
4、ArrayAccess接口部署ArrayAccess界面，可以使得object像array那樣操作。ArrayAccess界面包含四個必須部署的方法：
* offsetExists($offset)
This method is used to tell php if there is a value
for the key specified by offset. It should return
true or false.
* offsetGet($offset)
This method is used to return the value specified
by the key offset.
* offsetSet($offset, $value)
This method is used to set a value within the object,
you can throw an exception from this function for a
read-only collection.
* offsetUnset($offset)
This method is used when a value is removed from
an array either through unset() or assigning the key
a value of null. In the case of numerical arrays, this
offset should not be deleted and the array should
not be reindexed unless that is specifically the
behavior you want.
下面就是一個部署ArrayAccess界面的實例：
/**
* A class that can be used like an array
*/
class Article implements ArrayAccess {
public $title;
public $author;
public $category;
function __construct($title,$author,$category) {
$this->title = $title;
$this->author = $author;
$this->category = $category;
}
/**
* Defined by ArrayAccess interface
* Set a value given it"s key e.g. $A["title"] = "foo";
* @param mixed key (string or integer)
* @param mixed value
* @return void
*/
function offsetSet($key, $value) {
if ( array_key_exists($key,get_object_vars($this)) ) {
$this->{$key} = $value;
}
}
/**
* Defined by ArrayAccess interface
* Return a value given it"s key e.g. echo $A["title"];
* @param mixed key (string or integer)
* @return mixed value
*/
function offsetGet($key) {
if ( array_key_exists($key,get_object_vars($this)) ) {
return $this->{$key};
}
}
/**
* Defined by ArrayAccess interface
* Unset a value by it"s key e.g. unset($A["title"]);
* @param mixed key (string or integer)
* @return void
*/
function offsetUnset($key) {
if ( array_key_exists($key,get_object_vars($this)) ) {
unset($this->{$key});
}
}
/**
* Defined by ArrayAccess interface
* Check value exists, given it"s key e.g. isset($A["title"])
* @param mixed key (string or integer)
* @return boolean
*/
function offsetExists($offset) {
return array_key_exists($offset,get_object_vars($this));
}
}
使用方法如下：
// Create the object
$A = new Article("SPL Rocks","Joe Bloggs", "PHP");
// Check what it looks like
echo "Initial State:";
print_r($A);
echo "";
// Change the title using array syntax
$A["title"] = "SPL _really_ rocks";
// Try setting a non existent property (ignored)
$A["not found"] = 1;
// Unset the author field
unset($A["author"]);
// Check what it looks like again
echo "Final State:";
print_r($A);
echo "";
運行結果如下：
Initial State: Article Object ( [title] => SPL Rocks [author] => Joe Bloggs [category] => PHP ) Final State: Article Object ( [title] => SPL _really_ rocks [category] => PHP )
可以看到，$A雖然是一個object，但是完全可以像array那樣操作。
你還可以在讀取數據時，增加程序內部的邏輯：
function offsetGet($key) {
if ( array_key_exists($key,get_object_vars($this)) ) {
return strtolower($this->{$key});
}
}
5、IteratorAggregate 接口
雖然$A可以像數組那樣操作，卻無法使用foreach遍歷，除非部署了前面提到的Iterator界面。
另一個解決方法是，有時會需要將數據和遍歷部分分開，這時就可以部署IteratorAggregate界面。它規定了一個getIterator()方法，返回一個使用Iterator界面的object。
還是以上一節的Article類為例
class Article implements ArrayAccess, IteratorAggregate {
/**
* Defined by IteratorAggregate interface
* Returns an iterator for for this object, for use with foreach
* @return ArrayIterator
*/
function getIterator() {
return new ArrayIterator($this);
}
使用方法如下：
$A = new Article("SPL Rocks","Joe Bloggs", "PHP");
// Loop (getIterator will be called automatically)
echo "Looping with foreach:";
foreach ( $A as $field => $value ) {
echo "$field : $value
";
}
echo "";
// Get the size of the iterator (see how many properties are left)
echo "Object has ".sizeof($A->getIterator())." elements";
顯示結果如下：
Looping with foreach: title : SPL Rocks author : Joe Bloggs category : PHP Object has 3 elements6、RecursiveIterator 接口
這個接口用于遍歷多層數據，它繼承了Iterator界面，因而也具有標準的current()、key()、next()、 rewind()和valid()方法。同時，它自己還規定了getChildren()和hasChildren()方法。The getChildren() method must return an object that implements RecursiveIterator.
7、SeekableIterator接口SeekableIterator界面也是Iterator界面的延伸，除了Iterator的5個方法以外，還規定了seek()方法，參數是元素的位置，返回該元素。如果該位置不存在，則拋出OutOfBoundsException。
下面是一個是實例：
rewind();
$position = 0;
while ($position < $index && $this->valid()) {
$this->next();
$position++;
}
if (!$this->valid()) {
throw new OutOfBoundsException("Invalid position");
}
}
// Implement current(), key(), next(), rewind()
// and valid() to iterate over data in $member
}
?>
8、Countable 接口
這個接口規定了一個count()方法，返回結果集的數量。
第三部分 SPL Classes 9、SPL的內置類SPL除了定義一系列Interfaces以外，還提供一系列的內置類，它們對應不同的任務，大大簡化了編程。
查看所有的內置類，可以使用下面的代碼：
$value)
{
echo $key." -> ".$value."
";
}
?>
10、 DirectoryIterator類
這個類用來查看一個目錄中的所有文件和子目錄：
";
}
}
/*** if an exception is thrown, catch it here ***/
catch(Exception $e){
echo "No files Found!
";
}
?>
查看文件的詳細信息：
| getFilename() | "; var_dump($file->getFilename()); echo " |
| getBasename() | "; var_dump($file->getBasename()); echo " |
| isDot() | "; var_dump($file->isDot()); echo " |
| __toString() | "; var_dump($file->__toString()); echo " |
| getPath() | "; var_dump($file->getPath()); echo " |
| getPathname() | "; var_dump($file->getPathname()); echo " |
| getPerms() | "; var_dump($file->getPerms()); echo " |
| getInode() | "; var_dump($file->getInode()); echo " |
| getSize() | "; var_dump($file->getSize()); echo " |
| getOwner() | "; var_dump($file->getOwner()); echo " |
| $file->getGroup() | "; var_dump($file->getGroup()); echo " |
| getATime() | "; var_dump($file->getATime()); echo " |
| getMTime() | "; var_dump($file->getMTime()); echo " |
| getCTime() | "; var_dump($file->getCTime()); echo " |
| getType() | "; var_dump($file->getType()); echo " |
| isWritable() | "; var_dump($file->isWritable()); echo " |
| isReadable() | "; var_dump($file->isReadable()); echo " |
| isExecutable( | "; var_dump($file->isExecutable()); echo " |
| isFile() | "; var_dump($file->isFile()); echo " |
| isDir() | "; var_dump($file->isDir()); echo " |
| isLink() | "; var_dump($file->isLink()); echo " |
| getFileInfo() | "; var_dump($file->getFileInfo()); echo " |
| getPathInfo() | "; var_dump($file->getPathInfo()); echo " |
| openFile() | "; var_dump($file->openFile()); echo " |
| setFileClass() | "; var_dump($file->setFileClass()); echo " |
| setInfoClass() | "; var_dump($file->setInfoClass()); echo " |
除了foreach循環外，還可以使用while循環：
valid())
{
echo $it->key()." -- ".$it->current()."
";
/*** move to the next iteration ***/
$it->next();
}
?>
如果要過濾所有子目錄，可以在valid()方法中過濾：
valid())
{
/*** check if value is a directory ***/
if($it->isDir())
{
/*** echo the key and current value ***/
echo $it->key()." -- ".$it->current()."
";
}
/*** move to the next iteration ***/
$it->next();
}
?>
11、ArrayObject類
這個類可以將Array轉化為object。
getIterator();
/*** check if valid ***/
$iterator->valid();
/*** move to the next array member ***/
$iterator->next())
{
/*** output the key and current array value ***/
echo $iterator->key() . " => " . $iterator->current() . "
";
}
?>
增加一個元素：
$arrayObj->append("dingo");
12、ArrayIterator類
這個類實際上是對ArrayObject類的補充，為后者提供遍歷功能。
示例如下：
$value)
{
echo $key." => ".$value."
";
}
}
catch (Exception $e)
{
echo $e->getMessage();
}
?>
ArrayIterator類也支持offset類方法和count()方法：
ArrayIterator類和ArrayObject類，只支持遍歷一維數組。如果要遍歷多維數組，必須先用RecursiveIteratorIterator生成一個Iterator，然后再對這個Iterator使用RecursiveIteratorIterator。
"butch", "sex"=>"m", "breed"=>"boxer"),
array("name"=>"fido", "sex"=>"m", "breed"=>"doberman"),
array("name"=>"girly","sex"=>"f", "breed"=>"poodle")
);
foreach(new RecursiveIteratorIterator(new RecursiveArrayIterator($array)) as $key=>$value)
{
echo $key." -- ".$value."
";
}
?>
14、 FilterIterator類
FilterIterator類可以對元素進行過濾，只要在accept()方法中設置過濾條件就可以了。
示例如下：
"kiwi", "kookaburra", "platypus");
class CullingIterator extends FilterIterator{
/*** The filteriterator takes a iterator as param: ***/
public function __construct( Iterator $it ){
parent::__construct( $it );
}
/*** check if key is numeric ***/
function accept(){
return is_numeric($this->key());
}
}/*** end of class ***/
$cull = new CullingIterator(new ArrayIterator($animals));
foreach($cull as $key=>$value)
{
echo $key." == ".$value."
";
}
?>
下面是另一個返回質數的例子
current() % 2 != 1)
{
return false;
}
$d = 3;
$x = sqrt($this->current());
while ($this->current() % $d != 0 && $d < $x)
{
$d += 2;
}
return (($this->current() % $d == 0 && $this->current() != $d) * 1) == 0 ? true : false;
}
}/*** end of class ***/
/*** an array of numbers ***/
$numbers = range(212345,212456);
/*** create a new FilterIterator object ***/
$primes = new primeFilter(new ArrayIterator($numbers));
foreach($primes as $value)
{
echo $value." is prime.
";
}
?>
15、SimpleXMLIterator類
這個類用來遍歷xml文件。
XML; /*** a new simpleXML iterator object ***/ try { /*** a new simple xml iterator ***/ $it = new SimpleXMLIterator($xmlstring); /*** a new limitIterator object ***/ foreach(new RecursiveIteratorIterator($it,1) as $name => $data) { echo $name." -- ".$data." Phascolarctidae koala Bruce macropod kangaroo Bruce diprotodon wombat Bruce macropod wallaby Bruce dromaius emu Bruce Apteryx kiwi Troy kingfisher kookaburra Bruce monotremes platypus Bruce arachnid funnel web Bruce 8
"; } } catch(Exception $e) { echo $e->getMessage(); } ?>
new RecursiveIteratorIterator($it,1)表示顯示所有包括父元素在內的子元素。
顯示某一個特定的元素值，可以這樣寫：
$v)
{
echo $v->species."
";
}
}
}
catch(Exception $e)
{
echo $e->getMessage();
}
?>
相對應的while循環寫法為
rewind(); $sxe->valid(); $sxe->next())
{
if($sxe->hasChildren())
{
foreach($sxe->getChildren() as $element=>$value)
{
echo $value->species."
";
}
}
}
}
catch(Exception $e)
{
echo $e->getMessage();
}
?>
最方便的寫法，還是使用xpath：
xpath("animal/category/species");
/*** iterate over the xpath ***/
foreach ($foo as $k=>$v)
{
echo $v."
";
}
}
catch(Exception $e)
{
echo $e->getMessage();
}
?>
下面的例子，顯示有namespace的情況：
