本文是 PHP 5 XML 解析系列的第三篇,主角是 SimpleDocumentNode 這個類別——負責在 DOM 化的結構中,代表單一節點並提供往上、往下走訪的能力。
<?php
/**
* =========================================================
*
* @author hahawen
* @since 2004-12-04
* @copyright Copyright (c) 2004, NxCoder Group
*
* =========================================================
* class SimpleDocumentNode
* xml Node class, include values/attributes/subnodes.
* all this package's work for xml file, and method is action as DOM.
*
* @package SmartWeb.common.XML
* @version 1.0
*/
class SimpleDocumentNode extends SimpleDocumentBase
{
private $seq = null; // 節點在父層中的序號
private $rootObject = null; // 文件根物件
private $pNodeId = null; // 父節點的 id
function __construct($rootObject, $pNodeId, $nodeTag, $seq)
{
parent::__construct($nodeTag);
$this->rootObject = $rootObject;
$this->pNodeId = $pNodeId;
$this->seq = $seq;
}
public function getPNodeObject()
{
return ($this->pNodeId == -1)
? $this->rootObject
: $this->rootObject->getNodeById($this->pNodeId);
}
public function getSeq()
{
return $this->seq;
}
public function createNode($name, $attributes)
{
return $this->createNodeByName($this->rootObject, $name, $attributes, $this->getSeq());
}
public function removeNode($name)
{
return $this->removeNodeByName($this->rootObject, $name);
}
public function getNode($name = null)
{
return $this->getNodeByName($this->rootObject, $name);
}
}
?>
這個類別繼承自 SimpleDocumentBase,本體只負責三件事:記住自己是誰、記住父節點是誰、以及把操作委派給根物件。
三個私有欄位構成節點的定位資訊。$rootObject 指向整份文件的根物件,所有實際的節點查表與維護工作都集中在它身上;$pNodeId 是父節點的識別碼;$seq 則是這個節點在同一層級中的排序序號,讓同級兄弟之間保有順序資訊。
getPNodeObject() 用一個簡單的哨值判斷來取得父節點:當 $pNodeId 等於 -1,代表自己就是頂層,直接回傳根物件;否則向根物件查詢對應 id 的節點。這種「以負數表示無父節點」的手法,避免了額外引入 NULL 判斷與型別混淆。
getSeq() 對外公開序號,讓呼叫端能得知節點的排列位置。
createNode()、removeNode()、getNode() 三個方法則展現了典型的委派模式:它們都不自行操作資料,而是把 $this->rootObject 與相關參數打包,轉交給 createNodeByName、removeNodeByName、getNodeByName 處理。其中 createNode 還會把自己目前的序號傳下去,作為新節點插入位置的依據。
把狀態集中到根物件、讓節點物件保持「輕量」,有兩個實際好處。一是任何節點都能透過根物件存取整份文件,不必為了找一個遠房親戚而層層遞迴;二是新增節點、刪除節點的規則只需在根物件實作一次,所有節點物件自然共享同一套邏輯,避免行為分歧。
代價則是所有節點都持有根物件的參考,文件中若存在節點物件與根物件互相指向的情況,PHP 4 時代沒有垃圾回收迴圈的問題需要留意;到了 PHP 5.3 之後引入迴圈收集器,這類結構才變得安全。
這段程式碼寫於 2004 年,正好示範了 PHP 5 剛問世時如何用物件導向手法,把原本需要大量程序式程式碼才能完成的 XML 走訪工作,收斂成幾個語意清楚的方法呼叫。