Data Structures
class	ilIniFile
	INIFile Parser. More...

Functions
	show ()
	returns the content of IniFile @access public More...

	getGroupCount ()
	returns number of groups @access public More...

	readGroups ()
	returns an array with the names of all the groups @access public More...

	groupExists ($a_group_name)
	checks if a group exists @access public More...

	readGroup ($a_group_name)
	returns an associative array of the variables in one group @access public More...

	addGroup ($a_group_name)
	adds a new group @access public More...

	removeGroup ($a_group_name)
	removes a group @access public More...

	variableExists ($a_group, $a_var_name)
	returns if a variable exists or not @access public More...

	readVariable ($a_group, $a_var_name)
	reads a single variable from a group @access public More...

	setVariable ($a_group_name, $a_var_name, $a_var_value)
	sets a variable in a group @access public More...

	error ($a_errmsg)
	set error message @access public More...

	getError ()
	returns error @access public More...

Function Documentation

◆ addGroup()

addGroup ( $a_group_name )

adds a new group @access public

Parameters

string group name

Returns: boolean

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

    {
        if ($this->groupExists($a_group_name)) {
            $this->error("Group '" . $a_group_name . "' exists");
            return false;
        }
 
        $this->GROUPS[$a_group_name] = array();
        return true;
    }

References error(), and groupExists().

Here is the call graph for this function:

◆ error()

error ( $a_errmsg )

set error message @access public

Parameters

string

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

    {
        $this->ERROR = $a_errmsg;
 
        return true;
    }

Here is the caller graph for this function:

◆ getError()

getError ( )

returns error @access public

Returns: string

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

    {
        return $this->ERROR;
    }

References ilIniFile\$ERROR.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Trend\Trend\calculate().

Here is the caller graph for this function:

◆ getGroupCount()

getGroupCount ( )

returns number of groups @access public

Returns: integer

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

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

◆ groupExists()

groupExists ( $a_group_name )

checks if a group exists @access public

Parameters

string group name

Returns: boolean

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

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

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

Here is the caller graph for this function:

◆ readGroup()

readGroup ( $a_group_name )

returns an associative array of the variables in one group @access public

Parameters

string group name

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

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

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

References error(), and groupExists().

Referenced by show(), and ilIniFile\write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readGroups()

readGroups ( )

returns an array with the names of all the groups @access public

Returns: array groups

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

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

References $key.

Referenced by show(), and ilIniFile\write().

Here is the caller graph for this function:

◆ readVariable()

readVariable	(	$a_group,
		$a_var_name
	)

reads a single variable from a group @access public

Parameters

string	group name
string	value

Returns: mixed return value string or boolean 'false' on failure

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

    {
        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]);
    }

References error().

Referenced by ilSoapInstallationInfoXMLWriter\__buildInstallationInfo(), ilMail\_getInstallationSignature(), and ilChatroomConfigFileHandler\getClientFileContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeGroup()

removeGroup ( $a_group_name )

removes a group @access public

Parameters

string group name

Returns: boolean

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

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

References error(), and groupExists().

Here is the call graph for this function:

◆ setVariable()

setVariable	(	$a_group_name,
		$a_var_name,
		$a_var_value
	)

sets a variable in a group @access public

Parameters

string
string
string

Returns: boolean

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

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

References error(), and groupExists().

Here is the call graph for this function:

◆ show()

show ( )

returns the content of IniFile @access public

Returns: string content

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

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

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

Referenced by ilPersonalDesktopGUI\executeCommand(), ilCalendarMonthGUI\getHTML(), ilPersonalDesktopGUI\jumpToMemberships(), ilPersonalDesktopGUI\jumpToSelectedItems(), and ilTemplate\show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ variableExists()

variableExists	(	$a_group,
		$a_var_name
	)

returns if a variable exists or not @access public

Parameters

string	group name
string	value

Returns: mixed return true if value exists or false

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

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

Data Structures

Functions

Function Documentation

◆ addGroup()

◆ error()

◆ getError()

◆ getGroupCount()

◆ groupExists()

◆ readGroup()

◆ readGroups()

◆ readVariable()

◆ removeGroup()

◆ setVariable()

◆ show()

◆ variableExists()