File/PEAR/XML/Unserializer.php

Description

XML_Unserializer

Parses any XML document into PHP data structures.

PHP versions 4 and 5

LICENSE: This source file is subject to version 3.0 of the PHP license that is available through the world-wide-web at the following URI: http://www.php.net/license/3_0.txt. If you did not receive a copy of the PHP License and are unable to obtain it through the web, please send a note to license@php.net so we can mail you a copy immediately.

Classes
Class Description
 class XML_Unserializer XML_Unserializer
Includes
 require_once ('XML/Parser.php') (line 35)

uses XML_Parser to unserialize document

 require_once (PEAR.php) (line 30)

uses PEAR error managemt

Constants
XML_UNSERIALIZER_ERROR_NO_UNSERIALIZATION = 151 (line 219)

error code for no serialization done

XML_UNSERIALIZER_OPTION_ATTRIBUTES_ARRAYKEY = 'attributesArray' (line 102)

option: Key of the array to store attributes (if any)

Possible values:

  • any string
  • false (disabled)

XML_UNSERIALIZER_OPTION_ATTRIBUTES_PARSE = 'parseAttributes' (line 93)

option: Whether to parse attributes

Possible values:

  • true or false

XML_UNSERIALIZER_OPTION_ATTRIBUTES_PREPEND = 'prependAttributes' (line 111)

option: string to prepend attribute name (if any)

Possible values:

  • any string
  • false (disabled)

XML_UNSERIALIZER_OPTION_ATTRIBUTE_CLASS = 'classAttribute' (line 69)

option: Name of the attribute that stores the class name

Possible values:

  • any string

XML_UNSERIALIZER_OPTION_ATTRIBUTE_KEY = 'keyAttribute' (line 53)

option: Name of the attribute that stores the original key

Possible values:

  • any string

XML_UNSERIALIZER_OPTION_ATTRIBUTE_TYPE = 'typeAttribute' (line 61)

option: Name of the attribute that stores the type

Possible values:

  • any string

XML_UNSERIALIZER_OPTION_COMPLEXTYPE = 'complexType' (line 45)

option: Convert nested tags to array or object

Possible values:

  • array
  • object
  • associative array to define this option per tag name

XML_UNSERIALIZER_OPTION_CONTENT_KEY = 'contentName' (line 119)

option: key to store the content, if XML_UNSERIALIZER_OPTION_ATTRIBUTES_PARSE is used

Possible values:

  • any string

XML_UNSERIALIZER_OPTION_DECODE_FUNC = 'decodeFunction' (line 161)

option: Callback that will be applied to textual data

Possible values:

  • any valid PHP callback

XML_UNSERIALIZER_OPTION_DEFAULT_CLASS = 'defaultClass' (line 85)

option: Name of the default class

Possible values:

  • any string

XML_UNSERIALIZER_OPTION_ENCODING_SOURCE = 'encoding' (line 144)

option: Encoding of the XML document

Possible values:

  • UTF-8
  • ISO-8859-1

XML_UNSERIALIZER_OPTION_ENCODING_TARGET = 'targetEncoding' (line 153)

option: Desired target encoding of the data

Possible values:

  • UTF-8
  • ISO-8859-1

XML_UNSERIALIZER_OPTION_FORCE_ENUM = 'forceEnum' (line 135)

option: list of tags that will always be enumerated

Possible values:

  • indexed array

XML_UNSERIALIZER_OPTION_GUESS_TYPES = 'guessTypes' (line 214)

option: whether to use type guessing for scalar values

XML_UNSERIALIZER_OPTION_IGNORE_KEYS = 'ignoreKeys' (line 209)

option: list of tags, that will not be used as keys

XML_UNSERIALIZER_OPTION_OVERRIDE_OPTIONS = 'overrideOptions' (line 204)

option: whether to ovverride all options that have been set before

Possible values:

  • true
  • false (default)

XML_UNSERIALIZER_OPTION_RETURN_RESULT = 'returnResult' (line 170)

option: whether to return the result of the unserialization from unserialize()

Possible values:

  • true
  • false (default)

XML_UNSERIALIZER_OPTION_TAG_AS_CLASSNAME = 'tagAsClass' (line 77)

option: Whether to use the tag name as a class name

Possible values:

  • true or false

XML_UNSERIALIZER_OPTION_TAG_MAP = 'tagMap' (line 127)

option: map tag names

Possible values:

  • associative array

XML_UNSERIALIZER_OPTION_WHITESPACE = 'whitespace' (line 180)

option: set the whitespace behaviour

Possible values:

  • XML_UNSERIALIZER_WHITESPACE_KEEP
  • XML_UNSERIALIZER_WHITESPACE_TRIM
  • XML_UNSERIALIZER_WHITESPACE_NORMALIZE

XML_UNSERIALIZER_WHITESPACE_KEEP = 'keep' (line 185)

Keep all whitespace

XML_UNSERIALIZER_WHITESPACE_NORMALIZE = 'normalize' (line 195)

normalize whitespace

XML_UNSERIALIZER_WHITESPACE_TRIM = 'trim' (line 190)

remove whitespace from start and end of the data

Documentation generated on Mon, 04 Dec 2006 11:10:12 -0500 by phpDocumentor 1.3.0RC3