Source for file jIniFile.class.php

Documentation is available at jIniFile.class.php

1. <?php
2. /**
3. * @package    jelix
4. * @subpackage utils
5. * @author     Loic Mathaud
6. * @contributor Laurent Jouanneau
7. * @copyright  2006 Loic Mathaud, 2008 Laurent Jouanneau
8. * @link        http://www.jelix.org
9. * @licence  http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
10. */
11.  
12. /**
13. * utility class to read and write an ini file
14. * @package    jelix
15. * @subpackage utils
16. * @since 1.0b1
17. */
18. class jIniFile {
19.  
20.     /**
21.      * read an ini file
22.      * @param string $filename the path and the name of the file to read
23.      * @return array the content of the file or false
24.      */
25.     public static function read($filename) {
26.         if ( file_exists ($filename) ) {
27.             return parse_ini_file($filename, true);
28.         } else {
29.             return false;
30.         }
31.     }
32.  
33.     /**
34.      * write some data in an ini file
35.      * the data array should follow the same structure returned by
36.      * the read method (or parse_ini_file)
37.      * @param array $array the content of an ini file
38.      * @param string $filename the path and the name of the file use to store the content
39.      * @param string $header   some content to insert at the begining of the file
40.      */
41.     public static function write($array, $filename, $header='') {
42.         $result='';
43.         foreach ($array as $k => $v) {
44.             if (is_array($v)) {
45.                 $result.='['.$k."]\n";
46.                 foreach($v as $k2 => $v2){
47.                     $result .= self::_iniValue($k2,$v2);
48.                 }
49.             } else {
50.                 // we put simple values at the beginning of the file.
51.                 $result = self::_iniValue($k,$v).$result;
52.             }
53.         }
54.  
55.         if ($f = @fopen($filename, 'wb')) {
56.             fwrite($f, $header.$result);
57.             fclose($f);
58.         } else {
59.             // jIniFile is used by the configs compiler
60.             // there is no $gJConfig in that case:
61.             // we need to generate an error without using jLocale
62.             if(isset($GLOBALS['gJConfig'])){
63.                 throw new jException('jelix~errors.inifile.write.error', array ($filename));
64.             }else{
65.                 throw new Exception('(24)Error while writing ini file '.$filename);
66.             }
67.         }
68.     }
69.  
70.     /**
71.      * format a value to store in a ini file
72.      * @param string $value the value
73.      * @return string the formated value
74.      */
75.     static private function _iniValue($key, $value){
76.         if(is_array($value)) {
77.             $res = '';
78.             foreach($value as $v)
79.                 $res.=self::_iniValue($key.'[]', $v);
80.             return $res;
81.         } else if ($value == ''
82.                   || is_numeric($value)
83.                   || (preg_match("/^[\w-.]*$/", $value) && strpos("\n",$value) === false)) {
84.             return $key.'='.$value."\n";
85.         } else if($value === false) {
86.             return $key."=0\n";
87.         } else if($value === true) {
88.             return $key."=1\n";
89.         } else {
90.             return $key.'="'.$value."\"\n";
91.         }
92.     }
93. }

Documentation generated on Wed, 24 Sep 2014 22:00:01 +0200 by phpDocumentor 1.4.3