ilGlobalCacheConfigStoredObjective Class Reference

Inheritance diagram for ilGlobalCacheConfigStoredObjective:

Collaboration diagram for ilGlobalCacheConfigStoredObjective:

Public Member Functions
	__construct (protected \ilGlobalCacheSettingsAdapter $settings)
	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...
	isApplicable (Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	achieve (Environment $environment)
	Objectives can be achieved. More...

Detailed Description

Definition at line 23 of file class.ilGlobalCacheConfigStoredObjective.php.

Constructor & Destructor Documentation

__construct()

ilGlobalCacheConfigStoredObjective::__construct

(

protected \ilGlobalCacheSettingsAdapter

$settings

)

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

    {
    }

Member Function Documentation

getHash()

ilGlobalCacheConfigStoredObjective::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 29 of file class.ilGlobalCacheConfigStoredObjective.php.

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

getLabel()

ilGlobalCacheConfigStoredObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

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

                              : string
    {
        return "Store configuration of components/ILIAS/GlobalCache_";
    }

getPreconditions()

ilGlobalCacheConfigStoredObjective::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 44 of file class.ilGlobalCacheConfigStoredObjective.php.

References ILIAS\Setup\Objective\achieve(), ILIAS\Setup\Environment\getResource(), and ILIAS\Repository\settings().

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

Here is the call graph for this function:

isApplicable()

ilGlobalCacheConfigStoredObjective::isApplicable

(

Environment

$environment

)

Implements ILIAS\Setup\Objective.

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

                                                          : bool
    {
        // The effort to check the whole ini file is too big here.
        return true;
    }

isNotable()

ilGlobalCacheConfigStoredObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

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

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/GlobalCache_/classes/Setup/class.ilGlobalCacheConfigStoredObjective.php