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/ini.php

Documentation is available at ini.php

  1. <?php
  2. /**
  3.  * @version        $Id: ini.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.  * INI format handler for JRegistry
  20.  *
  21.  * @author         Samuel Moffatt <[email protected]>
  22.  * @package     Joomla.Framework
  23.  * @subpackage        Registry
  24.  * @since        1.5
  25.  */
  26. class JRegistryFormatINI extends JRegistryFormat {
  27.  
  28.     /**
  29.      * Converts an object into an INI formatted string
  30.      *     -    Unfortunately, there is no way to have ini values nested further than two
  31.      *         levels deep.  Therefore we will only go through the first two levels of
  32.      *         the object.
  33.      *
  34.      * @access public
  35.      * @param object $object Data Source Object
  36.      * @param array  $param  Parameters used by the formatter
  37.      * @return string INI Formatted String
  38.      */
  39.     function objectToString( &$object, $params ) {
  40.  
  41.         // Initialize variables
  42.         $retval = '';
  43.         $prepend = '';
  44.  
  45.         // First handle groups (or first level key/value pairs)
  46.         foreach (get_object_vars( $object ) as $key => $level1) {
  47.  
  48.             if (is_object($level1)) {
  49.                 // This field is an object, so we treat it as a section
  50.                 $retval .= "[".$key."]\n";
  51.                 foreach (get_object_vars( $level1 ) as $key => $level2) {
  52.                     if (!is_object($level2) && !is_array($level2)) {
  53.                         $retval .= $key."=".$level2."\n";
  54.                     }
  55.                 }
  56.                 $retval .= "\n";
  57.             } else {
  58.                 $prepend .= $key."=".$level1."\n";
  59.             }
  60.         }
  61.         return $prepend."\n".$retval;
  62.     }
  63.  
  64.     /**
  65.      * Parse an .ini string, based on phpDocumentor phpDocumentor_parse_ini_file function
  66.      *
  67.      * @access public
  68.      * @param mixed The INI string or array of lines
  69.      * @param boolean add an associative index for each section [in brackets]
  70.      * @return object Data Object
  71.      */
  72.     function &stringToObject( $data, $process_sections = false )
  73.     {
  74.         if (is_string($data)) {
  75.             $lines = explode("\n", $data);
  76.         } else {
  77.             if (is_array($data)) {
  78.                 $lines = $data;
  79.             } else {
  80.                 $lines = array ();
  81.             }
  82.         }
  83.         $obj = new stdClass();
  84.  
  85.         $sec_name = '';
  86.         $unparsed = 0;
  87.         if (!$lines) {
  88.             return $obj;
  89.         }
  90.         foreach ($lines as $line) {
  91.             // ignore comments
  92.             if ($line && $line{0} == ';') {
  93.                 continue;
  94.             }
  95.             $line = trim($line);
  96.  
  97.             if ($line == '') {
  98.                 continue;
  99.             }
  100.             $lineLen = strlen($line);
  101.             if ($line && $line{0} == '[' && $line{$lineLen-1} == ']') {
  102.                 $sec_name = substr($line, 1, $lineLen - 2);
  103.                 if ($process_sections) {
  104.                     $obj-> $sec_name = new stdClass();
  105.                 }
  106.             } else {
  107.                 if ($pos = strpos($line, '=')) {
  108.                     $property = trim(substr($line, 0, $pos));
  109.  
  110.                     // property is assumed to be ascii
  111.                     if ($property && $property{0} == '"') {
  112.                         $propLen = strlen( $property );
  113.                         if ($property{$propLen-1} == '"') {
  114.                             $property = stripcslashes(substr($property, 1, $propLen - 2));
  115.                         }
  116.                     }
  117.                     // AJE: 2006-11-06 Fixes problem where you want leading spaces
  118.                     // for some parameters, eg, class suffix
  119.                     // $value = trim(substr($line, $pos +1));
  120.                     $value = substr($line, $pos +1);
  121.                     if ($value == 'false') {
  122.                         $value = false;
  123.                     }
  124.                     else if ($value == 'true') {
  125.                         $value = true;
  126.                     }
  127.                     else if ($value && $value{0} == '"') {
  128.                         $valueLen = strlen( $value );
  129.                         if ($value{$valueLen-1} == '"') {
  130.                             $value = stripcslashes(substr($value, 1, $valueLen - 2));
  131.                         }
  132.                     }
  133.  
  134.                     if ($process_sections) {
  135.                         $value = str_replace('\n', "\n", $value);
  136.                         if ($sec_name != '') {
  137.                             $obj->$sec_name->$property = $value;
  138.                         } else {
  139.                             $obj->$property = $value;
  140.                         }
  141.                     } else {
  142.                         $obj->$property = str_replace('\n', "\n", $value);
  143.                     }
  144.                 } else {
  145.                     if ($line && $line{0} == ';') {
  146.                         continue;
  147.                     }
  148.                     if ($process_sections) {
  149.                         $property = '__invalid'.$unparsed ++.'__';
  150.                         if ($process_sections) {
  151.                             if ($sec_name != '') {
  152.                                 $obj->$sec_name->$property = trim($line);
  153.                             } else {
  154.                                 $obj->$property = trim($line);
  155.                             }
  156.                         } else {
  157.                             $obj->$property = trim($line);
  158.                         }
  159.                     }
  160.                 }
  161.             }
  162.         }
  163.         return $obj;
  164.     }
  165. }
  166. ?>
Documentation generated on Mon, 05 Mar 2007 21:07:54 +0000 by phpDocumentor 1.3.1