ILIAS\Setup\Metrics\CollectedObjective Class Reference

Base class to simplify collection of metrics. More...

Inheritance diagram for ILIAS\Setup\Metrics\CollectedObjective:

Collaboration diagram for ILIAS\Setup\Metrics\CollectedObjective:

Public Member Functions
	__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...

Protected Member Functions
	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
Storage	$storage

Detailed Description

Base class to simplify collection of metrics.

Definition at line 28 of file CollectedObjective.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\Metrics\CollectedObjective::__construct

(

Storage

$storage

)

Definition at line 32 of file CollectedObjective.php.

    {
        $this->storage = $storage;
    }

References ILIAS\Setup\Metrics\CollectedObjective\$storage.

Member Function Documentation

achieve()

ILIAS\Setup\Metrics\CollectedObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 82 of file CollectedObjective.php.

                                                           : Setup\Environment
    {
        $this->collectFrom($environment, $this->storage);
        return $environment;
    }

References ILIAS\Setup\Metrics\CollectedObjective\collectFrom().

Here is the call graph for this function:

collectFrom()

ILIAS\Setup\Metrics\CollectedObjective::collectFrom ( Setup\Environment  $environment, Storage  $storage  )

abstractprotected

Attempt to gather metrics based on the provided environment.

Make sure to be very cautious regarding expectations towards the environment. It might only be initialized partially or not be initialized at all, since preconditions might not have been met. This should be implemented with a best effort approach to gather as much metrics as possible even when the installation is damaged.

Referenced by ILIAS\Setup\Metrics\CollectedObjective\achieve().

Here is the caller graph for this function:

getHash()

ILIAS\Setup\Metrics\CollectedObjective::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 59 of file CollectedObjective.php.

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

getLabel()

ILIAS\Setup\Metrics\CollectedObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 64 of file CollectedObjective.php.

                              : string
    {
        return "Collect metrics: " . get_class($this);
    }

getPreconditions()

ILIAS\Setup\Metrics\CollectedObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 74 of file CollectedObjective.php.

                                                                    : array
    {
        return array_map(
            fn (Setup\Objective $o): \ILIAS\Setup\Objective\Tentatively => new Setup\Objective\Tentatively($o),
            $this->getTentativePreconditions($environment)
        );
    }

References ILIAS\Setup\Metrics\CollectedObjective\getTentativePreconditions().

Here is the call graph for this function:

getTentativePreconditions()

ILIAS\Setup\Metrics\CollectedObjective::getTentativePreconditions ( Setup\Environment  $environment )

abstractprotected

Give preconditions that might or might not be fullfilled.

Since collection of metrics should also work in (partially) broken installations the preconditions given here will only be tentatively fullfilled when collectFrom is called.

Returns

Setup\Objective[]

Referenced by ILIAS\Setup\Metrics\CollectedObjective\getPreconditions().

Here is the caller graph for this function:

isApplicable()

ILIAS\Setup\Metrics\CollectedObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 88 of file CollectedObjective.php.

                                                                : bool
    {
        // We want to always collect fresh metrics.
        return true;
    }

isNotable()

ILIAS\Setup\Metrics\CollectedObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 69 of file CollectedObjective.php.

                               : bool
    {
        return false;
    }

Field Documentation

$storage

Storage ILIAS\Setup\Metrics\CollectedObjective::$storage

protected

Definition at line 30 of file CollectedObjective.php.

Referenced by ILIAS\Setup\Metrics\CollectedObjective\__construct(), ilLoggingMetricsCollectedObjective\collectFrom(), and ilTreeMetricsCollectedObjective\collectFrom().

---

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

• src/Setup/Metrics/CollectedObjective.php