PHP Class XML_Unserializer

Mostrar archivo Open project: sourcefabric/newscoop Class Usage Examples

Public Properties

Property Type Description
$_dataStack array stack for all data that is found
$_defaultOptions array default options for the serialization
$_depth integer current tag depth
$_knownOptions array list of all available options
$_parser XML_Parser instance
$_root string name of the root tag
$_unserializedData string unserialized data
$_valStack array stack for all values that are generated
$options array current options for the serialization

Public Methods

Method Description
XML_Unserializer ( mixed $options = null ) constructor
_createParser ( ) : boolean create the XML_Parser instance
_getComplexType ( string $tagname ) : string get the complex type, that should be used for a specified tag
_guessAndSetType ( string $value ) : mixed Try to guess the type of a value and set it accordingly
_guessAndSetTypes ( array $array ) : array Try to guess the type of several values and set them accordingly
apiVersion ( ) : string return API version
cdataHandler ( object $parser, string $cdata ) : void Handler for character data
endHandler ( object $parser, string $element ) : void End element handler for XML parser
getRootName ( ) : string get the name of the root tag
getUnserializedData ( ) : string get the result of the serialization
resetOptions ( ) : void reset all options to default options
setOption ( string $name, mixed $value ) : void set an option
setOptions ( array $options ) : void sets several options at once
startHandler ( object $parser, string $element, array $attribs ) : void Start element handler for XML parser
unserialize ( mixed $data, boolean $isFile = false, array $options = null ) : boolean unserialize data

Method Details

XML_Unserializer() public method

constructor
public XML_Unserializer ( mixed $options = null )
$options mixed array containing options for the unserialization

_createParser() public method

create the XML_Parser instance
public _createParser ( ) : boolean
return boolean

_getComplexType() public method

get the complex type, that should be used for a specified tag
public _getComplexType ( string $tagname ) : string
$tagname string name of the tag
return string complex type ('array' or 'object')

_guessAndSetType() public method

Try to guess the type of a value and set it accordingly
public _guessAndSetType ( string $value ) : mixed
$value string character data
return mixed value with the best matching type

_guessAndSetTypes() public method

Try to guess the type of several values and set them accordingly
public _guessAndSetTypes ( array $array ) : array
$array array array containing the values
return array array, containing the values with their correct types

apiVersion() public method

return API version
public apiVersion ( ) : string
return string $version API version

cdataHandler() public method

Handler for character data
public cdataHandler ( object $parser, string $cdata ) : void
$parser object XML parser object
$cdata string CDATA
return void

endHandler() public method

End element handler for XML parser
public endHandler ( object $parser, string $element ) : void
$parser object XML parser object
$element string element
return void

getRootName() public method

get the name of the root tag
public getRootName ( ) : string
return string $rootName

getUnserializedData() public method

get the result of the serialization
public getUnserializedData ( ) : string
return string $serializedData

resetOptions() public method

reset all options to default options
public resetOptions ( ) : void
return void

setOption() public method

You can use this method if you do not want to set all options in the constructor
public setOption ( string $name, mixed $value ) : void
$name string name of option
$value mixed value of option
return void

setOptions() public method

You can use this method if you do not want to set all options in the constructor
public setOptions ( array $options ) : void
$options array options array
return void

startHandler() public method

Start element handler for XML parser
public startHandler ( object $parser, string $element, array $attribs ) : void
$parser object XML parser object
$element string XML element
$attribs array attributes of XML tag
return void

unserialize() public method

unserialize data
public unserialize ( mixed $data, boolean $isFile = false, array $options = null ) : boolean
$data mixed data to unserialize (string, filename or resource)
$isFile boolean data should be treated as a file
$options array options that will override the global options for this call
return boolean $success

Property Details

$_dataStack public_oe property

stack for all data that is found
public array $_dataStack
return array

$_defaultOptions public_oe property

default options for the serialization
public array $_defaultOptions
return array

$_depth public_oe property

current tag depth
public int $_depth
return integer

$_knownOptions public_oe property

list of all available options
public array $_knownOptions
return array

$_parser public_oe property

XML_Parser instance
public $_parser

$_root public_oe property

name of the root tag
public string $_root
return string

$_unserializedData public_oe property

unserialized data
public string $_unserializedData
return string

$_valStack public_oe property

stack for all values that are generated
public array $_valStack
return array

$options public_oe property

current options for the serialization
public array $options
return array