Chilkat.Xml PHP Reference
Chilkat.Xml
A free non-validating XML parser component with encryption and compression features.
Object Creation
$obj = new COM("Chilkat.Xml");
Properties
bool Cdata
When True, causes an XML node's content to be encapsulated in a CDATA section.
string Content
This is the content of the XML node. It is the text between the open and close tags, such as:This is the content Content vs. Children: A common misconception explained.
int ContentInt
Set/get the content as an integer.
string DocType
To be documented soon...
string Encoding
This is the encoding attribute in the XML declaration, such as "utf-8" or "iso-8859-1". If not present, this property returns an empty string. This property can be set from any node in the XML document and when set, causes the encoding property to be added to the XML declaration. Setting this property does not cause the document to be converted to a different encoding.
string LastErrorHtml (read-only)
To be documented soon.Error information in HTML format for the last method called.
string LastErrorText (read-only)
To be documented soon.Error information in plain-text format for the last method called.
string LastErrorXml (read-only)
To be documented soon.Error information in XML format for the last method called.
int NumAttributes (read-only)
The number of attributes. For example, the following node has 2 attributes: This is the content
int NumChildren (read-only)
The number of child nodes contained under this XML node.
bool SortCaseInsensitive
If true (or 1 for ActiveX), then all Sort* methods use case insensitive sorting.
bool Standalone
This is the standalone attribute in the XML declaration. This property can be set from any node in the XML document. A value of true adds a standalone="yes" to the XML declaration:
<?xml ... standalone="yes">
string Tag
The XML node's tag.
int TreeId (read-only)
Each tree (or XML document) has a unique TreeId. This is the ID of the tree, and can be used to determine if two Xml objects belong to the same tree.
string Version (read-only)
The version of the XML component, such as "2.0.0".
Methods
string AccumulateTagContent(string tag, string skipTags)
Accumulates the content of all nodes having a specific tag into a single result string. SkipTags specifies a set of tags whose are to be avoided. The skipTags are formatted as a string of tags delimited by vertical bar characters. All nodes in sub-trees rooted with a tag appearing in skipTags are not included in the result. Returns a null on failure
bool AddAttribute(string name, string value)
Adds an attribute to the calling node in the XML document. Returns True for success, and False for failure.
int AddAttributeInt(string name, int value)
Adds an integer attribute to a node.
bool AddChildTree(Chilkat.Xml tree)
Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another.
void AddOrUpdateAttribute(string name, string value)
Adds an attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
void AddOrUpdateAttributeI(string name, int value)
Adds an integer attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
void AddStyleSheet(string styleSheet)
Adds a style sheet declaration to the XML document. The styleSheet should be a string such as:
<?xml-stylesheet href="mystyle.css" title="Compact" type="text/css"?>
void AddToAttribute(string name, int amount)
Adds an integer amount to an integer attribute's value. If the attribute does not yet exist, this method behaves the same as AddOrUpdateAttributeI.
void AddToChildContent(string tag, int amount)
Adds an integer value to the content of a child node.
void AddToContent(int amount)
Adds an integer amount to the node's content.
bool AppendToContent(string str)
Appends text to the content of an XML node
bool BEncodeContent(string charset, VARIANT inData)
Sets the node's content with 8bit data that is in a specified multibyte character encoding such as utf-8, shift-jis, big5, etc. The data is first B-encoded and the content is set to be the B-encoded string. For example, if called with "Big5"for the charset, you would get a string that looks something like this: "=?Big5?B?pHCtsw==?=". The data is Base64-encoded and stored between the last pair of "?" delimiters. Use the DecodeContent method to retrieve the byte data from a B encoded string.
bool ChildContentMatches(string tag, string pattern, int caseSensitive)
Return true if a child having a specific tag contains content that matches a wildcarded pattern.
string ChilkatPath(string pathCmd)
Follows a series of commands to navigate through an XML document to return a piece of data or update the caller's reference to a new XML document node.
Note: This method not related to the XPath (XML Path) standard in any way.
The pathCmd is formatted as a series of commands separated by vertical bar characters, and terminated with a return-command:
command|command|command|...|returnCommand
A command can be any of the following:
- TagName -- Navigate to the 1st direct child with the given tag.
- TagName[n] -- Navigate to the Nth direct child with the given tag.
- .. -- Navigate up to the parent
- TagName{Content} -- Navigate to the 1st direct child with the given tag having the exact content.
- /T/TagName -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag.
- /C/TagName,ContentPattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag with content that matches the ContentPattern. ContentPattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
- /C/ContentPattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having any tag with content that matches the ContentPattern. ContentPattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
The returnCommand can be any of the following:
- * -- Return the Content of the node.
- (AttrName) -- Return the value of the given attribute.
- $ -- Update the caller's internal reference to be the node (arrived at by following the series of commands). Returns an empty string.
Returns a null on failure
void Clear()
Removes all children, attributes, and content from the XML node. Resets the tag name to "unnamed".
bool CompressNode()
Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.
bool CompressSubtree()
Zip compresses the content and entire subtree rooted at the calling XML node and replaces the current content with base64-encoded Zip compressed data. The node and subtree can be restored by calling UnzipTree. Note that the node name and attributes are unaffected.
bool ContentMatches(string pattern, int caseSensitive)
Return true if the node's content matches a wildcarded pattern.
void Copy(Chilkat.Xml node)
Copies the tag, content, and attributes to the calling node.
VARIANT DecodeContent()
Decodes a node's Q or B-encoded content string and returns the byte data. Returns 1 for success, 0 for failure.
string DecodeEntities(string str)
Utility method to decode HTML entities. It accepts a string containing (potentially) HTML entities and returns a string with the entities decoded. Returns a null on failure
bool DecompressNode()
Unzip the content of the XML node replacing it's content with the decompressed data.
bool DecompressSubtree()
Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.
bool DecryptContent(string password)
Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.
bool DecryptNode(string password)
Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.
bool EncryptContent(string password)
AES encrypts the content of the calling XML node using 128-bit Rijndael encryption.
bool EncryptNode(string password)
AES encrypts the content of the calling XML node using 128-bit Rijndael encryption.
Chilkat.Xml ExtractChildByIndex(int index)
Removes and returns the Nth child of an XML node. The first child is at index 0.
Chilkat.Xml ExtractChildByName(string tag, string attrName, string attrValue)
Removes and returns the first child node having a tag equal to the tagName. The attributeName and attrValue may be empty or NULL, in which case the first child matching the tag is removed and returned. If attributeName is specified, then the first child having a tag equal to tagName, and an attribute with attributeName is returned. If attrValue is also specified, then only a child having a tag equal to tagName, and an attribute named attributeName, with a value equal to attrValue is returned.
Chilkat.Xml FindChild(string tag)
Returns the child having a specified tag.
bool FindChild2(string tag)
Updates the Xml object's internal reference to point to a child with a specified tag.
Chilkat.Xml FindNextRecord(string tag, string contentPattern)
Returns the next record node where the child with a specific tag matches a wildcarded pattern. This method makes it easy to iterate over high-level records.
Chilkat.Xml FindOrAddNewChild(string tag)
First searches for a child having a tag equal to tagName, and if found, returns it. Otherwise creates a new child, sets the tag equal to tagName, and initializes the Content to empty.
Chilkat.Xml FirstChild()
Returns the first child. A program can step through the children by calling FirstChild, and then NextSibling repeatedly.
bool FirstChild2()
Updates the internal reference of the caller to point to its first child. More information about XML methods ending in "2"
string GetAttrValue(string name)
Find and return the value of an attribute having a specified name. Returns a null on failure
int GetAttrValueInt(string name)
Returns an attribute as an integer.
string GetAttributeName(int index)
Returns the name of the Nth attribute of an XML node. The first attribute is at index 0. Returns a null on failure
string GetAttributeValue(int index)
Returns the value of the Nth attribute of an XML node. The first attribute is at index 0. Returns a null on failure
int GetAttributeValueInt(int index)
Returns an attribute as an integer.
VARIANT GetBinaryContent(int unzipFlag, int decryptFlag, string password)
Returns binary content of an XML node as a byte array. The content may have been Zip compressed, AES encrypted, or both. Unzip compression and AES decryption flags should be set appropriately. Returns 1 for success, 0 for failure.
Chilkat.Xml GetChild(int index)
Returns the Nth child of an XML node
bool GetChild2(int index)
Updates the calling object's internal reference to the Nth child node. Returns 1 for success, 0 for failure. More information about XML methods ending in "2"
bool GetChildBoolValue(string tag)
Returns false if the node's content is "0", otherwise returns true if the node contains a non-zero integer.
string GetChildContent(string tag)
Returns the content of a child having a specified tag. Returns a null on failure
string GetChildContentByIndex(int index)
Returns the content of the Nth child node. Returns a null on failure
Chilkat.Xml GetChildExact(string tag, string content)
Returns the child having the exact tag and content.
int GetChildIntValue(string tag)
Returns the child integer content for a given tag.
string GetChildTag(int index)
Returns the tag name of the Nth child node. Returns a null on failure
string GetChildTagByIndex(int index)
Returns the tag name of the Nth child node. Returns a null on failure
Chilkat.Xml GetChildWithTag(string tag)
Returns the Xml child object having a tag matching tagName.
Chilkat.Xml GetNthChildWithTag(string tag, int n)
Returns the Nth child having a tag that matches exactly with the tagName. Use the NumChildrenHavingTag method to determine how many children have a particular tag.
bool GetNthChildWithTag2(string tag, int n)
Updates the calling object's internal reference to the Nth child node having a specific tag. Returns 1 for success, 0 for failure.
Chilkat.Xml GetParent()
Returns the parent of this XML node, or NULL if the node is the root of the tree.
bool GetParent2()
Updates the internal reference of the caller to its parent. More information about XML methods ending in "2"
Chilkat.Xml GetRoot()
Returns the root node of the XML document
void GetRoot2()
Updates the internal reference of the caller to the document root. More information about XML methods ending in "2"
Chilkat.Xml GetSelf()
To be documented soon...
string GetXml()
Generate the XML text document for the XML tree rooted at this node. Returns a null on failure
bool HasAttrWithValue(string name, string value)
Returns true if the node contains attribute with the name and value.
bool HasAttribute(string name)
Returns true if the node contains an attribute with the specified name.
bool HasChildWithContent(string content)
Returns true if the node has a child node containing the exact content string specified.
bool HasChildWithTag(string tag)
Returns true (1 for ActiveX) if the node has a child with a given tag.
bool HasChildWithTagAndContent(string tag, string content)
Returns true if the node contains a child having the exact tag and content specified.
Chilkat.Xml HttpGet(string url)
Gets an XML document from a URL. This can be tested with the following URL: http://www.chilkatsoft.com/test.xml
Chilkat.Xml HttpPost(string url)
Provides client-side protocol support for communication with HTTP servers. A client can use this method to send an arbitrary HTTP request, receive the response, and have Chilkat XML.NET parse that response.The request body is sent directly from the Chilkat XML object and the response is parsed directly into the returned Chilkat XML object. When combined with the support for Extensible Stylesheet Language (XSL), this provides an easy way to send structured queries to HTTP servers and efficiently display the results with a variety of presentations.
void InsertChildTreeAfter(int index, Chilkat.Xml tree)
Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another. The child tree is inserted in a position after the Nth child (of the calling node).
void InsertChildTreeBefore(int index, Chilkat.Xml tree)
Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another. The child tree is inserted in a position before the Nth child (of the calling node).
Chilkat.Xml LastChild()
Returns the last Xml child node. A node's children can be enumerated by calling LastChild and then repeatedly calling PreviousSibling, until a NULL is returned.
bool LastChild2()
Updates the internal reference of the caller to its last child.
bool LoadXml(string xmlData)
Loads an XML document from a memory buffer and returns True if successful. The contents of the calling node are replaced with the root node of the XML document loaded.
bool LoadXml2(string xmlData, int autoTrim)
Same as LoadXml, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content. Returns 1 for success, 0 for failure.
bool LoadXmlFile(string fileName)
Loads an XML document from a file and returns True if successful. The contents of the calling node are replaced with the root node of the XML document loaded.
bool LoadXmlFile2(string fileName, int autoTrim)
Same as LoadXmlFile, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content. Returns 1 for success, 0 for failure.
bool LoadXmlV(VARIANT xmlDoc)
Loads XML from a byte array containing the XML document.
Chilkat.Xml NewChild(string tag, string content)
Creates a new child having tag and content. The new child is created even if a child with a tag equal to tagName already exists. (Use FindOrAddNewChild to prevent creating children having the same tags.)
void NewChild2(string tag, string content)
Creates a new child but does not return the node that is created.
Chilkat.Xml NewChildAfter(int index, string tag, string content)
Inserts a new child in a position after the Nth child node.
Chilkat.Xml NewChildBefore(int index, string tag, string content)
Inserts a new child in a position before the Nth child node.
void NewChildInt2(string tag, int value)
Inserts a new child having an integer for content.
Chilkat.Xml NextSibling()
Returns the nodes next sibling, or NULL if there are no more.
bool NextSibling2()
Updates the internal reference of the caller to its next sibling. More information about XML methods ending in "2"
int NumChildrenHavingTag(string tag)
Returns the number of children having a specific tag name.
Chilkat.Xml PreviousSibling()
Returns the Xml object that is the node's previous sibling, or NULL if there are no more.
bool PreviousSibling2()
Updates the internal reference of the caller to its previous sibling. More information about XML methods ending in "2"
bool QEncodeContent(string charset, VARIANT inData)
Sets the node's content with 8bit data that is in a specified multibyte character encoding such as utf-8, shift-jis, big5, etc. The data is first Q-encoded and the content is set to be the Q-encoded string. For example, if called with "gb2312"for the charset, you would get a string that looks something like this: "=?gb2312?Q?=C5=B5=BB=F9?=". Character that are not 7bit are represented as "=XX" where XX is the hexidecimal value of the byte. Use the DecodeContent method to retrieve the byte data from a Q encoded string.
bool RemoveAllAttributes()
Removes all attributes from an XML node. Should always return True.
void RemoveAllChildren()
Removes all children from the calling node.
bool RemoveAttribute(string name)
Removes an attribute by name from and XML node.
void RemoveChild(string tag)
Removes a child with a given tag.
void RemoveChildByIndex(int index)
Removes the Nth child from the calling node.
void RemoveChildWithContent(string content)
Removes all children having the exact content specified.
void RemoveFromTree()
Removes the calling object and its sub-tree from the XML document making it the root of its own tree.
bool SaveBinaryContent(string filename, int unzipFlag, int decryptFlag, string password)
Saves a node's binary content to a file.
bool SaveLastError(string filename)
Saves the last error information to an XML formatted file.
bool SaveXml(string fileName)
Generates XML representing the tree or subtree rooted at this node and writes it to a file.
Chilkat.Xml SearchAllForContent(Chilkat.Xml after, string contentPattern)
Returns the first node whose content matches the contentPattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
bool SearchAllForContent2(Chilkat.Xml after, string contentPattern)
Same as SearchAllForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
Chilkat.Xml SearchForAttribute(Chilkat.Xml after, string tag, string attr, string valuePattern)
Returns the first node having a tag equal to tagName, and an attribute named attrName whose value matches valuePattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
bool SearchForAttribute2(Chilkat.Xml after, string tag, string attr, string valuePattern)
Same as SearchForAttribute except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
Chilkat.Xml SearchForContent(Chilkat.Xml after, string tag, string contentPattern)
Returns the first node having a tag equal to tagName whose content matches contentPattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
bool SearchForContent2(Chilkat.Xml after, string tag, string contentPattern)
Same as SearchForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
Chilkat.Xml SearchForTag(Chilkat.Xml after, string tag)
Returns the first node having a tag equal to tagName. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
bool SearchForTag2(Chilkat.Xml after, string tag)
Same as SearchForTag except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
bool SetBinaryContent(VARIANT inData, int zipFlag, int encryptFlag, string password)
Sets the node's content to a block of binary data with optional Zip compression and/or AES encryption. The binary data is automatically converted to base64 format whenever XML text is generated. If the zipFlag is True, the data is first compressed. If the encryptFlag is True, the data is AES encrypted using the Rijndael 128-bit symmetric-encryption algorithm.
bool SetBinaryContentFromFile(string filename, int zipFlag, int encryptFlag, string password)
Sets the node's content with binary (or text) data from a file. The file contents can be Zip compressed and/or encrypted, and the result is base-64 encoded.
void SortByAttribute(string attrName, int ascending)
Sorts the child nodes by the value of a specified attribute.
void SortByAttributeInt(string attrName, int ascending)
Sorts the child nodes by the value of a specified attribute interpreted as an integer (not lexicographically as strings).
void SortByContent(int ascending)
Sorts the child nodes by content.
void SortByTag(int ascending)
Sorts the child nodes by tag.
void SortRecordsByAttribute(string sortTag, string attrName, int ascending)
Sorts the child nodes by the content of an attribute in the grandchild nodes.
void SortRecordsByContent(string sortTag, int ascending)
Sorts the child nodes by the content of the grandchild nodes.
void SortRecordsByContentInt(string sortTag, int ascending)
To be documented soon...
bool SwapNode(Chilkat.Xml node)
Swaps another node's tag, content, and attributes with this one.
bool SwapTree(Chilkat.Xml tree)
Swaps another node's tag, content, attributes, and children with this one.
string TagContent(string tag)
To be documented soon...
bool TagEquals(string tag)
Returns true if the node's tag equals the specified string.
bool UnzipContent()
Unzip the content of the XML node replacing it's content with the decompressed data.
bool UnzipTree()
Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.
bool UpdateAttribute(string attrName, string attrValue)
Adds an attribute to the node if it doesn't already exist. Otherwise it updates the existing attribute with the new value.
bool UpdateAttributeInt(string attrName, int value)
Updates an attribute value. (Call UpdateAttribute if the attribute value is a string.)
void UpdateChildContent(string tag, string value)
Replaces the content of a child node.
void UpdateChildContentInt(string tag, int value)
Replaces the content of a child node where the content is an integer.
bool ZipContent()
Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.
bool ZipTree()
Zip compresses the content and entire subtree rooted at the calling XML node and replaces the current content with base64-encoded Zip compressed data. The node and subtree can be restored by calling UnzipTree. Note that the node name and attributes are unaffected.
|