ilIniFile Class Reference

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 ". More...

Collaboration diagram for ilIniFile:

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

Data Fields
string	$INI_FILE_NAME = ""
	name of file More...
string	$ERROR = ""
	error var More...
array	$GROUPS = array()
	sections in ini-file More...
string	$CURRENT_GROUP = ""
	actual section More...

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 47 of file class.ilIniFile.php.

Constructor & Destructor Documentation

__construct()

ilIniFile::__construct

(

string

$a_ini_file_name

)

Constructor.

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

References error().

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

        $this->INI_FILE_NAME = $a_ini_file_name;
    }

Here is the call graph for this function:

Member Function Documentation

addGroup()

ilIniFile::addGroup

(

string

$a_group_name

)

adds a new group

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

References error(), and groupExists().

Referenced by ilGlobalCacheSettingsAdapter\storeToIniFile().

                                                  : bool
    {
        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

(

string

$a_errmsg

)

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

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

                                           : bool
    {
        $this->ERROR = $a_errmsg;

        return true;
    }

Here is the caller graph for this function:

getError()

ilIniFile::getError

(

)

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

References $ERROR.

                              : string
    {
        return $this->ERROR;
    }

getGroupCount()

ilIniFile::getGroupCount

(

)

returns number of groups

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

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

groupExists()

ilIniFile::groupExists

(

string

$a_group_name

)

checks if a group exists

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

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

                                                     : bool
    {
        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

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

References Vendor\Package\$e, and error().

Referenced by read().

                           : bool
    {
        try {
            $ini_file_readable = is_readable($this->INI_FILE_NAME);
            if (!$ini_file_readable) {
                $this->error("file_not_accessible");
                return false;
            }
            $this->GROUPS = parse_ini_file($this->INI_FILE_NAME, true);
            if (!$this->GROUPS) {
                $this->error("error_parseing_inifile");
                return false;
            }
        } catch (Exception $e) {
            $this->error($e->getMessage());
            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

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

References error(), and parse().

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

Here is the call graph for this function:

readGroup()

ilIniFile::readGroup

(

string

$a_group_name

)

returns an associative array of the variables in one group

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

References error(), and groupExists().

Referenced by ilGlobalCacheSettingsAdapter\readFromIniFile(), show(), and write().

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

        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

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

References ILIAS\User\Profile\next.

Referenced by show(), and write().

                                : array
    {
        $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	(	string	$a_group,
		string	$a_var_name
	)

reads a single variable from a group

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

References error().

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

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

        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

(

string

$a_group_name

)

removes a group

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

References error(), and groupExists().

Referenced by ilGlobalCacheSettingsAdapter\storeToIniFile().

                                                     : bool
    {
        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	(	string	$a_group_name,
		string	$a_var_name,
		string	$a_var_value
	)

sets a variable in a group

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

References error(), and groupExists().

Referenced by ilGlobalCacheSettingsAdapter\storeToIniFile().

                                                                                              : bool
    {
        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

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

References ILIAS\User\Profile\next, readGroup(), and readGroups().

                          : string
    {
        $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	(	string	$a_group,
		string	$a_var_name
	)

returns if a variable exists or not

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

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

write()

ilIniFile::write

(

)

save ini-file-data to filesystem

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

References $res, error(), ILIAS\User\Profile\next, readGroup(), and readGroups().

Referenced by ilGlobalCacheSettingsAdapter\storeToIniFile().

                           : bool
    {
        $fp = fopen($this->INI_FILE_NAME, "wb");

        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

string ilIniFile::$CURRENT_GROUP = ""

actual section

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

$ERROR

string ilIniFile::$ERROR = ""

error var

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

Referenced by getError().

$GROUPS

array ilIniFile::$GROUPS = array()

sections in ini-file

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

$INI_FILE_NAME

string ilIniFile::$INI_FILE_NAME = ""

name of file

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

---

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

• components/ILIAS/Init/classes/class.ilIniFile.php