Stores configuration for the Utilities service (paths to various tools) in the according ini-fields. More...

Inheritance diagram for ilUtilitiesConfigStoredObjective:

Collaboration diagram for ilUtilitiesConfigStoredObjective:

Public Member Functions
	__construct (\ilUtilitiesSetupConfig $config)

	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Protected Attributes
	$config

Detailed Description

Stores configuration for the Utilities service (paths to various tools) in the according ini-fields.

Definition at line 11 of file class.ilUtilitiesConfigStoredObjective.php.

Constructor & Destructor Documentation

◆ __construct()

ilUtilitiesConfigStoredObjective::__construct ( \ilUtilitiesSetupConfig $config )

Definition at line 18 of file class.ilUtilitiesConfigStoredObjective.php.

      {
        $this->config = $config;
    }

References $config.

Member Function Documentation

◆ achieve()

ilUtilitiesConfigStoredObjective::achieve ( Setup\Environment $environment )

Definition at line 46 of file class.ilUtilitiesConfigStoredObjective.php.

                                                            : Setup\Environment
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
        $ini->setVariable("tools", "convert", $this->config->getPathToConvert());
        $ini->setVariable("tools", "zip", $this->config->getPathToZip());
        $ini->setVariable("tools", "unzip", $this->config->getPathToUnzip());
 
        if (!$ini->write()) {
            throw new Setup\UnachievableException("Could not write ilias.ini.php");
        }
 
        return $environment;
    }

References $ini.

◆ getHash()

ilUtilitiesConfigStoredObjective::getHash ( )

Definition at line 24 of file class.ilUtilitiesConfigStoredObjective.php.

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

◆ getLabel()

ilUtilitiesConfigStoredObjective::getLabel ( )

Definition at line 29 of file class.ilUtilitiesConfigStoredObjective.php.

                               : string
    {
        return "Store configuration of Services/Utilities";
    }

◆ getPreconditions()

ilUtilitiesConfigStoredObjective::getPreconditions ( Setup\Environment $environment )

Definition at line 39 of file class.ilUtilitiesConfigStoredObjective.php.

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

◆ isApplicable()

ilUtilitiesConfigStoredObjective::isApplicable ( Setup\Environment $environment )

@inheritDoc

Definition at line 64 of file class.ilUtilitiesConfigStoredObjective.php.

                                                                 : bool
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
        return
            $ini->readVariable("tools", "convert") !== $this->config->getPathToConvert() ||
            $ini->readVariable("tools", "zip") !== $this->config->getPathToZip() ||
            $ini->readVariable("tools", "unzip") !== $this->config->getPathToUnzip()
        ;
    }

References $ini.

◆ isNotable()

ilUtilitiesConfigStoredObjective::isNotable ( )

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

                                : bool
    {
        return false;
    }

Field Documentation

◆ $config

ilUtilitiesConfigStoredObjective::$config

protected

Definition at line 16 of file class.ilUtilitiesConfigStoredObjective.php.

Referenced by __construct().

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

Services/Utilities/classes/Setup/class.ilUtilitiesConfigStoredObjective.php

Public Member Functions

Protected Attributes