ilLoggingConfigStoredObjective Class Reference

Inheritance diagram for ilLoggingConfigStoredObjective:

Collaboration diagram for ilLoggingConfigStoredObjective:

Public Member Functions
	__construct (Config $config)
	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)

Protected Attributes
Config	$config

Detailed Description

Definition at line 26 of file class.ilLoggingConfigStoredObjective.php.

Constructor & Destructor Documentation

__construct()

ilLoggingConfigStoredObjective::__construct

(

Config

$config

)

Definition at line 30 of file class.ilLoggingConfigStoredObjective.php.

References $config.

    {
        $this->config = $config;
    }

Member Function Documentation

achieve()

ilLoggingConfigStoredObjective::achieve

(

Environment

$environment

)

Objectives can be achieved.

They might add resources to the environment when they have been achieved.

This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

Implements ILIAS\Setup\Objective.

Definition at line 57 of file class.ilLoggingConfigStoredObjective.php.

References $ini, and ILIAS\Setup\Environment\getResource().

                                                     : Environment
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);

        $logPath = '';
        $logFile = '';
        if ($this->config->getPathToLogfile()) {
            $logPath = dirname($this->config->getPathToLogfile());
            $logFile = basename($this->config->getPathToLogfile());
        }

        $ini->setVariable("log", "enabled", $this->config->isEnabled() ? "1" : "0");
        $ini->setVariable("log", "path", $logPath);
        $ini->setVariable("log", "file", $logFile);
        $ini->setVariable(
            "log",
            "error_path",
            $this->config->getErrorlogDir() ?? ''
        );

        if (!$ini->write()) {
            throw new UnachievableException("Could not write ilias.ini.php");
        }

        return $environment;
    }

Here is the call graph for this function:

getHash()

ilLoggingConfigStoredObjective::getHash

(

)

Get a hash for this objective.

The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implements ILIAS\Setup\Objective.

Definition at line 35 of file class.ilLoggingConfigStoredObjective.php.

                             : string
    {
        return hash("sha256", self::class);
    }

getLabel()

ilLoggingConfigStoredObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 40 of file class.ilLoggingConfigStoredObjective.php.

                              : string
    {
        return "Fill ini with settings for Services/Logging";
    }

getPreconditions()

ilLoggingConfigStoredObjective::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 50 of file class.ilLoggingConfigStoredObjective.php.

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

isApplicable()

ilLoggingConfigStoredObjective::isApplicable

(

Environment

$environment

)

Implements ILIAS\Setup\Objective.

Definition at line 87 of file class.ilLoggingConfigStoredObjective.php.

References $ini, and ILIAS\Setup\Environment\getResource().

                                                          : bool
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
        $enabled = $this->config->isEnabled() ? "1" : "0";

        $logPath = '';
        $logFile = '';
        if ($this->config->getPathToLogfile()) {
            $logPath = dirname($this->config->getPathToLogfile());
            $logFile = basename($this->config->getPathToLogfile());
        }

        return
            $ini->readVariable("log", "path") !== $logPath ||
            $ini->readVariable("log", "file") !== $logFile ||
            $ini->readVariable("log", "error_path") !== $this->config->getErrorlogDir() ||
            $ini->readVariable("log", "enabled") !== $enabled
        ;
    }

Here is the call graph for this function:

isNotable()

ilLoggingConfigStoredObjective::isNotable

(

)

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 45 of file class.ilLoggingConfigStoredObjective.php.

                               : bool
    {
        return false;
    }

Field Documentation

$config

Config ilLoggingConfigStoredObjective::$config

protected

Definition at line 28 of file class.ilLoggingConfigStoredObjective.php.

Referenced by __construct().

---

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

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