Class \Prado\Xml\TXmlDocument

TXmlDocument class.

TXmlDocument represents a DOM representation of an XML file. Besides all properties and methods inherited from TXmlElement, you can load an XML file or string by loadFromFile or loadFromString. You can also get the version and encoding of the XML document by the Version and Encoding properties.

To construct an XML string, you may do the following:

$doc=new TXmlDocument('1.0','utf-8');
$doc->TagName='Root';

$proc=new TXmlElement('Proc');
$proc->setAttribute('Name','xxxx');
$doc->Elements[]=$proc;

$query=new TXmlElement('Query');
$query->setAttribute('ID','xxxx');
$proc->Elements[]=$query;

$attr=new TXmlElement('Attr');
$attr->setAttribute('Name','aaa');
$attr->Value='1';
$query->Elements[]=$attr;

$attr=new TXmlElement('Attr');
$attr->setAttribute('Name','bbb');
$attr->Value='1';
$query->Elements[]=$attr;

The above code represents the following XML string:

<?xml version="1.0" encoding="utf-8"?>
<Root>
  <Proc Name="xxxx">
    <Query ID="xxxx">
      <Attr Name="aaa">1</Attr>
      <Attr Name="bbb">1</Attr>
    </Query>
  </Proc>
</Root>

Class hierarchy

\Prado\Xml\TXmlDocument

\Prado\Xml\TXmlElement

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct([string $version = '1.0' ][, string $encoding = '' ]) : mixed` Constructor.
`public`	`__toString() : string` Magic-method override. Called whenever this document is used as a string. `$document = new TXmlDocument(); $document->TagName = 'root'; echo $document;` or `$document = new TXmlDocument(); $document->TagName = 'root'; $xml = (string)$document;`
`public`	`getEncoding() : string`
`public`	`getVersion() : string`
`public`	`loadFromFile(string $file) : bool` Loads and parses an XML document.
`public`	`loadFromString(string $string) : bool` Loads and parses an XML string. The version and encoding will be determined based on the parsing result.
`public`	`saveToFile(string $file) : mixed` Saves this XML document as an XML file.
`public`	`saveToString() : string` Saves this XML document as an XML string
`public`	`setEncoding(string $encoding) : mixed`
`public`	`setVersion(string $version) : mixed`
`protected`	`buildElement(DOMElement $node) : TXmlElement` Recursively converts DOM XML nodes into TXmlElement

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __toString, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAttribute, getAttributes, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getElementByTagName, getElements, getElementsByTagName, getEventHandlers, getHasAttribute, getHasElement, getListeningToGlobalEvents, getParent, getSubProperty, getTagName, getValue, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setAttribute, setParent, setSubProperty, setTagName, setValue, toString, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx, xmlEncode

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Xml\TXmlDocument

Class hierarchy