ilLoggingMetricsCollectedObjective Class Reference

Inheritance diagram for ilLoggingMetricsCollectedObjective:

Collaboration diagram for ilLoggingMetricsCollectedObjective:

Protected Member Functions
	getTentativePreconditions (Environment $environment)
	collectFrom (Environment $environment, Storage $storage)
Protected Member Functions inherited from ILIAS\Setup\Metrics\CollectedObjective
	collectFrom (Setup\Environment $environment, Storage $storage)
	Attempt to gather metrics based on the provided environment. More...
	getTentativePreconditions (Setup\Environment $environment)
	Give preconditions that might or might not be fullfilled. More...

Additional Inherited Members
Public Member Functions inherited from ILIAS\Setup\Metrics\CollectedObjective
	__construct (Storage $storage)
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...
Protected Attributes inherited from ILIAS\Setup\Metrics\CollectedObjective
Storage	$storage

Detailed Description

Definition at line 25 of file class.ilLoggingMetricsCollectedObjective.php.

Member Function Documentation

collectFrom()

ilLoggingMetricsCollectedObjective::collectFrom ( Environment  $environment, Storage  $storage  )

protected

Definition at line 34 of file class.ilLoggingMetricsCollectedObjective.php.

                                                                              : void
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
        if (!$ini) {
            return;
        }
 
        $storage->storeConfigBool(
            "enable",
            (bool) $ini->readVariable("log", "enabled"),
            "Is the logging enabled on the installation?"
        );
        $storage->storeConfigText(
            "path_to_logfile",
            $ini->readVariable("log", "path") . "/" . $ini->readVariable("log", "file"),
            "The path to the logfile."
        );
        $storage->storeConfigText(
            "errorlog_dir",
            $ini->readVariable("log", "error_path"),
            "The path to the directory where error protocols are stored."
        );
    }

References $ini, ILIAS\Setup\Metrics\CollectedObjective\$storage, ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Metrics\Storage\storeConfigBool(), and ILIAS\Setup\Metrics\Storage\storeConfigText().

Here is the call graph for this function:

getTentativePreconditions()

ilLoggingMetricsCollectedObjective::getTentativePreconditions ( Environment  $environment )

protected

Definition at line 27 of file class.ilLoggingMetricsCollectedObjective.php.

                                                                          : array
    {
        return [
            new ilIniFilesLoadedObjective()
        ];
    }

---

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

• components/ILIAS/Logging/classes/Setup/class.ilLoggingMetricsCollectedObjective.php