File: Unserializer.php

Source Location: /XML_Serializer-0.20.2/XML/Unserializer.php

Classes:

Page Details:

XML_Unserializer

Parses any XML document into PHP data structures.

PHP versions 4 and 5

LICENSE:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Author: Stephan Schmidt <schst@php.net>
Version: CVS: $Id: Unserializer.php 303099 2010-09-06 16:23:06Z clockwerx $
Copyright: 2003-2008 Stephan Schmidt <schst@php.net>
See: XML_Unserializer
Link: http://pear.php.net/package/XML_Serializer
License: New BSD License

Includes:

require_once('XML/Parser.php') [line 58]
uses XML_Parser to unserialize document
require_once('PEAR.php') [line 53]
uses PEAR error managemt

XML_UNSERIALIZER_ERROR_NO_UNSERIALIZATION [line 243]

XML_UNSERIALIZER_ERROR_NO_UNSERIALIZATION = 151

error code for no serialization done

[ Top ]

XML_UNSERIALIZER_OPTION_ATTRIBUTES_ARRAYKEY [line 125]

XML_UNSERIALIZER_OPTION_ATTRIBUTES_ARRAYKEY = 'attributesArray'

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

Possible values:

any string
false (disabled)

[ Top ]

XML_UNSERIALIZER_OPTION_ATTRIBUTES_PARSE [line 116]

XML_UNSERIALIZER_OPTION_ATTRIBUTES_PARSE = 'parseAttributes'

option: Whether to parse attributes

Possible values:

true or false

[ Top ]

XML_UNSERIALIZER_OPTION_ATTRIBUTES_PREPEND [line 134]

XML_UNSERIALIZER_OPTION_ATTRIBUTES_PREPEND = 'prependAttributes'

option: string to prepend attribute name (if any)

Possible values:

any string
false (disabled)

[ Top ]

XML_UNSERIALIZER_OPTION_ATTRIBUTE_CLASS [line 92]

XML_UNSERIALIZER_OPTION_ATTRIBUTE_CLASS = 'classAttribute'

option: Name of the attribute that stores the class name

Possible values:

any string

[ Top ]

XML_UNSERIALIZER_OPTION_ATTRIBUTE_KEY [line 76]

XML_UNSERIALIZER_OPTION_ATTRIBUTE_KEY = 'keyAttribute'

option: Name of the attribute that stores the original key

Possible values:

any string

[ Top ]

XML_UNSERIALIZER_OPTION_ATTRIBUTE_TYPE [line 84]

XML_UNSERIALIZER_OPTION_ATTRIBUTE_TYPE = 'typeAttribute'

option: Name of the attribute that stores the type

Possible values:

any string

[ Top ]

XML_UNSERIALIZER_OPTION_COMPLEXTYPE [line 68]

XML_UNSERIALIZER_OPTION_COMPLEXTYPE = 'complexType'

option: Convert nested tags to array or object

Possible values:

array
object
associative array to define this option per tag name

[ Top ]

XML_UNSERIALIZER_OPTION_CONTENT_KEY [line 143]

XML_UNSERIALIZER_OPTION_CONTENT_KEY = 'contentName'

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

Possible values:

any string

[ Top ]

XML_UNSERIALIZER_OPTION_DECODE_FUNC [line 185]

XML_UNSERIALIZER_OPTION_DECODE_FUNC = 'decodeFunction'

option: Callback that will be applied to textual data

Possible values:

any valid PHP callback

[ Top ]

XML_UNSERIALIZER_OPTION_DEFAULT_CLASS [line 108]

XML_UNSERIALIZER_OPTION_DEFAULT_CLASS = 'defaultClass'

option: Name of the default class

Possible values:

any string

[ Top ]

XML_UNSERIALIZER_OPTION_ENCODING_SOURCE [line 168]

XML_UNSERIALIZER_OPTION_ENCODING_SOURCE = 'encoding'

option: Encoding of the XML document

Possible values:

UTF-8
ISO-8859-1

[ Top ]

XML_UNSERIALIZER_OPTION_ENCODING_TARGET [line 177]

XML_UNSERIALIZER_OPTION_ENCODING_TARGET = 'targetEncoding'

option: Desired target encoding of the data

Possible values:

UTF-8
ISO-8859-1

[ Top ]

XML_UNSERIALIZER_OPTION_FORCE_ENUM [line 159]

XML_UNSERIALIZER_OPTION_FORCE_ENUM = 'forceEnum'

option: list of tags that will always be enumerated

Possible values:

indexed array

[ Top ]

XML_UNSERIALIZER_OPTION_GUESS_TYPES [line 238]

XML_UNSERIALIZER_OPTION_GUESS_TYPES = 'guessTypes'

option: whether to use type guessing for scalar values

[ Top ]

XML_UNSERIALIZER_OPTION_IGNORE_KEYS [line 233]

XML_UNSERIALIZER_OPTION_IGNORE_KEYS = 'ignoreKeys'

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

[ Top ]

XML_UNSERIALIZER_OPTION_OVERRIDE_OPTIONS [line 228]

XML_UNSERIALIZER_OPTION_OVERRIDE_OPTIONS = 'overrideOptions'

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

Possible values:

true
false (default)

[ Top ]

XML_UNSERIALIZER_OPTION_RETURN_RESULT [line 194]

XML_UNSERIALIZER_OPTION_RETURN_RESULT = 'returnResult'

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

Possible values:

true
false (default)

[ Top ]

XML_UNSERIALIZER_OPTION_TAG_AS_CLASSNAME [line 100]

XML_UNSERIALIZER_OPTION_TAG_AS_CLASSNAME = 'tagAsClass'

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

Possible values:

true or false

[ Top ]

XML_UNSERIALIZER_OPTION_TAG_MAP [line 151]

XML_UNSERIALIZER_OPTION_TAG_MAP = 'tagMap'

option: map tag names

Possible values:

associative array

[ Top ]

XML_UNSERIALIZER_OPTION_WHITESPACE [line 204]

XML_UNSERIALIZER_OPTION_WHITESPACE = 'whitespace'

option: set the whitespace behaviour

Possible values:

XML_UNSERIALIZER_WHITESPACE_KEEP
XML_UNSERIALIZER_WHITESPACE_TRIM
XML_UNSERIALIZER_WHITESPACE_NORMALIZE

[ Top ]

XML_UNSERIALIZER_WHITESPACE_KEEP [line 209]

XML_UNSERIALIZER_WHITESPACE_KEEP = 'keep'

Keep all whitespace

[ Top ]

XML_UNSERIALIZER_WHITESPACE_NORMALIZE [line 219]

XML_UNSERIALIZER_WHITESPACE_NORMALIZE = 'normalize'

normalize whitespace

[ Top ]

XML_UNSERIALIZER_WHITESPACE_TRIM [line 214]

XML_UNSERIALIZER_WHITESPACE_TRIM = 'trim'

remove whitespace from start and end of the data

[ Top ]