ilBackgroundTasksMetricsCollectedObjective Class Reference

Inheritance diagram for ilBackgroundTasksMetricsCollectedObjective:

Collaboration diagram for ilBackgroundTasksMetricsCollectedObjective:

Public Member Functions
	getTentativePreconditions (Environment $environment)
	collectFrom (Environment $environment, Storage $storage)
Public Member Functions inherited from ILIAS\Setup\Metrics\CollectedObjective
	__construct (Storage $storage)
	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 (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	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...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Additional Inherited Members
Protected Member Functions inherited from ILIAS\Setup\Metrics\CollectedObjective
	collectFrom (Setup\Environment $environment, Storage $storage)
	Attempt to gather metrics based on the provided environment. More...
	getTentativePreconditions (Setup\Environment $environment)
	Give preconditions that might or might not be fullfilled. More...
Protected Attributes inherited from ILIAS\Setup\Metrics\CollectedObjective
Storage	$storage

Detailed Description

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

Member Function Documentation

collectFrom()

ilBackgroundTasksMetricsCollectedObjective::collectFrom	(	Environment	$environment,
		Storage	$storage
	)

Definition at line 35 of file class.ilBackgroundTasksMetricsCollectedObjective.php.

                                                                           : void
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
        if (!$ini) {
            return;
        }
 
        $storage->storeConfigText(
            "type",
            $ini->readVariable("background_tasks", "concurrency"),
            "The type of execution used for background tasks"
        );
        $storage->storeConfigGauge(
            "max_number_of_concurrent_tasks",
            (int) $ini->readVariable("background_tasks", "number_of_concurrent_tasks"),
            "The maximum amount of concurrent tasks used to run background tasks."
        );
    }

References $ini, ILIAS\Setup\Metrics\CollectedObjective\$storage, ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Metrics\Storage\storeConfigGauge(), and ILIAS\Setup\Metrics\Storage\storeConfigText().

Here is the call graph for this function:

getTentativePreconditions()

ilBackgroundTasksMetricsCollectedObjective::getTentativePreconditions

(

Environment

$environment

)

Returns

\ilIniFilesLoadedObjective[]

Definition at line 28 of file class.ilBackgroundTasksMetricsCollectedObjective.php.

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

---

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

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