Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /joomla/registry/format/xml.php

Documentation is available at xml.php

  1. <?php
  2. /**
  3.  * @version        $Id: xml.php 6472 2007-02-03 10:47:26Z pasamio $
  4.  * @package        Joomla.Framework
  5.  * @subpackage    Registry
  6.  * @copyright    Copyright (C) 2005 - 2007 Open Source Matters. All rights reserved.
  7.  * @license        GNU/GPL, see LICENSE.php
  8.  *  Joomla! is free software. This version may have been modified pursuant
  9.  *  to the GNU General Public License, and as distributed it includes or
  10.  *  is derivative of works licensed under the GNU General Public License or
  11.  *  other free or open source software licenses.
  12.  *  See COPYRIGHT.php for copyright notices and details.
  13.  */
  14.  
  15. // Check to ensure this file is within the rest of the framework
  16. defined('JPATH_BASE') or die();
  17.  
  18. /**
  19.  * XML Format for JRegistry
  20.  *
  21.  * @author         Samuel Moffatt <[email protected]>
  22.  * @package     Joomla.Framework
  23.  * @subpackage        Registry
  24.  * @since        1.5
  25.  */
  26. class JRegistryFormatXML extends JRegistryFormat {
  27.  
  28.     /**
  29.      * Converts an XML formatted string into an object
  30.      *
  31.      * @access public
  32.      * @param string  XML Formatted String
  33.      * @return object Data Object
  34.      */
  35.     function stringToObject( $data, $namespace='' ) {
  36.         return true;
  37.     }
  38.  
  39.     /**
  40.      * Converts an object into an XML formatted string
  41.      *     -    If more than two levels of nested groups are necessary, since INI is not
  42.      *         useful, XML or another format should be used.
  43.      *
  44.      * @access public
  45.      * @param object $object Data Source Object
  46.      * @param array  $param  Parameters used by the formatter
  47.      * @return string XML Formatted String
  48.      */
  49.     function objectToString( &$object, $params ) {
  50.         $depth = 1;
  51.         $retval = "<?xml version=\"1.0\" ?>\n<config>\n";
  52.         foreach (get_object_vars( $object ) as $key=>$item) {
  53.             if (is_object($item)) {
  54.                 $retval .= "\t<group name=\"".$key."\">\n";
  55.                 $retval .= $this->_buildXMLstringLevel($item, $depth+1);
  56.                 $retval .= "\t</group>\n";
  57.             } else {
  58.                 $retval .= "\t<entry name=\"".$key."\">".$item."</entry>\n";
  59.             }
  60.         }
  61.         $retval .= '</config>';
  62.         return $retval;
  63.     }
  64.  
  65.     /**
  66.      * Method to build a level of the XML string -- called recursively
  67.      *
  68.      * @access private
  69.      * @param object $object Object that represents a node of the xml document
  70.      * @param int $depth The depth in the XML tree of the $object node
  71.      * @return string XML string
  72.      */
  73.     function _buildXMLstringLevel($object, $depth) {
  74.         // Initialize variables
  75.         $retval = '';
  76.         for($i=1;$i <= $depth; $i++) {
  77.             $tab .= "\t";
  78.         }
  79.  
  80.         foreach (get_object_vars( $object ) as $key=>$item) {
  81.             if (is_object($item)) {
  82.                 $retval .= $tab."<group name=\"".$key."\">\n";
  83.                 $retval .= $this->_buildXMLstringLevel($item, $depth+1);
  84.                 $retval .= $tab."</group>\n";
  85.             } else {
  86.                 $retval .= $tab."<entry name=\"".$key."\">".$item."</entry>\n";
  87.             }
  88.         }
  89.         return $retval;
  90.     }
  91. }
  92. ?>
Documentation generated on Mon, 05 Mar 2007 21:31:50 +0000 by phpDocumentor 1.3.1