php xml常用函数的集合及四种方法

1、DOM 函数

a、DOMDocument->load()
作用:加载xml文件
用法:DOMDocument->load( string filename )
参数:filename,xml文件;
返回:如果成功则返回 TRUE,失败则返回 FALSE。

b、DOMDocument->loadXML()
作用:加载xml代码
用法:DOMDocument->loadXML( string source )
参数:source xml代码;
返回:如果成功则返回 TRUE,失败则返回 FALSE。

c、DOMDocument->getElementsByTagName_r()
作用:按标签名查找
用法:DOMDocument->getElementsByTagName_r(string name)
参数:name,标签名称;
返回:新的 DOMNodeList 对象 。

d、DOMDocument->getElementById()
作用:按标签名查找
用法:DOMDocument->getElementById(string elementId )
参数:elementId ,标签id;
返回:新的 DOMNodeList 对象 。

e、DOMDocument->createElement_x_x()
作用:创建标签
用法:DOMDocument->createElement_x_x(string name [, string value] )
参数:name,标签名称,value,只;
返回:新的 DOMElement 对象,失败为false 。

f、DOMDocument->createTextNode()
作用:创建文本节点
用法:DOMDocument->createTextNode(string content )
参数:content,内容;
返回:新的 DOMText 对象,失败为false 。

h、DOMDocument->createCDATASection()
作用:创建cdata节点
用法:DOMDocument->createCDATASection( string data )
参数:data,内容;
返回:新的 DOMCDATASection 对象,失败为false 。

i、DOMDocument->createAttribute()
作用:创建标签属性
用法:DOMDocument->createAttribute(string name)
参数:name,属性名称;
返回:新的 DOMAttr 对象,失败为false 。

j、DOMDocument->validate()
作用:检验xml代码
用法:DOMDocument->validate()
参数:无
返回:如果成功则返回 TRUE,失败则返回 FALSE。

k、DOMDocument->save()
作用:保存xml代码到xml文件
用法:DOMDocument->save(string filename )
参数:filename,xml文件;
返回:成功返回xml字符长度,失败返回false。

l、DOMDocument->saveXML()
作用:保存xml代码
用法:DOMDocument->saveXML( [DOMNode node [, int options]] )
参数:node,DOMNode;
返回:成功返回xml,失败返回false。

m、DOMElement->hasAttribute()
作用:检测属性是否存在
用法:DOMElement->hasAttribute(string name)
参数:name,属性名称;
返回:如果成功则返回 TRUE,失败则返回 FALSE。

n、DOMElement->getAttribute()
作用:获取属性值
用法:DOMElement->getAttribute(string name)
参数:name,属性名称;
返回:成功返回属性值,失败返回空。

o、DOMElement->getAttribute()
作用:获取属性值
用法:DOMElement->getAttribute(string name)
参数:name,属性名称;
返回:成功返回属性值,失败返回空。

p、DOMElement->setAttribute()
作用:设置属性值
用法:DOMElement->setAttribute(string name, string value )
参数:name,属性名称;value,属性值
返回:如果成功则返回 TRUE,失败则返回 FALSE。

q、DOMNode->appendChild()
作用:将子节点链接到父节点上
用法:DOMNode->appendChild(DOMNode newnode )
参数:newnode,新节点;
返回:成功返回新节点,失败返回空。

r、DOMNode->hasAttributes()
作用:检验是否有属性
用法:DOMNode->hasAttributes( )
参数:无
返回:如果成功则返回 TRUE,失败则返回 FALSE。

s、DOMNode->hasChildNodes()
作用:检测是否有子节点
用法:DOMNode->hasChildNodes()
参数:无
返回:如果成功则返回 TRUE,失败则返回 FALSE。

t、DOMNode->insertBefore()
作用:把子节点插入dom树,位置在某节点前
用法:DOMNode->insertBefore(DOMNode newnode [, DOMNode refnode] )
参数:newnode,新node;refnode,参照node
返回:成功返回新node,失败返回空。

u、DOMNode->removeChild()
作用:删除子节点
用法:DOMNode->removeChild(DOMNode oldnode )
参数:oldnode,子节点;
返回:成功返回子节点,失败返回空。

v、DOMNode->replaceChild()
作用:更新子节点
用法:DOMNode->replaceChild(DOMNode newnode, DOMNode oldnode )
参数:newnode,新node;oldnode,老的node
返回:成功返回oldnode,失败返回空。

————————-DOMNode 属性————————————–

a、DOMNode->nodeType
作用:获取节点类型

b、DOMNode->nodeName
作用:获取节点名称

c、DOMNode->nodeValue
作用:获取节点内容

d、DOMNode->textContent
作用:获取节点内容

e、DOMNode->parentNode
作用:获取节点父节点

f、DOMNode->childNodes
作用:获取节点子节点

g、DOMNode->firstChild
作用:获取节点第一个子节点

h、DOMNode->lastChild
作用:获取节点最后一个子节点

2、XMLReader

a、XMLReader::XML
作用:载入 xml 字符串
用法:XMLReader::xml(string source [, string encoding [, int options]] )
参数:source,xml string;encoding,document encoding or NULL
返回:如果成功则返回 TRUE,失败则返回 FALSE。

b、XMLReader::open
作用:载入xml文件
用法:XMLReader::open(string url [, string encoding [, int options]] )
参数:url,连接到xml的链接;encoding,document encoding or NULL
返回:如果成功则返回 TRUE,失败则返回 FALSE。

c、XMLReader::read
作用:读取 xml,使解析器前进到下一个标记
用法:XMLReader::read(),在 while 循环中遍历整个文档
参数:NULL
返回:如果成功则返回 TRUE,失败则返回 FALSE。

d、XMLReader::getAttribute
作用:获取属性
用法:XMLReader::getAttribute(string name)
参数:name,属性名称
返回:如果成功则返回 属性值,失败则返回 FALSE。

e、XMLReader::isValid
作用:检验xml是否合法
用法:XMLReader::isValid()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

f、XMLReader::moveToAttribute
作用:移动焦点到所指的属性上
用法:XMLReader::moveToAttribute(string name)
参数:name,属性名称
返回:如果成功则返回 true,失败则返回 FALSE。

g、XMLReader::moveToFirstAttribute
作用:移动焦点到第一个属性上
用法:XMLReader::moveToFirstAttribute()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

h、XMLReader::moveToNextAttribute
作用:移动焦点到下一个属性上
用法:XMLReader::moveToNextAttribute()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

i、XMLReader::moveToElement
作用:移动焦点到父节点当前属性上
用法:XMLReader::moveToElement()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

j、XMLReader::close
作用:关闭xml输入
用法:XMLReader::close()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

———————-常量————————–

XMLReader::NONE = 0 ;
XMLReader::ELEMENT = 1 ;
XMLReader::ATTRIBUTE = 2 ;
XMLReader::TEXT = 3 ;
XMLReader::CDATA = 4 ;
XMLReader::ENTITY_REF = 5 ;
XMLReader::ENTITY = 6 ;
XMLReader::PI = 7 ;
XMLReader::COMMENT = 8 ;
XMLReader::DOC = 9 ;
XMLReader::DOC_TYPE = 10 ;
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 ;
XMLReader::LOADDTD = 1 ;
XMLReader::DEFAULTATTRS = 2 ;
XMLReader::VALIDATE = 3 ;
XMLReader::SUBST_ENTITIES = 4 ;

————————属性——————————–

a、XMLReader->attributeCount ;
作用:属性数量

b、XMLReader->baseURI ;
作用:节点的url

c、XMLReader->depth ;
作用:节点树的层数

d、XMLReader->hasAttributes ;
作用:检测是否有属性

e、XMLReader->hasValue ;
作用:是否有值

f、XMLReader->isEmptyElement ;
作用:是否是空标签

g、XMLReader->localName ;
作用:标签内部明

h、XMLReader->name ;
作用:标签名

i、XMLReader->nodeType ;
作用:节点类型

j、XMLReader->value ;
作用:节点文本内容

3、XMLWriter

a、XMLWriter::openURI
作用:从url输出代码创建新的XMLWriter
用法:XMLWriter::openURI(string uri )
参数:url xml地址
返回:如果成功则返回 true,失败则返回 FALSE。

b、XMLWriter::setIndentString
作用:设置缩进字符
用法:XMLWriter::setIndentString(string indentString )
参数:indentString 缩进字符
返回:如果成功则返回 true,失败则返回 FALSE。

c、XMLWriter::setIndent
作用:设置缩进开关
用法:XMLWriter::setIndent(bool indent )
参数:indent 缩进与否
返回:如果成功则返回 true,失败则返回 FALSE。

d、XMLWriter::startDocument
作用:设置文档开始标签
用法:XMLWriter::startDocument( [string version [, string encoding [, string standalone]]] )
参数:version,版本;encoding,编码;standalone,独立的
返回:如果成功则返回 true,失败则返回 FALSE。

e、XMLWriter::endDocument
作用:设置文档结束标签
用法:XMLWriter::endDocument( )
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

f、XMLWriter::startDTD
作用:设置dtd开始标签
用法:XMLWriter::startDTD( string qualifiedName [, string publicId [, string systemId]] )
参数:qualifiedName,名称;publicId,piublic;systemId,system
返回:如果成功则返回 true,失败则返回 FALSE。

g、XMLWriter::endDTD
作用:设置dtd结束标签
用法:XMLWriter::endDTD()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

h、XMLWriter::startElement
作用:设置开始标签
用法:XMLWriter::startElement(string name )
参数:name,标签名称
返回:如果成功则返回 true,失败则返回 FALSE。

i、XMLWriter::endElement
作用:设置结束标签
用法:XMLWriter::endElement()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

j、XMLWriter::startCData
作用:设置开始标签
用法:XMLWriter::startCData()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

k、XMLWriter::endCData
作用:设置结束标签
用法:XMLWriter::endCData ()
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

l、XMLWriter::writeAttribute
作用:写标签属性
用法:XMLWriter::writeAttribute (string name, string value )
参数:name,属性名称;value,属性值
返回:如果成功则返回 true,失败则返回 FALSE。

m、XMLWriter::writeElement
作用:写标签属性
用法:XMLWriter::writeElement (resource xmlwriter, string name, string content )
参数:xmlwriter,xml资源;name,标签名称;value,文本值
返回:如果成功则返回 true,失败则返回 FALSE。

n、XMLWriter::writeCData
作用:写标签属性
用法:XMLWriter::writeCData (resource xmlwriter, string content )
参数:xmlwriter,xml资源;value,文本值
返回:如果成功则返回 true,失败则返回 FALSE。

o、XMLWriter::text
作用:写文本
用法:XMLWriter::text (string content )
参数:content,文本值
返回:如果成功则返回 true,失败则返回 FALSE。

p、XMLWriter::flush
作用:清空缓存
用法:XMLWriter::flush ( )
参数:无
返回:如果成功则返回 true,失败则返回 FALSE。

 

 

 

XML处理是开发过程中经常遇到的,PHP对其也有很丰富的支持,本文只是对其中某几种解析技术做简要说明,包括:Xml parser, SimpleXML, XMLReader, DOMDocument。

1。 XML Expat Parser:

XML Parser使用Expat XML解析器。Expat是一种基于事件的解析器,它把XML文档视为一系列事件。当某个事件发生时,它调用一个指定的函数处理它。Expat是无验证的解析器,忽略任何链接到文档的DTD。但是,如果文档的形式不好,则会以一个错误消息结束。由于它基于事件,且无验证,Expat具有快速并适合web应用程序的特性。

XML Parser的优势是性能好,因为它不是将整个xml文档载入内存后再处理,而是边解析边处理。但也正因为如此,它不适合那些要对xml结构做动态调整、或基于xml上下文结构做复杂操作的需求。如果你只是要解析处理一个结构良好的xml文档,那么它可以很好的完成任务。需要注意的是XML Parser只支持三种编码格式:US-ASCII, ISO-8859-1和UTF-8,如果你的xml数据是其他编码,需要先转换成以上三个之一。
XML Parser常用的解析方式大体有两种(其实就是两个函数):xml_parse_into_struct和xml_set_element_handler。


xml_parse_into_struct

此方法是将xml数据解析到两个数组中:
index数组——包含指向Value 数组中值的位置的指针
value数组——包含来自被解析的 XML 的数据

这俩数组文字描述起来有点麻烦,还是看个例子吧(来自php官方文档)

$simple = "<para><note>simple note</note></para>";
$p = xml_parser_create();
xml_parse_into_struct($p, $simple, $vals, $index);
xml_parser_free($p);
echo "Index array\n";
print_r($index);
echo "\nVals array\n";
print_r($vals);

 

输出:

Index array
Array
(
    [PARA] => Array
        (
            [0] => 0
            [1] => 2
        )

    [NOTE] => Array
        (
            [0] => 1
        )
)

Vals array
Array
(
    [0] => Array
        (
            [tag] => PARA
            [type] => open
            [level] => 1
        )

    [1] => Array
        (
            [tag] => NOTE
            [type] => complete
            [level] => 2
            [value] => simple note
        )

    [2] => Array
        (
            [tag] => PARA
            [type] => close
            [level] => 1
        )
)

 

其中index数组以标签名为key,对应的值是一个数组,里面包括所有此标签在value数组中的位置。然后通过这个位置,找到此标签对应的值。

如果xml中每组数据格式有出入,不能做到完全统一,那么在写代码时要注意,说不定就得到了错误的结果。比如下面这个例子:

$xml = '
<infos>
<para><note>note1</note><extra>extra1</extra></para>
<para><note>note2</note></para>
<para><note>note3</note><extra>extra3</extra></para>
</infos>
';

$p = xml_parser_create();
xml_parse_into_struct($p, $xml, $values, $tags);
xml_parser_free($p);
$result = array();
//下面的遍历方式有bug隐患
for ($i=0; $i<3; $i++) {
  $result[$i] = array();
  $result[$i]["note"] = $values[$tags["NOTE"][$i]]["value"];
  $result[$i]["extra"] = $values[$tags["EXTRA"][$i]]["value"];
}
print_r($result);

 

要是按照上面那种方式遍历,看似代码简单,但是暗藏危机,最致命的是得到错误的结果(extra3跑到第二个para里了)。所以要以一种比较严谨的方式遍历:

$result = array();
$paraTagIndexes = $tags['PARA'];
$paraCount = count($paraTagIndexes);
for($i = 0; $i < $paraCount; $i += 2) {
  $para = array();
  //遍历para标签对之间的所有值
  for($j = $paraTagIndexes[$i]; $j < $paraTagIndexes[$i+1]; $j++) {
    $value = $values[$j]['value'];
    if(empty($value)) continue;

    $tagname = strtolower($values[$j]['tag']);
    if(in_array($tagname, array('note','extra'))) {
      $para[$tagname] = $value;
    }
  }
  $result[] = $para;
}

 

其实我很少用xml_parse_into_struct函数,所以上面所谓“严谨”的代码保不齐还会有其他情况下的bug。- -|
xml_set_element_handler

这种方式是为parser设置处理元素起始、元素终止的回调函数。配套的还有xml_set_character_data_handler用来为parser设置数据的回调函数。这种方式写的代码比较清晰,利于维护。

Example:

$xml = <<<XML
<infos>
<para><note>note1</note><extra>extra1</extra></para>
<para><note>note2</note></para>
<para><note>note3</note><extra>extra3</extra></para>
</infos>
XML;

$result = array();
$index = -1;
$currData;

function charactor($parser, $data) {
  global $currData;
  $currData = $data;
}

function startElement($parser, $name, $attribs) {
  global $result, $index;
  $name = strtolower($name);
  if($name == 'para') {
    $index++;
    $result[$index] = array();
  }
}

function endElement($parser, $name) {
  global $result, $index, $currData;
  $name = strtolower($name);
  if($name == 'note' || $name == 'extra') {
    $result[$index][$name] = $currData;
  }
}

$xml_parser = xml_parser_create();
xml_set_character_data_handler($xml_parser, "charactor");
xml_set_element_handler($xml_parser, "startElement", "endElement");
if (!xml_parse($xml_parser, $xml)) {
  echo "Error when parse xml: ";
  echo xml_error_string(xml_get_error_code($xml_parser));
}
xml_parser_free($xml_parser);

print_r($result);

 

可见,set handler方式虽然代码行数多,但思路清晰,可读性更好,不过性能上略慢于第一种方式,而且灵活性不强。XML Parser支持PHP4,适用于于使用老版本的系统。对于PHP5环境,还是优先考虑下面的方法吧。

2。 SimpleXML(较常用)

SimpleXML是PHP5后提供的一套简单易用的xml工具集,可以把xml转换成方便处理的对象,也可以组织生成xml数据。不过它不适用于包含namespace的xml,而且要保证xml格式完整(well-formed)。它提供了三个方法:simplexml_import_dom、simplexml_load_file、simplexml_load_string,函数名很直观地说明了函数的作用。三个函数都返回SimpleXMLElement对象,数据的读取/添加都是通过SimpleXMLElement操作。

$string = <<<XML
<?xml version='1.0'?>
<document>
  <cmd>login</cmd>
  <login>imdonkey</login>
</document>
XML;

$xml = simplexml_load_string($string);
print_r($xml);
$login = $xml->login;//这里返回的依然是个SimpleXMLElement对象
print_r($login);
$login = (string) $xml->login;//在做数据比较时,注意要先强制转换
print_r($login);

 

SimpleXML的优点是开发简单,缺点是它会将整个xml载入内存后再进行处理,所以在解析超多内容的xml文档时可能会力不从心。如果是读取小文件,而且xml中也不包含namespace,那SimpleXML是很好的选择。

 

 

 

3。 XMLReader

XMLReader也是PHP5之后的扩展(5.1后默认安装),它就像游标一样在文档流中移动,并在每个节点处停下来,操作起来很灵活。它提供了对输入的快速和非缓存的流式访问,可以读取流或文档,使用户从中提取数据,并跳过对应用程序没有意义的记录。
以一个利用google天气api获取信息的例子展示下XMLReader的使用,这里也只涉及到一小部分函数,更多还请参考官方文档。

$xml_uri = 'http://www.google.com/ig/api?weather=Beijing&hl=zh-cn';
$current = array();
$forecast = array();

$reader = new XMLReader();
$reader->open($xml_uri, 'gbk');
while ($reader->read()) {
  //get current data
  if ($reader->name == "current_conditions" && $reader->nodeType == XMLReader::ELEMENT) {
    while($reader->read() && $reader->name != "current_conditions") {
      $name = $reader->name;
      $value = $reader->getAttribute('data');
      $current[$name] = $value;
    }
  }

  //get forecast data
  if ($reader->name == "forecast_conditions" && $reader->nodeType == XMLReader::ELEMENT) {
    $sub_forecast = array();
    while($reader->read() && $reader->name != "forecast_conditions") {
      $name = $reader->name;
      $value = $reader->getAttribute('data');
      $sub_forecast[$name] = $value;
    }
    $forecast[] = $sub_forecast;
  }
}
$reader->close();

 

XMLReader和XML Parser类似,都是边读边操作,较大的差异在于SAX模型是一个“推送”模型,其中分析器将事件推到应用程序,在每次读取新节点时通知应用程序,而使用XmlReader的应用程序可以随意从读取器提取节点,可控性更好。
由于XMLReader基于libxml,所以有些函数要参考文档看看是否适用于你的libxml版本。

4。 DOMDocument

DOMDocument还是PHP5后推出的DOM扩展的一部分,可用来建立或解析html/xml,目前只支持utf-8编码。

$xmlstring = <<<XML
<?xml version='1.0'?>
<document>
  <cmd attr='default'>login</cmd>
  <login>imdonkey</login>
</document>
XML;

$dom = new DOMDocument();
$dom->loadXML($xmlstring);
print_r(getArray($dom->documentElement));

function getArray($node) {
  $array = false;

  if ($node->hasAttributes()) {
    foreach ($node->attributes as $attr) {
      $array[$attr->nodeName] = $attr->nodeValue;
    }
  }

  if ($node->hasChildNodes()) {
    if ($node->childNodes->length == 1) {
      $array[$node->firstChild->nodeName] = getArray($node->firstChild);
    } else {
      foreach ($node->childNodes as $childNode) {
      if ($childNode->nodeType != XML_TEXT_NODE) {
        $array[$childNode->nodeName][] = getArray($childNode);
      }
    }
  }
  } else {
    return $node->nodeValue;
  }
  return $array;
}

 

从函数名上看感觉跟JavaScript很像,应该是借鉴了一些吧。DOMDocument也是一次性将xml载入内存,所以内存问题同样需要注意。PHP提供了这么多的xml处理方式,开发人员在选择上就要花些时间了解,选择适合项目需求及系统环境、又便于维护的方法。

posted @ 2013-12-21 17:16  丶葡萄  阅读(540)  评论(0编辑  收藏  举报