Data Structures
class	ilIniFile
	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...

Functions
	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 ()

Variables
return	true

Function Documentation

◆ addGroup()

addGroup ( string $a_group_name )

adds a new group

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

                                                  : bool
    {
        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().

Referenced by ilDatabaseSetupConfig\toMockIniFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ error()

error ( string $a_errmsg )

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

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

Here is the caller graph for this function:

◆ getError()

getError ( )

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

                              : string
    {
        return $this->ERROR;
    }

References ilIniFile\$ERROR.

Referenced by ILIAS\Refinery\getErrorMessage(), and ilDatabaseSetupConfig\toMockIniFile().

Here is the caller graph for this function:

◆ getGroupCount()

getGroupCount ( )

returns number of groups

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

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

Referenced by ilDatabaseSetupConfig\toMockIniFile().

Here is the caller graph for this function:

◆ groupExists()

groupExists ( string $a_group_name )

checks if a group exists

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

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

Referenced by addGroup(), readGroup(), removeGroup(), setVariable(), and ilDatabaseSetupConfig\toMockIniFile().

Here is the caller graph for this function:

◆ readGroup()

readGroup ( string $a_group_name )

returns an associative array of the variables in one group

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

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

References error(), and groupExists().

Referenced by show(), ilDatabaseSetupConfig\toMockIniFile(), 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

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

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

References ILIAS\User\Profile\ChangeMail\next.

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

Here is the caller graph for this function:

◆ readVariable()

readVariable	(	string	$a_group,
		string	$a_var_name
	)

reads a single variable from a group

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

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

References error().

Referenced by ilSoapInstallationInfoXMLWriter\buildInstallationInfo(), ilChatroomConfigFileHandler\getClientFileContent(), and ilDatabaseSetupConfig\toMockIniFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeGroup()

removeGroup ( string $a_group_name )

removes a group

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

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

References error(), and groupExists().

Referenced by ilDatabaseSetupConfig\toMockIniFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVariable()

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.

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

References error(), and groupExists().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

show ( )

returns the content of IniFile

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

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

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

Referenced by ilRepositorySearchGUI\performSearch(), ilNewsTimelineGUI\save(), ilDatabaseSetupConfig\toMockIniFile(), and ilNewsTimelineGUI\update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ variableExists()

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

Referenced by ilDatabaseSetupConfig\toMockIniFile().

Here is the caller graph for this function:

Variable Documentation

◆ true

return true

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

Referenced by assTextQuestionGUI\__construct(), ilObjCmiXapiVerificationAccess\_getCommands(), ilObjContentPageAccess\_getCommands(), ilObjForumAccess\_getCommands(), ilObjFileBasedLMAccess\_getCommands(), ilObjRootFolderAccess\_getCommands(), ilLPStatusCollection\_getCompleted(), ilLPStatusCollection\_getFailed(), ilEventItems\_isAssigned(), ilECSServerSettings\activeServerExists(), assClozeTest\calculateReachedPointsForSolution(), ilKprimChoiceWizardInputGUI\checkUploads(), ilFileSystemGUI\defineCommands(), ilDclTableEditGUI\delete(), ilFileDataForumDraftsRCImplementation\delete(), ilFileDataForumRCImplementation\delete(), ilObjTest\deliverPDFfromHTML(), ilObjectListGUI\determineProperties(), ilLPStatusCollection\determineStatus(), ILIAS\MetaData\Editor\Vocabulary\AdapterTest\doesSlotAllowCustomInputProvider(), ILIAS\MetaData\Editor\Vocabulary\AdapterTest\doesSlotHaveVocabulariesProvider(), ilWhiteListUrlValidatorTest\domainProvider(), ILIAS\Test\Presentation\TestScreenGUI\evaluateLauncherModalForm(), ilStudyProgrammeIndividualPlanTableGUI\fetchData(), ILIAS\Forum\Notification\ForumNotificationTable\getFilterFields(), ILIAS\Registration\RegistrationFilterComponent\getFilterFields(), ILIAS\Test\Participants\ParticipantTable\getFilterFields(), ilCourseVerificationTableGUI\getItems(), ilExerciseVerificationTableGUI\getItems(), ilSCORMVerificationTableGUI\getItems(), ilTestVerificationTableGUI\getItems(), ilLSLaunchlinksBuilder\getLinks(), ilAtomQueryLock\getLocksForDBInstance(), ILIAS\Test\Participants\ParticipantTable\getPostLoadFilters(), ilObjBibliographicListGUI\getProperties(), ilQuestionBrowserTableGUI\getSelectableColumns(), ilQuestionPoolPrintViewTableGUI\getSelectableColumns(), ILIAS\MetaData\Vocabularies\Dispatch\ActionsTest\getStandardRepo(), ILIAS\MainMenu\Provider\StandardTopItemsProvider\getStaticTopItems(), ilObjQuestionPoolGUI\getTabs(), ilGroupXMLParser\handlerBeginTag(), ilLPCollectionOfRepositoryObjects\hasGroupedItems(), ilTestSequenceRandomQuestionSet\hasRandomQuestionsForPass(), ilECSCourseMappingRule\hasRules(), ilPluginInfoTest\inactivityReasonTable(), ilQuestionCumulatedStatisticsTableGUI\initData(), ilPluginInfoTest\isActiveTruthTable(), ilMakeInstallationAccessibleObjective\isApplicable(), assFormulaQuestionResult\isCoprimeFraction(), ilECSParticipantSettings\isEnabled(), ilECSNodeMappingCmsExplorer\isItemChecked(), ilObjTest\isTestFinishedToViewResults(), ILIAS\MetaData\Editor\Vocabulary\AdapterTest\isValueInVocabulariesForSlotProvider(), CronJobScheduleTest\jobProvider(), ilLTIConsumeProviderList\loadUsedBy(), ilObjectDefinition\parsePluginData(), ilObjTest\processPrintoutput2FO(), ColumnTest\provideColumnFormats(), ilAdvancedMDSubstitution\read(), ilECSParticipantSetting\read(), ilWOPIEmbeddedApplicationGUI\return(), ilLPListOfSettingsGUI\saveSettings(), ilObjUserTrackingGUI\saveSettingsObject(), ilECSServerSettings\serverExists(), ilLearningSequenceMembershipGUI\showParticipantsToolbar(), ILIAS\Style\Content\Setup\ilStyleDBUpdateSteps\step_1(), ilSkillDBUpdateSteps\step_11(), ilIndividualAssessmentMembersStorageDBTest\test_createAssessmentMember(), ilMailTest\testExternalMailDeliveryWorksAsExpected(), ilLearningSequenceSettingsDBTest\testGetSettingsForWithExistingData(), ILIAS\Tests\Setup\Condition\ExternalConditionObjectiveTest\testNotExecutable(), CronJobScheduleTest\weeklyScheduleProvider(), and ilObject\withReferences().

Data Structures

Functions

Variables

Function Documentation

◆ addGroup()

◆ error()

◆ getError()

◆ getGroupCount()

◆ groupExists()

◆ readGroup()

◆ readGroups()

◆ readVariable()

◆ removeGroup()

◆ setVariable()

◆ show()

◆ variableExists()

Variable Documentation

◆ true