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

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

Referenced by ilObjCertificateSettingsGUI\__construct(), ilIniFile\__construct(), php4DOMDocument\__construct(), ilMailSearchCoursesGUI\__construct(), ilMailSearchGroupsGUI\__construct(), ilForumExportGUI\__construct(), ilContactGUI\__construct(), ilMailingListsGUI\__construct(), Mail_RFC822\_hasUnclosedBrackets(), Mail_RFC822\_splitAddresses(), Mail_RFC822\_splitCheck(), Mail_RFC822\_validateAddress(), addGroup(), GetId3\GetId3Core\analyze(), ilContactGUI\applyContactsTableFilter(), ilDBUpdate\applyCustomUpdates(), ilDBUpdate\applyHotfix(), ilDBUpdate\applyUpdate(), ilDBUpdate\applyUpdateNr(), ilObjForumGUI\askForPostActivationObject(), SMTP\authenticate(), ilContactGUI\changeContactsView(), ilSetup\checkDataDirSetup(), ilSetup\checkErrorLogSetup(), ilSetup\checkLogSetup(), ilSetup\checkPasswordSetup(), ilSetup\checkToolsSetup(), ilSetup\cloneFromSource(), ilObjForumGUI\confirmDeleteThreads(), ilObjForumGUI\confirmMergeThreadsObject(), ilObjTermsOfServiceGUI\confirmReset(), SMTP\connect(), ilClient\connect(), ilClient\create(), ilSetup\createDatabase(), ilObjForumGUI\createThreadObject(), ilObjForumGUI\deliverZipFileObject(), ilForumExportGUI\ensureThreadBelongsToForum(), ilObjForumGUI\ensureThreadBelongsToForum(), ilDBUpdate\execQuery(), ilObjCertificateSettingsGUI\executeCommand(), ilContactGUI\executeCommand(), ilMailSearchCoursesGUI\executeCommand(), ilMailSearchGroupsGUI\executeCommand(), Assetic\Filter\LessFilter\filterLoad(), ilClient\getError(), ilSetup\getError(), GetId3\GetId3Core\getHashdata(), ilClient\init(), ilSetup\init(), CAS_Client\isAuthenticated(), ilSetup\loginAsClient(), ilContactGUI\mailToUsers(), ilObjForumGUI\markPostReadObject(), ilObjForumGUI\markPostUnreadObject(), ilObjForumGUI\mergeThreadsObject(), ilSetup\newClient(), GetId3\GetId3Core\openfile(), ilIniFile\parse(), Mail_RFC822\parseAddressList(), ilMailingListsGUI\performDeleteMembers(), ilObjForumGUI\performDeleteThreadsObject(), ilObjForumGUI\performMoveThreadsObject(), ilObjForumGUI\performPostActivationObject(), ilObjForumGUI\publishDraftObject(), SMTP\quit(), ilObjForumGUI\quotePostObject(), ilIniFile\read(), ilDBUpdate\readDBUpdateFile(), readGroup(), ilDBUpdate\readLastUpdateFile(), readVariable(), removeGroup(), ilObjTermsOfServiceGUI\reset(), ilContactGUI\resetContactsTableFilter(), ilMailingListsGUI\saveAssignmentForm(), ilMailingListsGUI\saveForm(), ilSetup\saveMasterSetup(), ilSetup\saveNewClient(), ilObjTermsOfServiceGUI\saveSettings(), ilObjForumGUI\saveThreadSortingObject(), SMTP\sendCommand(), ilExternalFeed\setError(), ilChatroomServerConnectorMock\setError(), ilClient\setError(), SMTP\setError(), ilSetup\setPassword(), ilObjTermsOfServiceGUI\settings(), setVariable(), ilObjTermsOfServiceGUI\showAcceptanceHistory(), ilObjTermsOfServiceGUI\showAgreementByLanguage(), ilMailingListsGUI\showAssignmentForm(), ilContactGUI\showContacts(), ilMailingListsGUI\showForm(), ilObjForumGUI\showStatisticsObject(), ilObjForumGUI\toggleStickinessObject(), SMTP\turn(), ilSetup\updateMasterSettings(), ilObjForumGUI\updateThreadObject(), and ilIniFile\write().

Here is the caller graph for this function:

◆ getError()

getError ( )

returns error @access public

Returns: string

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

        {
                return $this->ERROR;
        }

References ilIniFile\$ERROR.

Referenced by trendClass\calculate().

Here is the caller graph for this function:

◆ getGroupCount()

getGroupCount ( )

returns number of groups @access public

Returns: integer

Definition at line 281 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 309 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 325 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 291 of file class.ilIniFile.php.

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

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 392 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(), and ilDB\initFromIniFile().

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 360 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 411 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 242 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 readGroup(), readGroups(), and sprintf.

Referenced by ilPersonalDesktopGUI\executeCommand(), ilChatroomBanGUI\executeDefault(), ilPersonalDesktopGUI\removeMember(), 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 379 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()