Xml
Extends \Joomla\Registry\AbstractRegistryFormatXML format handler for Registry.
| since |
1.0 |
|---|
Methods
getInstance
Returns a reference to a Format object, only creating it if it doesn't already exist.
getInstance(string $type, array $options = array()) : \Joomla\Registry\AbstractRegistryFormat
| deprecated |
2.0 Use Factory::getFormat() instead |
|---|---|
| since |
1.0 |
| throws |
|
Arguments
- $type
stringThe format to load- $options
arrayAdditional options to configure the object
Response
\Joomla\Registry\AbstractRegistryFormatRegistry format handler
getValueFromNode
Method to get a PHP native value for a SimpleXMLElement object. -- called recursively
getValueFromNode(object $node) : mixed
| since |
1.0 |
|---|
Arguments
- $node
objectSimpleXMLElement object for which to get the native value.
Response
mixedNative value of the SimpleXMLElement object.
getXmlChildren
Method to build a level of the XML string -- called recursively
getXmlChildren(\SimpleXMLElement $node, object $var, string $nodeName) : void
| since |
1.0 |
|---|
Arguments
- $node
\SimpleXMLElementSimpleXMLElement object to attach children.- $var
objectObject that represents a node of the XML document.- $nodeName
stringThe name to use for node elements.
objectToString
Converts an object into an XML formatted string.
objectToString(object $object, array $options = array()) : string
- If more than two levels of nested groups are necessary, since INI is not useful, XML or another format should be used.
| since |
1.0 |
|---|
Arguments
- $object
objectData source object.- $options
arrayOptions used by the formatter.
Response
stringXML formatted string.
stringToObject
Parse a XML formatted string and convert it into an object.
stringToObject(string $data, array $options = array()) : object
| since |
1.0 |
|---|
Arguments
- $data
stringXML formatted string to convert.- $options
arrayOptions used by the formatter.
Response
objectData object.
Properties
instances
Format instances container.
| since |
1.0 |
|---|---|
| deprecated |
2.0 Object caching will no longer be supported |
Type(s)
array<mixed,\Joomla\Registry\AbstractRegistryFormat>