ilLoggingConfigStoredObjective Class Reference

Inheritance diagram for ilLoggingConfigStoredObjective:

Collaboration diagram for ilLoggingConfigStoredObjective:

Public Member Functions
	__construct (\ilLoggingSetupConfig $config)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Protected Attributes
	$config

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilLoggingConfigStoredObjective::__construct

(

\ilLoggingSetupConfig

$config

)

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

      {
        $this->config = $config;
    }

References $config.

Member Function Documentation

achieve()

ilLoggingConfigStoredObjective::achieve

(

Setup\Environment

$environment

)

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

                                                            : Setup\Environment
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
        $ini->setVariable("log", "enabled", $this->config->isEnabled() ? "1" : "0");
        $ini->setVariable("log", "path", dirname($this->config->getPathToLogfile()));
        $ini->setVariable("log", "file", basename($this->config->getPathToLogfile()));
        $ini->setVariable("log", "error_path", $this->config->getErrorlogDir());
 
        if (!$ini->write()) {
            throw new Setup\UnachievableException("Could not write ilias.ini.php");
        }
 
        return $environment;
    }

References $ini.

getHash()

ilLoggingConfigStoredObjective::getHash

(

)

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

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

getLabel()

ilLoggingConfigStoredObjective::getLabel

(

)

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

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

getPreconditions()

ilLoggingConfigStoredObjective::getPreconditions

(

Setup\Environment

$environment

)

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

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

isApplicable()

ilLoggingConfigStoredObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

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

                                                                 : bool
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
        $enabled = $this->config->isEnabled() ? "1" : "0";
 
        return
            $ini->readVariable("log", "path") !== dirname($this->config->getPathToLogfile()) ||
            $ini->readVariable("log", "file") !== basename($this->config->getPathToLogfile()) ||
            $ini->readVariable("log", "error_path") !== $this->config->getErrorlogDir() ||
            $ini->readVariable("log", "enabled") !== $enabled
        ;
    }

References $ini.

isNotable()

ilLoggingConfigStoredObjective::isNotable

(

)

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

                                : bool
    {
        return false;
    }

Field Documentation

$config

ilLoggingConfigStoredObjective::$config

protected

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

Referenced by __construct().

---

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

• Services/Logging/classes/Setup/class.ilLoggingConfigStoredObjective.php