class.ilIniFile.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
class ilIniFile
{
    public string $INI_FILE_NAME = "";
 
    public string $ERROR = "";
 
    public array $GROUPS = array();
 
    public string $CURRENT_GROUP = "";
 
    public function __construct(string $a_ini_file_name)
    {
        //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;
    }
 
    public function read(): 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;
    }
 
    public function parse(): 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;
    }
 
    public function write(): bool
    {
        $fp = fopen($this->INI_FILE_NAME, "wb");
 
        if (empty($fp)) {
            $this->error("Cannot create file $this->INI_FILE_NAME");
            return false;
        }
 
        //write php tags (security issue)
        $result = fwrite($fp, "; <?php exit; ?>\r\n");
 
        $groups = $this->readGroups();
        $group_cnt = count($groups);
 
        for ($i = 0; $i < $group_cnt; $i++) {
            $group_name = $groups[$i];
            //prevent empty line at beginning of ini-file
            if ($i === 0) {
                $res = sprintf("[%s]\r\n", $group_name);
            } else {
                $res = sprintf("\r\n[%s]\r\n", $group_name);
            }
 
            $result = fwrite($fp, $res);
            $group = $this->readGroup($group_name);
 
            for (reset($group); $key = key($group); next($group)) {
                $res = sprintf("%s = %s\r\n", $key, "\"" . $group[$key] . "\"");
                $result = fwrite($fp, $res);
            }
        }
 
        fclose($fp);
        return true;
    }
 
    public function show(): 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;
    }
 
    public function getGroupCount(): int
    {
        return count($this->GROUPS);
    }
 
    public function readGroups(): array
    {
        $groups = array();
 
        for (reset($this->GROUPS); $key = key($this->GROUPS); next($this->GROUPS)) {
            $groups[] = $key;
        }
 
        return $groups;
    }
 
    public function groupExists(string $a_group_name): bool
    {
        if (!isset($this->GROUPS[$a_group_name])) {
            return false;
        }
 
        return true;
    }
 
    public function readGroup(string $a_group_name): array
    {
        if (!$this->groupExists($a_group_name)) {
            $this->error("Group '" . $a_group_name . "' does not exist");
            return [];
        }
 
        return $this->GROUPS[$a_group_name];
    }
 
    public function addGroup(string $a_group_name): bool
    {
        if ($this->groupExists($a_group_name)) {
            $this->error("Group '" . $a_group_name . "' exists");
            return false;
        }
 
        $this->GROUPS[$a_group_name] = array();
        return true;
    }
 
    public function removeGroup(string $a_group_name): 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;
    }
 
    public function variableExists(string $a_group, string $a_var_name): bool
    {
        return isset($this->GROUPS[$a_group][$a_var_name]);
    }
 
    public function readVariable(string $a_group, string $a_var_name): 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]);
    }
 
    public function setVariable(string $a_group_name, string $a_var_name, string $a_var_value): 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;
    }
 
    public function error(string $a_errmsg): bool
    {
        $this->ERROR = $a_errmsg;
 
        return true;
    }
 
    public function getError(): string
    {
        return $this->ERROR;
    }
} //END class.ilIniFile