ilUtilitiesConfigStoredObjective Class Reference

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)

Protected Attributes
ilUtilitiesSetupConfig	$config

Detailed Description

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

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

Constructor & Destructor Documentation

__construct()

ilUtilitiesConfigStoredObjective::__construct

(

ilUtilitiesSetupConfig

$config

)

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

References $config.

    {
        $this->config = $config;
    }

Member Function Documentation

achieve()

ilUtilitiesConfigStoredObjective::achieve

(

Setup\Environment

$environment

)

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

References $ini.

                                                           : 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;
    }

getHash()

ilUtilitiesConfigStoredObjective::getHash

(

)

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

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

getLabel()

ilUtilitiesConfigStoredObjective::getLabel

(

)

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

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

getPreconditions()

ilUtilitiesConfigStoredObjective::getPreconditions

(

Setup\Environment

$environment

)

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

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

isApplicable()

ilUtilitiesConfigStoredObjective::isApplicable

(

Setup\Environment

$environment

)

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

References $ini.

                                                                : 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();
    }

isNotable()

ilUtilitiesConfigStoredObjective::isNotable

(

)

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

                               : bool
    {
        return false;
    }

Field Documentation

$config

ilUtilitiesSetupConfig ilUtilitiesConfigStoredObjective::$config

protected

Definition at line 29 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