Class JRegistryFormatXML

Description

XML format handler for JRegistry.

  • since: 11.1

Located in /libraries/joomla/registry/format/xml.php (line 19)

JRegistryFormat
   |
   --JRegistryFormatXML
Method Summary
 mixed getValueFromNode (object $node)
 void getXmlChildren (SimpleXMLElement $node, object $var, string $nodeName)
 string objectToString (object $object, [array $options = array()])
 object Data stringToObject (string $data, [array $options = array()])
Variables

Inherited Variables

Inherited from JRegistryFormat

JRegistryFormat::$instances
Methods
getValueFromNode (line 81)

Method to get a PHP native value for a SimpleXMLElement object. -- called recursively

  • return: Native value of the SimpleXMLElement object.
  • since: 11.1
  • access: protected
mixed getValueFromNode (object $node)
  • object $node: SimpleXMLElement object for which to get the native value.
getXmlChildren (line 135)

Method to build a level of the XML string -- called recursively

  • since: 11.1
  • access: protected
void getXmlChildren (SimpleXMLElement $node, object $var, string $nodeName)
  • SimpleXMLElement $node: SimpleXMLElement object to attach children.
  • object $var: Object that represents a node of the XML document.
  • string $nodeName: The name to use for node elements.
objectToString (line 33)

Converts an object into an XML formatted string.

- If more than two levels of nested groups are necessary, since INI is not useful, XML or another format should be used.

  • return: XML formatted string.
  • since: 11.1
  • access: public
string objectToString (object $object, [array $options = array()])
  • object $object: Data source object.
  • array $options: Options used by the formatter.

Redefinition of:
JRegistryFormat::objectToString()
Converts an object into a formatted string.
stringToObject (line 57)

Parse a XML formatted string and convert it into an object.

  • return: object.
  • since: 11.1
  • access: public
object Data stringToObject (string $data, [array $options = array()])
  • string $data: XML formatted string to convert.
  • array $options: Options used by the formatter.

Redefinition of:
JRegistryFormat::stringToObject()
Converts a formatted string into an object.

Inherited Methods

Inherited From JRegistryFormat

 JRegistryFormat::getInstance()
 JRegistryFormat::objectToString()
 JRegistryFormat::stringToObject()

Documentation generated on Tue, 19 Nov 2013 15:18:36 +0100 by phpDocumentor 1.4.3