ilIniFile Class Reference

INIFile Parser. More...

Collaboration diagram for ilIniFile:

Public Member Functions
	__construct ($a_ini_file_name)
	Constructor public. More...
	read ()
	read from ini file public More...
	parse ()
	load and parse an inifile private More...
	write ()
	save ini-file-data to filesystem private More...
	show ()
	returns the content of IniFile public More...
	getGroupCount ()
	returns number of groups public More...
	readGroups ()
	returns an array with the names of all the groups public More...
	groupExists ($a_group_name)
	checks if a group exists public More...
	readGroup ($a_group_name)
	returns an associative array of the variables in one group public More...
	addGroup ($a_group_name)
	adds a new group public More...
	removeGroup ($a_group_name)
	removes a group public More...
	variableExists ($a_group, $a_var_name)
	returns if a variable exists or not public More...
	readVariable ($a_group, $a_var_name)
	reads a single variable from a group public More...
	setVariable ($a_group_name, $a_var_name, $a_var_value)
	sets a variable in a group public More...
	error ($a_errmsg)
	set error message public More...
	getError ()
	returns error public 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.

Constructor & Destructor Documentation

__construct()

ilIniFile::__construct

(

$a_ini_file_name

)

Constructor public.

Parameters

string

name of file to be parsed

Returns

boolean

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

References error().

    {
        //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;
    }

Here is the call graph for this function:

Member Function Documentation

addGroup()

ilIniFile::addGroup

(

$a_group_name

)

adds a new group public

Parameters

string

group name

Returns

boolean

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

References error(), and groupExists().

Referenced by ilGlobalCacheSettings\checkIniHeader(), and ilGlobalCacheSettings\writeToIniFile().

    {
        if ($this->groupExists($a_group_name)) {
            $this->error("Group '" . $a_group_name . "' exists");
            return false;
        }

        $this->GROUPS[$a_group_name] = array();
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

error()

ilIniFile::error

(

$a_errmsg

)

set error message public

Parameters

string

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

Referenced by __construct(), addGroup(), parse(), read(), readGroup(), readVariable(), removeGroup(), setVariable(), and write().

    {
        $this->ERROR = $a_errmsg;

        return true;
    }

Here is the caller graph for this function:

getError()

ilIniFile::getError

(

)

returns error public

Returns

string

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

References $ERROR.

    {
        return $this->ERROR;
    }

getGroupCount()

ilIniFile::getGroupCount

(

)

returns number of groups public

Returns

integer

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

    {
        return count($this->GROUPS);
    }

groupExists()

ilIniFile::groupExists

(

$a_group_name

)

checks if a group exists public

Parameters

string

group name

Returns

boolean

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

Referenced by addGroup(), readGroup(), removeGroup(), and setVariable().

    {
        if (!isset($this->GROUPS[$a_group_name])) {
            return false;
        }
        
        return true;
    }

Here is the caller graph for this function:

parse()

ilIniFile::parse

(

)

load and parse an inifile private

Returns

boolean

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

References error().

Referenced by read().

    {
        $this->GROUPS = @parse_ini_file($this->INI_FILE_NAME, true);

        //check if groups are filled
        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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilIniFile::read

(

)

read from ini file public

Returns

boolean

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

References error(), and parse().

    {
        //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;
    }

Here is the call graph for this function:

readGroup()

ilIniFile::readGroup

(

$a_group_name

)

returns an associative array of the variables in one group public

Parameters

string

group name

Returns

mixed return array of values or boolean 'false' on failure

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

References error(), and groupExists().

Referenced by ilGlobalCacheSettings\checkIniHeader(), ilGlobalCacheSettings\readFromIniFile(), show(), and write().

    {
        if (!$this->groupExists($a_group_name)) {
            $this->error("Group '" . $a_group_name . "' does not exist");
            return false;
        }
        
        return $this->GROUPS[$a_group_name];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readGroups()

ilIniFile::readGroups

(

)

returns an array with the names of all the groups public

Returns

array groups

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

Referenced by show(), and write().

    {
        $groups = array();

        for (reset($this->GROUPS);$key = key($this->GROUPS);next($this->GROUPS)) {
            $groups[] = $key;
        }

        return $groups;
    }

Here is the caller graph for this function:

readVariable()

ilIniFile::readVariable	(		$a_group,
			$a_var_name
	)

reads a single variable from a group public

Parameters

string	group name
string	value

Returns

mixed return value string or boolean 'false' on failure

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

References error().

Referenced by ilTimeZone\initDefaultTimeZone(), and ilGlobalCacheSettings\readFromIniFile().

    {
        if (!isset($this->GROUPS[$a_group][$a_var_name])) {
            $this->error("'" . $a_var_name . "' does not exist in '" . $a_group . "'");
            return false;
        }
        
        return trim($this->GROUPS[$a_group][$a_var_name]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeGroup()

ilIniFile::removeGroup

(

$a_group_name

)

removes a group public

Parameters

string

group name

Returns

boolean

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

References error(), and groupExists().

Referenced by ilGlobalCacheSettings\writeToIniFile().

    {
        if (!$this->groupExists($a_group_name)) {
            $this->error("Group '" . $a_group_name . "' does not exist");
            return false;
        }

        unset($this->GROUPS[$a_group_name]);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setVariable()

ilIniFile::setVariable	(		$a_group_name,
			$a_var_name,
			$a_var_value
	)

sets a variable in a group public

Parameters

string
string
string

Returns

boolean

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

References error(), and groupExists().

Referenced by ilGlobalCacheSettings\writeToIniFile().

    {
        if (!$this->groupExists($a_group_name)) {
            $this->error("Group '" . $a_group_name . "' does not exist");
            return false;
        }
        
        $this->GROUPS[$a_group_name][$a_var_name] = $a_var_value;
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

show()

ilIniFile::show

(

)

returns the content of IniFile public

Returns

string content

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

References $i, readGroup(), and readGroups().

    {
        $groups = $this->readGroups();
        $group_cnt = count($groups);
        
        //clear content
        $content = "";
        
        // go through all groups
        for ($i = 0; $i < $group_cnt; $i++) {
            $group_name = $groups[$i];
            //prevent empty line at beginning of ini-file
            if ($i == 0) {
                $content = sprintf("[%s]\n", $group_name);
            } else {
                $content .= sprintf("\n[%s]\n", $group_name);
            }

            $group = $this->readGroup($group_name);
            
            //go through group an display all variables
            for (reset($group); $key = key($group);next($group)) {
                $content .= sprintf("%s = %s\n", $key, $group[$key]);
            }
        }

        return $content;
    }

Here is the call graph for this function:

variableExists()

ilIniFile::variableExists	(		$a_group,
			$a_var_name
	)

returns if a variable exists or not public

Parameters

string	group name
string	value

Returns

mixed return true if value exists or false

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

    {
        return isset($this->GROUPS[$a_group][$a_var_name]);
    }

write()

ilIniFile::write

(

)

save ini-file-data to filesystem private

Returns

boolean

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

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

Referenced by ilGlobalCacheSettings\writeToIniFile().

    {
        $fp = @fopen($this->INI_FILE_NAME, "w");
        
        if (empty($fp)) {
            $this->error("Cannot create file $this->INI_FILE_NAME");
            return false;
        }
        
        //write php tags (security issue)
        $result = fwrite($fp, "; <?php exit; ?>\r\n");

        $groups = $this->readGroups();
        $group_cnt = count($groups);
        
        for ($i = 0; $i < $group_cnt; $i++) {
            $group_name = $groups[$i];
            //prevent empty line at beginning of ini-file
            if ($i == 0) {
                $res = sprintf("[%s]\r\n", $group_name);
            } else {
                $res = sprintf("\r\n[%s]\r\n", $group_name);
            }
            
            $result = fwrite($fp, $res);
            $group = $this->readGroup($group_name);
            
            for (reset($group); $key = key($group);next($group)) {
                $res = sprintf("%s = %s\r\n", $key, "\"" . $group[$key] . "\"");
                $result = fwrite($fp, $res);
            }
        }
        
        
        fclose($fp);

        return true;
    }

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.

$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