Collaboration diagram for ilIniFile:

Public Member Functions
	ilIniFile ($a_ini_file_name)
	Constructor @access public. More...

	read ()
	read from ini file @access public More...

	parse ()
	load and parse an inifile @access private More...

	fixIniFile ()
	Fix ini file (make it compatible for PHP 5.3) More...

	parse_data ($a_data)
	parse data @access private More...

	setContent ($a_data)
	DESCRIPTION MISSING @access public. More...

	write ()
	save ini-file-data to filesystem @access private More...

Data Fields
	$INI_FILE_NAME = ""

	$ERROR = ""

	$GROUPS = array()

	$CURRENT_GROUP = ""

Detailed Description

INIFile Parser.

Early access in init proceess! Avoid further dependencies like logging or other services

Description:

A Simpe Ini File Implementation to keep settings in a simple file instead of in a DB Based upon class.INIfile.php by Mircho Mirev mirch.nosp@m.o@ma.nosp@m.cropo.nosp@m.int..nosp@m.com

Usage Examples: $ini = new IniFile("./ini.ini"); Read entire group in an associative array $grp = $ini->read_group("MAIN"); //prints the variables in the group if ($grp) for(reset($grp); $key=key($grp); next($grp)) { echo "GROUP ".$key."=".$grp[$key]."<br>"; } //set a variable to a value $ini->setVariable("NEW","USER","JOHN"); //Save the file $ini->save_data();

Author: Mircho Mirev mirch.nosp@m.o@ma.nosp@m.cropo.nosp@m.int..nosp@m.com; Peter Gabriel peter.nosp@m.@gab.nosp@m.riel-.nosp@m.onli.nosp@m.ne.ne.nosp@m.t

Version: $Id$

Definition at line 37 of file class.ilIniFile.php.

Member Function Documentation

◆ fixIniFile()

ilIniFile::fixIniFile ( )

Fix ini file (make it compatible for PHP 5.3)

Definition at line 144 of file class.ilIniFile.php.

        {
                // first read content
                $lines = array();
                $fp = @fopen($this->INI_FILE_NAME,"r");
                while (!feof($fp))
                {
                        $l = fgets($fp, 4096);
                        $skip = false;
                        if ((substr($l, 0, 2) == "/*" && $starttag) ||
                                substr($l, 0, 5) == "*/ ?>")
                        {
                                $skip = true;
                        }
                        $starttag = false;
                        if (substr($l, 0, 5) == "<?php")
                        {
                                $l = "; <?php exit; ?>";
                                $starttag = true; 
                        }
                        if (!$skip)
                        {
                                $l = str_replace("\n", "", $l);
                                $l = str_replace("\r", "", $l);
                                $lines[] = $l;
                        }
                }
                fclose($fp);
                
                // now write it back
                $fp = @fopen($this->INI_FILE_NAME,"w");
                
                if (!empty($fp))
                {
                        foreach ($lines as $l)
                        {
                                fwrite($fp, $l."\r\n");
                        }
                }
                fclose($fp);
                
        }

References $l.

Referenced by parse().

Here is the caller graph for this function:

◆ ilIniFile()

ilIniFile::ilIniFile ( $a_ini_file_name )

Constructor @access public.

Parameters

string name of file to be parsed

Returns: boolean

Definition at line 73 of file class.ilIniFile.php.

        {
                //check if a filename is given
                if (empty($a_ini_file_name))
                {
                        $this->error("no_file_given");
                        return false;
                }
 
                $this->INI_FILE_NAME = $a_ini_file_name;
                return true;
        }

References error().

Here is the call graph for this function:

◆ parse()

ilIniFile::parse ( )

load and parse an inifile @access private

Returns: boolean

Definition at line 116 of file class.ilIniFile.php.

        {
                //use php4 function parse_ini_file
                $this->GROUPS = @parse_ini_file($this->INI_FILE_NAME, true);
 
                //check if groups are filled
                if ($this->GROUPS == false)
                {
                        // second try
                        $this->fixIniFile();
                        
                        $this->GROUPS = @parse_ini_file($this->INI_FILE_NAME, true);
                        if ($this->GROUPS == false)
                        {
                                $this->error("file_not_accessible");
                                return false;
                        }
                }
                //set current group
                $temp = array_keys($this->GROUPS);
                $this->CURRENT_GROUP = $temp[count($temp)-1];
                return true;
                
        }

References error(), and fixIniFile().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse_data()

ilIniFile::parse_data ( $a_data )

parse data @access private

Parameters

array

Definition at line 192 of file class.ilIniFile.php.

        {
                if (ereg("\[([[:alnum:]]+)\]",$a_data,$out))
                {
                        $this->CURRENT_GROUP= trim($out[1]);
                }
                elseif (!empty($a_data))
                {
                        $split_data = split("=", $a_data);
                        $this->GROUPS[$this->CURRENT_GROUP][trim($split_data[0])]=trim($split_data[1]);
                }
        }

References $CURRENT_GROUP, and $out.

◆ read()

ilIniFile::read ( )

read from ini file @access public

Returns: boolean

Definition at line 91 of file class.ilIniFile.php.

        {
                //check if file exists
                if (!file_exists($this->INI_FILE_NAME))
                {
                        $this->error("file_does_not_exist");
                        return false;
                }
                else
                {
                        //parse the file
                        if ($this->parse() == false)
                        {
                                return false;
                        }
                }
 
                return true;
        }

References error(), and parse().

Here is the call graph for this function:

◆ setContent()

ilIniFile::setContent ( $a_data )

DESCRIPTION MISSING @access public.

Parameters

string

Returns: boolean true

Definition at line 211 of file class.ilIniFile.php.

        {
                $this->GROUPS = $a_data;
                return true;
        }

◆ write()

ilIniFile::write ( )

save ini-file-data to filesystem @access private

Returns: boolean

Definition at line 222 of file class.ilIniFile.php.

References $res, $result, error(), readGroup(), and readGroups().

Referenced by ilGlobalCacheSettings\writeToIniFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $CURRENT_GROUP

ilIniFile::$CURRENT_GROUP = ""

Definition at line 65 of file class.ilIniFile.php.

Referenced by parse_data().

◆ $ERROR

ilIniFile::$ERROR = ""

Definition at line 51 of file class.ilIniFile.php.

Referenced by getError().

◆ $GROUPS

ilIniFile::$GROUPS = array()

Definition at line 58 of file class.ilIniFile.php.

◆ $INI_FILE_NAME

ilIniFile::$INI_FILE_NAME = ""

Definition at line 44 of file class.ilIniFile.php.

The documentation for this class was generated from the following file:

Services/Init/classes/class.ilIniFile.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ fixIniFile()

◆ ilIniFile()

◆ parse()

◆ parse_data()

◆ read()

◆ setContent()

◆ write()

Field Documentation

◆ $CURRENT_GROUP

◆ $ERROR

◆ $GROUPS

◆ $INI_FILE_NAME