class.ilIniFile.php File Reference

Go to the source code of this file.

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

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

Referenced by ilPurchaseBaseGUI\__construct(), Mail_RFC822\_hasUnclosedBrackets(), Mail_RFC822\_splitAddresses(), Mail_RFC822\_splitCheck(), Mail_RFC822\_validateAddress(), ilPaymentCouponGUI\addCoupon(), addGroup(), ilDBUpdate\applyCustomUpdates(), ilDBUpdate\applyHotfix(), ilDBUpdate\applyUpdate(), ilDBUpdate\applyUpdateNr(), SMTP\authenticate(), ilClient\checkDatabaseHost(), ilSetup\checkDataDirSetup(), ilSetup\checkLogSetup(), ilSetup\checkPasswordSetup(), ilSetup\checkToolsSetup(), ilSetup\cloneFromSource(), SMTP\connect(), ilClient\connect(), ilClient\create(), ilSetup\createDatabase(), ilObjPaymentSettingsGUI\editVendorObject(), ilDBUpdate\execQuery(), ilPurchaseBaseGUI\getBill(), ilPurchaseBMFGUI\getCreditCard(), ilPurchaseBMFGUI\getDebitEntry(), ilClient\getError(), ilSetup\getError(), ilPurchaseBMFGUI\getPaymentType(), ilPurchaseBaseGUI\getPersonalData(), ilPurchaseBMFGUI\getPersonalData(), ilIniFile\ilIniFile(), ilClient\init(), ilSetup\init(), ilObjPaymentSettingsGUI\InvoiceNumberObject(), ilSetup\loginAsClient(), ilSetup\newClient(), ilIniFile\parse(), Mail_RFC822\parseAddressList(), ilObjPaymentSettingsGUI\performEditVendorObject(), php4DOMDocument\php4DOMDocument(), SMTP\quit(), OLERead\read(), ilIniFile\read(), ilDBUpdate\readDBUpdateFile(), readGroup(), ilDBUpdate\readLastUpdateFile(), readVariable(), removeGroup(), ilPaymentCouponGUI\saveCouponForm(), ilObjPaymentSettingsGUI\saveInvoiceNumberObject(), ilSetup\saveMasterSetup(), ilSetup\saveNewClient(), ilObjPaymentSettingsGUI\savePaypalSettingsObject(), SMTP\sendCommand(), ilExternalFeed\setError(), SMTP\setError(), ilSetup\setPassword(), setVariable(), ilPurchaseBMFGUI\showCreditCard(), ilPurchaseBMFGUI\showDebitEntry(), ilPurchaseBMFGUI\showPaymentType(), ilPurchaseBaseGUI\showPersonalData(), ilPurchaseBMFGUI\showPersonalData(), SMTP\turn(), ilSetup\updateMasterSettings(), and ilIniFile\write().

Here is the caller graph for this function:

getError()

getError

(

)

returns error @access public

Returns

string

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

        {
                return $this->ERROR;
        }

References ilIniFile\$ERROR.

getGroupCount()

getGroupCount

(

)

returns number of groups @access public

Returns

integer

Definition at line 311 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 339 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 355 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 321 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 422 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 390 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 441 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 272 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(), and readGroups().

Referenced by ilPersonalDesktopGUI\executeCommand(), 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 409 of file class.ilIniFile.php.

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