ilBackgroundTasksConfigStoredObjective Class Reference

Inheritance diagram for ilBackgroundTasksConfigStoredObjective:

Collaboration diagram for ilBackgroundTasksConfigStoredObjective:

Public Member Functions
	__construct (protected ilBackgroundTasksSetupConfig $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)
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilBackgroundTasksConfigStoredObjective::__construct

(

protected ilBackgroundTasksSetupConfig

$config

)

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

    {
    }

Member Function Documentation

achieve()

ilBackgroundTasksConfigStoredObjective::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 54 of file class.ilBackgroundTasksConfigStoredObjective.php.

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

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

        if (!$ini->groupExists("background_tasks")) {
            $ini->addGroup("background_tasks");
        }

        $ini->setVariable("background_tasks", "concurrency", $this->config->getType());
        $ini->setVariable("background_tasks", "number_of_concurrent_tasks", $this->config->getMaxCurrentTasks());

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

        return $environment;
    }

Here is the call graph for this function:

getHash()

ilBackgroundTasksConfigStoredObjective::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.ilBackgroundTasksConfigStoredObjective.php.

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

getLabel()

ilBackgroundTasksConfigStoredObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

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

                              : string
    {
        return "Fill ini with settings for components/ILIAS/BackgroundTasks_";
    }

getPreconditions()

ilBackgroundTasksConfigStoredObjective::getPreconditions

(

Environment

$environment

)

Returns

[]

Implements ILIAS\Setup\Objective.

Definition at line 47 of file class.ilBackgroundTasksConfigStoredObjective.php.

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

isApplicable()

ilBackgroundTasksConfigStoredObjective::isApplicable

(

Environment

$environment

)

Implements ILIAS\Setup\Objective.

Definition at line 75 of file class.ilBackgroundTasksConfigStoredObjective.php.

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

                                                          : bool
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
        if (!$ini->groupExists("background_tasks")) {
            return true;
        }
        if ($ini->readVariable("background_tasks", "concurrency") !== $this->config->getType()) {
            return true;
        }
        return $ini->readVariable("background_tasks", "number_of_concurrent_tasks") !== $this->config->getMaxCurrentTasks();
    }

Here is the call graph for this function:

isNotable()

ilBackgroundTasksConfigStoredObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

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

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/BackgroundTasks_/classes/Setup/class.ilBackgroundTasksConfigStoredObjective.php