xml_ClassxmlElementNode_Class 类使用说明

Posted 2021-01-31 wm218

xml_Class、xmlElementNode_Class这两个类是针对XML相关操作的类。

1、xml_Class类是针对XML文档操作的类

目录：

类型	原型	参数	返回	说明
Sub	Sub [obj].init(byVal param)	param [DOMDocument | XMLString | filePath] 参数类型可以是：DOMDocument实例、xml结构的字符串、XML文件的相对路径	-	初始化实例（可以使用DOMDocument实例 或者 xml结构的字符串 或者 XML文件的相对路径初始化类实例） 初始化出错时，输出错误！ 该过程整合了loadFile、loadXML、loadDocument三种过程。
Sub	Sub [obj].loadFile(byVal filePath)	filePath [String] XML文件的相对路径	-	用XML文件初始化类对象。初始化出错时，输出错误！
Sub	Sub [obj].loadXml(byVal xmlString)	xmlString [String] XML格式字符串(必须含有根节点)	-	用XML字符串初始化类对象。初始化出错时，输出错误！
Sub	Sub [obj].loadDocument(byVal DOMDocument)	DOMDocument [DOMDocument] XML的原生态文档对象	-	用DOMDocument实例初始化类对象。初始化出错时，输出错误！
属性	[obj].format = [True | False]	-	-	保存文件时是否格式化当前XML字符样式，默认值false
属性	Get [obj].xmlDoc	-	[DOMDocument]	获取实例的DOMDocument对象
属性	Get [obj].root	-	[xmlElementNode]	获取当前文档根节点的xmlElementNode实例
属性	Get [obj].getNode(byVal xPath)	-	[xmlElementNode | Nothing]	获取xPath匹配的第一个元素的xmlElementNode实例
属性	Get [obj].getNodes(byVal xPath)	-	[Array( xmlElementNode, xmlElementNode, ... )]	获取xPath匹配的所有元素的xmlElementNode实例数组
属性	Get item(byVal level, byVal index)	-	[xmlElementNode | Nothing]	获取指定级别、索引值的元素的xmlElementNode实例
方法	Function createNode(byVal nodeName, byVal nodeValue)	nodeName [String] 节点元素名称 nodeValue [String] 节点元素内容	[IXMLDOMElement] XML原生态节点元素实例	创建一个元素节点对象（此时并没有插入到类实例中,返回的对象供原生态的xml操作需要，这里做扩展）
方法	Function createCDATA(byVal text)	text [String] CDATA内容	[IXMLDOMCDATASection] XML原生态CDATA元素实例	创建一个CDATA节点对象（此时并没有插入到类实例中,返回的对象供原生态的xml操作需要，这里做扩展）
方法	Function createComment(byVal text)	text [String] 注释文本	[IXMLDOMComment] XML原生态注释元素实例	创建一个注释节点对象（此时并没有插入到类实例中,返回的对象供原生态的xml操作需要，这里做扩展）
方法	Function createAttr(byVal attrName, byVal attrValue)	attrName [String] 属性名 attrValue [String] 属性值	[IXMLDOMAttribute] XML原生态属性元素实例	创建一个属性对象（此时并没有插入到类实例中,返回的对象供原生态的xml操作需要，这里做扩展）
方法	Function checkXML(byVal xmlString)	xmlString [String] 待检测字符串	[Array] Array(0) [True | False] 检测结果 Array(1) [Empty | 错误描述]	检查字符串是否符合XML格式（必须含有根节点，注意含有&字符是不符合XML格式）
方法	Function checkXMLString(byVal xmlString)	xmlString [String] 待检测字符串	[Array] Array(0) [True | False] 检测结果 Array(1) [Empty | 错误描述]	检查字符串是否符合XML字符串格式（可以不包含有根节点的XML字符串，注意含有&字符是不符合XML格式）
过程	Sub save(byVal path)	path [String] 相对路径	-	将当前xml文档保存成文件

 

2、xmlElementNode_Class类是针对XML节点操作的类

目录:

类型	原型	参数	返回	说明
属性	[obj].format = [True | False]	-	-	保存节点或者输出XML字符串时，是否格式化XML样式
属性	Get [obj].node	-	[IXMLDOMElement]	获取当前节点的XML原生态实例
属性	Get [obj].xmlDoc	-	[IXMLDOMElement]	获取当前节点的XML原生态文档对象实例
属性	Get xmlClass()	-	[xml_Class]	获取当前节点所在文档的xml_Class实例
属性	Get name()	-	[String]	获取当前节点名称
属性	Get root()	-	[xmlElementNode]	获取节点所在文档的根元素的xmlElementNode实例
属性	Get parent()	-	[xmlElementNode | Nothing]	获取节点的父节点的xmlElementNode实例
属性	Get index()	-	[Number]	获取此节点在同胞节点中的索引值,值是>=0的整数
属性	Get level()	-	[Number]	获取此节点在xml树的所在级别值,值是>=1的整数
属性	Get xml()	-	[String]	获取节点的所有字符内容（节点名称+子节点）
属性	Get html()	-	[String]	返回节点内容（不包含节点本身）
属性	Get cdata()	-	[String | Empty]	返回节点第一个CDATA内容
属性	Get text()	-	[String]	返回节点去掉HTML标记的内容
属性	Get childNodeNums(byVal nodeTypeValue)	nodeTypeValue [Number] 节点类型 nodeTypeValue = 0 所有子节点数量 nodeTypeValue = 1 元素子节点数量 nodeTypeValue = 3 文本子节点数量 nodeTypeValue = 4 CDATA子节点数量 nodeTypeValue = 8 注释子节点数量	[Number] >=0的整数	返回当前节点下指定类型的子节点数量（第一级子节点，不含子节点的子节点）
属性	Get clone(byVal includeChind)	includeChind [True | False] 值true表示克隆时包含子节点	[xmlElementNode]	克隆当前节点
属性	Get attrNums()	-	[Number] >=0的整数	返回当前节点的属性数量
属性	Get attr(byVal attrName)	-	[String | Empty]	获取节点属性值
属性	Get arrAttr()	-	[Array( Array(attrName, attrValue), Array(attrName, attrValue) ... )]	获取当前节点的属性数组
属性	Get sibling(byval index)	index [Number] 兄弟节点所在序号值 index = 0 表示获取第一个兄弟节点 index = -1 表示获取最后一个兄弟节点	[xmlElementNode | Nothing]	获取当前节点的兄弟节点（只针对元素节点）
属性	Get preNode()	-	[xmlElementNode | Nothing]	获取当前节点的前一个节点实例
属性	Get nextNode()	-	[xmlElementNode | Nothing]	获取当前节点的后一个节点实例
属性	Get getNode(byVal xPath)	xPath [String]	[xmlElementNode | Nothing]	获取当前节点下xPath匹配的第一个元素
属性	Get getNodes(byVal xPath)	xPath [String]	Array(xmlElementNode, xmlElementNode, xmlElementNode, ...)	获取当前节点下xPath匹配的所有元素
属性	Get getChilds()	-	Array(xmlElementNode, xmlElementNode, xmlElementNode, ...)	获取当前实例下第一级元素子节点实例
属性	Get toJson(byVal method)	method [0|1]   method = 0 表示仅将节点值转换成JSON实例 method = 1 表示包括节点一起转换成JSON实例	[JSON]	将当前节点转换成json格式数据
属性	Get toJsonString(byVal method)	method [0|1]   method = 0 表示转换成字符串时不包含根节点信息 method = 1 表示连同根节点信息一并转换成字符串	[String]	将当前节点转换成json字符串 1、属性转换采用:  "@attrName" = "attrVaule" 2、混合XML结构时，文本转换采用: "#text" = "text"，比如： <sample long="100">1234</sample> 转换结果：{ "sample":{ "@long" : 100, "#text" : 1234 }} 3、忽略注释节点，将文本节点与CDATA合并，用 分隔，比如： <sample><title>123456<!--这是一个注释-->abc</title></sample> 转换结果： { "sample":{ "title" : "123456 abc" } } 4、同名元素（不区分大小写）子节点，转换成数组，键名强制变成小写，比如： <dl><dd>星期一</dd><dd>星期二</dd><dd>星期三</dd></dl> 转换结果： { "dl" : { "dd" : ["星期一", "星期二", "星期三"] } }