PEAR Manual
Prev |  | Next

# XML_Unserializer::unserialize()

XML_Unserializer::unserialize() -- unserialize data

## Synopsis

    require_once 'Unserializer.php';

``boolean XML_Unserializer::unserialize` (string $data [, boolean $isFile = `FALSE` [, array $options = `NULL`]])`

## Description

Unserialize an XML document from a string or a file.

The way the document is unserialized is influenced by the options you set in the constructor or with setOptions().

## Parameter

- `string $data` - either the file name of an XML document or a string containing the XML document.

- `boolean $isFile` - indicates whether the first parameter should is a filename (`TRUE`) or an XML string (`FALSE`).

- `array $options` - Options to override the options that have been set previously. The options will only be used for this unserialization and then reset the the options you set before.

## Return value

Returns `TRUE` on success, PEAR_Error on failure.

## Note

This function can not be called statically.

Prev | Home | Next
XML_Unserializer::apiVersion() | Up | XML_Unserializer::getUnserializedData()