萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP XML 操作函數大全:DOMDocument 與 XMLReader 完整 API 參考

前言

PHP 提供兩大 XML 處理體系:DOM (Document Object Model) 樹狀記憶體模型,適合中小檔案隨機存取與修改;XMLReader/Writer 流式拉取/推送模型,適合大檔案、低記憶體場景。本文彙整核心類別的所有公共方法、屬性與常數,供開發速查。

一、DOMDocument 類別

載入與儲存

方法簽名說明
loadload(string $filename, int $options = 0): bool從檔案載入 XML,支援 LIBXML_NOENT 等選項
loadXMLloadXML(string $source, int $options = 0): bool從字串載入 XML
loadHTMLloadHTML(string $source, int $options = 0): bool載入 HTML (容錯模式)
loadHTMLFileloadHTMLFile(string $filename, int $options = 0): bool從檔案載入 HTML
savesave(string $filename, int $options = 0): int|false存檔,返回位元組數
saveXMLsaveXML(?DOMNode $node = null, int $options = 0): string|false輸出 XML 字串,可指定節點片段
saveHTMLsaveHTML(?DOMNode $node = null): string|false輸出 HTML 字串
validatevalidate(): bool依據 DTD/Schema 驗證
schemaValidateschemaValidate(string $filename, int $flags = 0): bool依據 XSD 驗證
schemaValidateSourceschemaValidateSource(string $source, int $flags = 0): bool從字串 XSD 驗證

節點建立

方法簽名說明
createElementcreateElement(string $name, string $value = ""): DOMElement|false建立元素節點,可帶文字內容
createElementNScreateElementNS(string $namespace, string $qualifiedName, string $value = ""): DOMElement|false帶命名空間建立元素
createTextNodecreateTextNode(string $content): DOMText|false建立文字節點 (自動轉義)
createCDATASectioncreateCDATASection(string $data): DOMCdataSection|false建立 CDATA 區段
createCommentcreateComment(string $data): DOMComment|false建立註解節點
createAttributecreateAttribute(string $name): DOMAttr|false建立屬性節點
createAttributeNScreateAttributeNS(string $namespace, string $qualifiedName): DOMAttr|false帶命名空間建立屬性
createDocumentFragmentcreateDocumentFragment(): DOMDocumentFragment建立文檔片段 (批次插入高效)
createProcessingInstructioncreateProcessingInstruction(string $target, string $data): DOMProcessingInstruction|false建立處理指令

查詢與遍歷

方法簽名說明
getElementsByTagNamegetElementsByTagName(string $name): DOMNodeList依標籤名獲取節點列表 (即時動態)
getElementsByTagNameNSgetElementsByTagNameNS(string $namespace, string $localName): DOMNodeList命名空間版
getElementByIdgetElementById(string $id): DOMElement|false依 ID 獲取 (需 DTD/Schema 定義 ID 型別)
getElementsByClassNamegetElementsByClassName(string $class): DOMNodeList依 class 獲取 (HTML 文檔)

屬性與配置

  • formatOutput (bool):輸出時縮排格式化
  • preserveWhiteSpace (bool, default true):保留空白文字節點
  • resolveExternals (bool):載入外部實體
  • substituteEntities (bool):替換實體引用
  • strictErrorChecking (bool, default true):嚴格錯誤檢查
  • recover (bool):修復模式載入不完整 XML/HTML
  • documentElement (DOMElement):根元素節點
  • doctype (DOMDocumentType):DOCTYPE 節點
  • implementation (DOMImplementation):實作物件
  • encoding (string):XML 編碼
  • version (string):XML 版本
  • standalone (bool):獨立聲明
  • documentURI (string):文檔 URI
  • config (DOMConfiguration):配置物件 (PHP 5.3+)

二、DOMElement 類別 (元素節點)

方法/屬性簽名/類型說明
tagNamestring (readonly)標籤名 (大寫)
getAttributegetAttribute(string $name): string獲取屬性值 (不存在回傳空字串)
getAttributeNSgetAttributeNS(string $ns, string $name): string命名空間版
setAttributesetAttribute(string $name, string $value): bool設定屬性
setAttributeNSsetAttributeNS(string $ns, string $name, string $value): bool命名空間版
removeAttributeremoveAttribute(string $name): bool移除屬性
removeAttributeNSremoveAttributeNS(string $ns, string $name): bool命名空間版
hasAttributehasAttribute(string $name): bool檢查屬性存在
hasAttributeNShasAttributeNS(string $ns, string $name): bool命名空間版
getAttributeNodegetAttributeNode(string $name): DOMAttr|false獲取屬性節點物件
setAttributeNodesetAttributeNode(DOMAttr $attr): DOMAttr|false設定屬性節點
removeAttributeNoderemoveAttributeNode(DOMAttr $attr): DOMAttr|false移除屬性節點
getElementsByTagNamegetElementsByTagName(string $name): DOMNodeList後代元素查詢
getElementsByTagNameNSgetElementsByTagNameNS(string $ns, string $local): DOMNodeList命名空間版
setIdAttributesetIdAttribute(string $name, bool $isId): void宣告屬性為 ID 型別 (供 getElementById 用)

三、DOMNode 類別 (所有節點基類)

核心屬性

屬性類型說明
nodeTypeint節點類型常數 (XML_ELEMENT_NODE=1, XML_TEXT_NODE=3, XML_CDATA_SECTION_NODE=4, ...)
nodeNamestring節點名稱 (元素為 tagName,屬性為名稱,文字為 #text,文檔為 #document)
nodeValuestring|null節點值 (文字/註解/CDATA 內容,元素為 null)
textContentstring該節點及所有後代文字內容串聯 (讀寫皆可)
parentNodeDOMNode|null父節點
childNodesDOMNodeList子節點列表 (含文字、註解)
firstChildDOMNode|null第一個子節點
lastChildDOMNode|null最後一個子節點
previousSiblingDOMNode|null前一個同級節點
nextSiblingDOMNode|null下一個同級節點
ownerDocumentDOMDocument所屬文檔
namespaceURIstring|null命名空間 URI
prefixstring|null命名空間前綴
localNamestring本地名稱 (不含前綴)
baseURIstring基礎 URI (XML Base)

核心操作方法

方法簽名說明
appendChildappendChild(DOMNode $node): DOMNode|false附加子節點 (自動從原位置移動)
insertBeforeinsertBefore(DOMNode $new, ?DOMNode $ref = null): DOMNode|false在參考節點前插入,$ref 為 null 等同 appendChild
replaceChildreplaceChild(DOMNode $new, DOMNode $old): DOMNode|false替換子節點
removeChildremoveChild(DOMNode $old): DOMNode|false移除子節點
cloneNodecloneNode(bool $deep = false): DOMNode複製節點,$deep=true 遞歸複製後代
hasChildNodeshasChildNodes(): bool是否有子節點
hasAttributeshasAttributes(): bool是否有屬性 (僅元素節點有效)
normalizenormalize(): void合併相鄰文字節點、移除空文字節點
isSupportedisSupported(string $feature, string $version): bool檢查 DOM 功能支援
isSameNodeisSameNode(DOMNode $other): bool是否同一節點物件
isEqualNodeisEqualNode(DOMNode $other): bool結構值相等比較
lookupNamespaceURIlookupNamespaceURI(string $prefix): string|false查詢前綴對應命名空間
lookupPrefixlookupPrefix(string $ns): string|false查詢命名空間對應前綴
isDefaultNamespaceisDefaultNamespace(string $ns): bool檢查是否為預設命名空間
compareDocumentPositioncompareDocumentPosition(DOMNode $other): int節點文檔位置關係位元組
getRootNodegetRootNode(array $options = []): DOMNode獲取根節點 (PHP 8.0+)

四、XMLReader (Pull Parser)

常數:節點類型

XMLReader::NONE = 0;
XMLReader::ELEMENT = 1;           // 開始標籤 
XMLReader::ATTRIBUTE = 2;         // 屬性
XMLReader::TEXT = 3;              // 文字內容
XMLReader::CDATA = 4;             // CDATA
XMLReader::ENTITY_REF = 5;        // 實體引用
XMLReader::ENTITY = 6;            // 實體宣告
XMLReader::PI = 7;                // 處理指令
XMLReader::COMMENT = 8;           // 註解
XMLReader::DOC = 9;               // 文檔節點
XMLReader::DOC_TYPE = 10;         // DOCTYPE
XMLReader::DOC_FRAGMENT = 11;     // 文檔片段
XMLReader::NOTATION = 12;         // 符號宣告
XMLReader::WHITESPACE = 13;       // 空白文字
XMLReader::SIGNIFICANT_WHITESPACE = 14; // 重要空白
XMLReader::END_ELEMENT = 15;      // 結束標籤 
XMLReader::END_ENTITY = 16;       // 實體結束
XMLReader::XML_DECLARATION = 17;  // XML 宣告

核心方法

方法簽名說明
openopen(string $uri, string $encoding = '', int $options = 0): bool開啟 URI (檔案/HTTP/流)
xmlxml(string $source, string $encoding = '', int $options = 0): bool載入字串
readread(): bool移至下一個節點,結束回傳 false
nextnext(string $localName = ''): bool跳至下一個同名元素 (跳過子樹)
closeclose(): bool關閉輸入
getAttributegetAttribute(string $name): string|false當前元素屬性值
getAttributeNsgetAttributeNs(string $name, string $ns): string|false命名空間版
getAttributeNogetAttributeNo(int $index): string|false依索引取屬性
moveToAttributemoveToAttribute(string $name): bool游標移至指定屬性
moveToAttributeNomoveToAttributeNo(int $index): bool游標移至索引屬性
moveToFirstAttributemoveToFirstAttribute(): bool游標移至第一個屬性
moveToNextAttributemoveToNextAttribute(): bool游標移至下一個屬性
moveToElementmoveToElement(): bool游標回到擁有屬性的元素
readStringreadString(): string讀取當前文字/CDATA 節點內容
readInnerXmlreadInnerXml(): string|false讀取當前元素內部 XML
readOuterXmlreadOuterXml(): string|false讀取當前元素完整 XML (含標籤)
expandexpand(?DOMDocument $base = null): DOMNode|false將當前節點展開為 DOM 子樹 (可選基礎文檔)
setSchemasetSchema(string $filename): bool設定 XSD 驗證
setRelaxNGSchemasetRelaxNGSchema(string $filename): bool設定 RelaxNG 驗證
isValidisValid(): bool當前節點是否通過驗證
lookupNamespacelookupNamespace(string $prefix): string|false查詢命名空間
getParserPropertygetParserProperty(int $property): bool獲取解析器屬性
setParserPropertysetParserProperty(int $property, bool $value): bool設定解析器屬性

解析器屬性常數

  • XMLReader::VALIDATE (1):驗證模式
  • XMLReader::SUBST_ENTITIES (2):替換實體
  • XMLReader::LOADDTD (4):載入外部 DTD

五、XMLWriter (流式產生)

對應 XMLReader 的寫入端,記憶體效率極高:

$writer = new XMLWriter();
$writer->openUri('output.xml');
$writer->setIndent(true);
$writer->startDocument('1.0', 'UTF-8');
$writer->startElement('root');
  $writer->writeElement('item', '值1');
  $writer->writeAttribute('attr', '值2');
$writer->endElement();
$writer->endDocument();
$writer->flush();

六、選型建議

  1. 配置檔、小型資料交換、需修改結構 → DOMDocument + XPath
  2. 超大檔 (>100MB)、單向讀取、記憶體受限 → XMLReader
  3. 大量資料匯出 XML → XMLWriter
  4. 簡單陣列轉 XML → SimpleXML (內部基於 libxml)
  5. HTML 解析/清洗 → DOMDocument::loadHTML + DOMXPath 或 Masterminds/HTML5-Parser

結語

PHP 的 XML 生態建構在 libxml2 之上,功能完整且符合 W3C 標準。熟練掌握 DOM 隨機存取 與 Reader/Writer 流式處理 兩大範式,並善用 XPath 查詢、Schema 驗證、XSLT 轉換,即能應對企業級 XML 整合、報表產出、異構系統對接等各類場景。

copyright © 萬盛學電腦網 all rights reserved