PHP Editor Review - Pear Manual Package xml xml-serializer xml-unserializer options

PEAR Manual

Introduction to options

Options let you influence, how XML_Unserializer treats the parsed XML. It allows you to define, whether attributes should be parsed, whether to use associative arrays or objects for complex data types and more.

Options can be passed as an associative array to the constructor of XML_Unserializer. You may also use setOption(), or setOptions() to set one or more options after the instance of XML_Unserializer has been created.

Option

Possible values

Default

Description

complexType

'array' or 'object'

'array'

Defines, whether nested tags should be returned as associative arrays or objects

tagAsClass

TRUE or FALSE

TRUE

Defines, whether the tag name should be used as the class name if complexType is set to 'object'. If no class with the name of the tag exists, that class defined by 'defaultClass' is used.

defaultClass

any string

stdClass

Defines the class that is used to create objects, if the complexType option is set to 'object'.

keyAttribute

any string or array

'_originalKey'

If the attribute specified in this option exists for a tag, the value will be used as key or property name in the parent object or array. You may also specify an associative array if you want to use differnt key attributes for different tags. In this case, the array key contains the tag name and the array vallue the corresponding attribute name.

typeAttribute

any string

'_type'

If this attribute exists for a tag, the tag content will be converted to the specified type. Possible types are: string, integer, float, boolean, array and object

classAttribute

any string

'_class'

If XML_Unserializer creates an object, it will be an instance of the value specified with the defaultClass option, unless the tag has the attribute specified in this option. If it is set, the classname stored in the attribute value will be used.

parseAttributes

TRUE or FALSE

FALSE

With this option, you may tell XML_Unserializer to also parse the attributes of the tags. The next two options define how to treat the parsed attributes.

attributesArray

FALSE or any string

FALSE

If set to false, the attributes will be treated like nested tags. If you set it to a string, a new aray will be created and stored in the parent structure using key you specified in this option

prependAttributes

any string

Allows you to specify a prefix for attribute names.

contentName

any string

'_content'

If you decide to parse attributes or a tag contains cdata and tags, then the cdata will be stored in the index specified here.

tagMap

associative array

array()

This allows you to map tag names to PHP classes. The names of the tags have to be in the keys and the values contain the class names to use for each tag.

forceEnum

indexed array

array()

This allows you to specify a list of tags which will automatically be converted to an indexed array, independent of the number of repetitions of the tag. This can save you a some if conditions in your code.

encoding

any valid encoding string

null

Defines the encoding of the original document.

targetEncoding

any valid encoding string

null

Defines the target encoding of the resulting data.

decodeFunction

any valid PHP callback

null

This option allows you to define a callback function or method, that will be applied to all character data and attributes in the document before they are stored in the result. This allows you to decode any decoded data in the XML or convert all content to lowercase.

returnResult

TRUE or FALSE

FALSE

If set to TRUE XML_Unserializer::unserialize()() will return the result if the document could be unserialized instead of just TRUE.

Options example

The following examples shows how to set options for XML_Unserializer.

Example 59-1. Using the constructor

require_once "XML/Unserializer.php";
$options = array(
                    'complexType'       => 'array'
                );

$us = new XML_Unserializer($options);
$result = $us->unserialize('example.xml', true);

The following example shows how to set options for XML_Unserializer, if the instance already has been created.

Example 59-2. Using setOption() and setOptions()

require_once "XML/Unserializer.php";
$us = new XML_Unserializer();
$options = array(
                    'tagMap'            => array( 'util' => 'XML_Util' ),
                    'classAttribute'    => '_classname'
                );

$us->setOptions($options);
$us->setOption('complexType', 'object');
$result = $us->unserialize('example.xml', true);

XML_Unserializer Options

Introduction to options

All available options

Options example