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

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.

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

References error().

Here is the call graph for this function:

Member Function Documentation

parse()

ilIniFile::parse

(

)

load and parse an inifile

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

                           : 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;
    }

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

Referenced by read().

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.

                          : 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;
    }

References error(), and parse().

Here is the call graph for this function:

write()

ilIniFile::write

(

)

save ini-file-data to filesystem

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

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

Referenced by ilGlobalCacheSettingsAdapter\storeToIniFile().

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