Class Gadget_Tree_XML

Description

Gadget_Tree_XML

  • since: 1.0

Located in /Gadget/Tree/XML.php (line 42)

Gadget_Object
   |
   --Gadget_Tree
      |
      --Gadget_Tree_XML
Variable Summary
string $encoding
Method Summary
object &create (mixed $params, [string $class = __CLASS__])
mixed &fromDefault (mixed &$from)
object Gadget_Tree_XML_Node &fromFile (string $file, [mixed $encoding = null])
mixed &fromString (string $xml, [mixed $encoding = null])
string serialize (object Gadget_Tree_XML &$tree, [array $options = array()], [mixed $serializer = 'Gadget_Tree_Serializer_XML'], string $serilaizer)
mixed toFile (string $file, [array $options = array()], int $indent)
string toString ([sarray $options = array()])
Variables
string $encoding = 'ISO-8859-1' (line 49)

Encoding

Inherited Variables

Inherited from Gadget_Tree

Gadget_Tree::$maxDepth
Gadget_Tree::$node
Gadget_Tree::$root
Methods
create (line 61)

Create

See Gadget_Tree::create().

  • access: public
object &create (mixed $params, [string $class = __CLASS__])
  • mixed $params
  • string $class

Redefinition of:
Gadget_Tree::create()
Create
fromDefault (line 120)

From Default

Tries to guess the type of the source. Calls Gadget_Tree_XML::fromFile(), Gadget_Tree_XML::fromString() and Gadget_Tree::fromNode in this order.

  • return: Returns the root node on success or false.
  • access: public
mixed &fromDefault (mixed &$from)
fromFile (line 75)

From File

Build the tree from the content of an XML file.

  • return: The root node of the tree.
  • access: public
object Gadget_Tree_XML_Node &fromFile (string $file, [mixed $encoding = null])
  • string $file: The path to the XML file.
fromString (line 100)

From String

Build the tree from an XML string.

  • return: Returns the root node on success or false.
  • access: public
mixed &fromString (string $xml, [mixed $encoding = null])
  • string $xml: XML string
serialize (line 173)

Serialize

  • return: XML
  • access: public
  • static:
string serialize (object Gadget_Tree_XML &$tree, [array $options = array()], [mixed $serializer = 'Gadget_Tree_Serializer_XML'], string $serilaizer)
  • object Gadget_Tree_XML $tree
  • array $options: Serializer options
  • string $serilaizer: Gadget_Tree_Serializer class

Redefinition of:
Gadget_Tree::serialize()
Serialize
toFile (line 137)

To File

Overrides Gadget_Tree::toFile(). Prepends the XML declaration with proper encoding information to Gadget_Tree_XML::toString() and saves to a file.

  • return: Returns true on success or PEAR_Error on failure.
  • access: public
mixed toFile (string $file, [array $options = array()], int $indent)
  • string $file: The path of the file to save to.
  • int $indent: The count of indenting space characters to use.
  • array $options: Serializer options

Redefinition of:
Gadget_Tree::toFile()
To File
toString (line 153)

To String

Overrides Gadget_Tree::toString() to provide the options for a different output encoding using iconv().

  • access: public
  • see: Gadget_Tree_XML::encoding, Gadget_Tree_XML::setOptions()
string toString ([sarray $options = array()])
  • sarray $options: Serializer options

Redefinition of:
Gadget_Tree::toString()
To String

Inherited Methods

Inherited From Gadget_Tree

Gadget_Tree::create()
Gadget_Tree::dump()
Gadget_Tree::factory()
Gadget_Tree::fputs()
Gadget_Tree::from()
Gadget_Tree::fromNode()
Gadget_Tree::isError()
Gadget_Tree::raiseError()
Gadget_Tree::searchByPath()
Gadget_Tree::serialize()
Gadget_Tree::toArray()
Gadget_Tree::toFile()
Gadget_Tree::toString()
Gadget_Tree::unfold()
Gadget_Tree::unfoldTree()
Gadget_Tree::walkLink()

Inherited From Gadget_Object

Gadget_Object::Gadget_Object()
Gadget_Object::onAfterConstruct()
Gadget_Object::onBeforeConstruct()
Gadget_Object::setOptions()

Documentation generated on Sun, 03 Jul 2005 12:46:13 +0200 by phpDocumentor 1.3.0RC3