ILIAS\Setup\CLI\ConfigReader Class Reference

Read a json-formatted config from a file and overwrite some fields. More...

Collaboration diagram for ILIAS\Setup\CLI\ConfigReader:

Public Member Functions
	__construct (JsonParser $json_parser, string $base_dir=null)
	readConfigFile (string $name, array $overwrites=[])
	TODO: We could use the "give me a transformation and I'll give you your result" pattern from the input paper here. More...

Protected Member Functions
	applyOverwrites (array $json, array $overwrites)
	getRealFilename (string $name)

Protected Attributes
JsonParser	$json_parser
string	$base_dir

Detailed Description

Read a json-formatted config from a file and overwrite some fields.

Definition at line 35 of file ConfigReader.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\CLI\ConfigReader::__construct	(	JsonParser	$json_parser,
		string	$base_dir = null
	)

Definition at line 40 of file ConfigReader.php.

References ILIAS\Setup\CLI\ConfigReader\$json_parser.

    {
        $this->json_parser = $json_parser;
        $this->base_dir = $base_dir ?? getcwd();
    }

Member Function Documentation

applyOverwrites()

ILIAS\Setup\CLI\ConfigReader::applyOverwrites ( array  $json, array  $overwrites  )

protected

Definition at line 76 of file ConfigReader.php.

References $path.

Referenced by ILIAS\Setup\CLI\ConfigReader\readConfigFile().

                                                                      : array
    {
        $replacer = null;
        $replacer = function ($subject, $path, $value) use (&$replacer) {
            if (count($path) === 0) {
                return $value;
            }
            $cur = array_shift($path);
            $subject[$cur] = $replacer($subject[$cur] ?? [], $path, $value);
            return $subject;
        };

        foreach ($overwrites as $path => $value) {
            $path = explode(".", (string) $path);
            $json = $replacer($json, $path, $value);
        }

        return $json;
    }

Here is the caller graph for this function:

getRealFilename()

ILIAS\Setup\CLI\ConfigReader::getRealFilename ( string  $name )

protected

Definition at line 96 of file ConfigReader.php.

Referenced by ILIAS\Setup\CLI\ConfigReader\readConfigFile().

                                                    : string
    {
        if (in_array($name[0], ["/", "\\"])) {
            return $name;
        }
        return $this->base_dir . "/" . $name;
    }

Here is the caller graph for this function:

readConfigFile()

ILIAS\Setup\CLI\ConfigReader::readConfigFile	(	string	$name,
		array	$overwrites = []
	)

TODO: We could use the "give me a transformation and I'll give you your result" pattern from the input paper here.

Parameters

array

$overwrites

is a list of fields that should be overwritten with with the contained variables. The keys define which field (e.g. "a.b.c") should be overwritten with which value.

Definition at line 55 of file ConfigReader.php.

References ILIAS\Setup\CLI\ConfigReader\applyOverwrites(), and ILIAS\Setup\CLI\ConfigReader\getRealFilename().

                                                                        : array
    {
        $name = $this->getRealFilename($name);
        if (!is_readable($name)) {
            throw new \InvalidArgumentException(
                "Config-file '$name' does not exist or is not readable."
            );
        }
        $json = $this->json_parser->parse(
            file_get_contents($name),
            JsonParser::PARSE_TO_ASSOC | JsonParser::DETECT_KEY_CONFLICTS
        );

        if (!is_array($json)) {
            throw new \InvalidArgumentException(
                "Could not find JSON-array in '$name'."
            );
        }
        return $this->applyOverwrites($json, $overwrites);
    }

Here is the call graph for this function:

Field Documentation

$base_dir

string ILIAS\Setup\CLI\ConfigReader::$base_dir

protected

Definition at line 38 of file ConfigReader.php.

$json_parser

JsonParser ILIAS\Setup\CLI\ConfigReader::$json_parser

protected

Definition at line 37 of file ConfigReader.php.

Referenced by ILIAS\Setup\CLI\ConfigReader\__construct().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Setup/src/CLI/ConfigReader.php