ilDatabaseUpdateStepsMetricsCollectedObjective Class Reference

Inheritance diagram for ilDatabaseUpdateStepsMetricsCollectedObjective:

Collaboration diagram for ilDatabaseUpdateStepsMetricsCollectedObjective:

Public Member Functions
	__construct (Storage $storage, ilDatabaseUpdateSteps $steps)
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
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
	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...

Data Fields
const	STEP_METHOD_PREFIX = "step_"

Protected Member Functions
	collectFrom (Environment $environment, Storage $storage)
	getTentativePreconditions (Environment $environment)
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
string	$step_class
Protected Attributes inherited from ILIAS\Setup\Metrics\CollectedObjective
Storage	$storage

Detailed Description

Definition at line 26 of file class.ilDatabaseUpdateStepsMetricsCollectedObjective.php.

Constructor & Destructor Documentation

__construct()

ilDatabaseUpdateStepsMetricsCollectedObjective::__construct	(	Storage	$storage,
		ilDatabaseUpdateSteps	$steps
	)

Definition at line 32 of file class.ilDatabaseUpdateStepsMetricsCollectedObjective.php.

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($storage);
        $this->step_class = $steps::class;
    }

Here is the call graph for this function:

Member Function Documentation

collectFrom()

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

protected

Definition at line 38 of file class.ilDatabaseUpdateStepsMetricsCollectedObjective.php.

References $version, ILIAS\Setup\Environment\getResource(), and ILIAS\Setup\Metrics\Storage\store().

                                                                              : void
    {
        $execution_log = $environment->getResource(ilDatabaseUpdateStepExecutionLog::class);
        $step_reader = $environment->getResource(ilDBStepReader::class);

        $version = new Metric(
            Metric::STABILITY_STABLE,
            Metric::TYPE_TEXT,
            (string) ($execution_log->getLastFinishedStep($this->step_class))
        );

        $available_version = new Metric(
            Metric::STABILITY_STABLE,
            Metric::TYPE_TEXT,
            (string) $step_reader->getLatestStepNumber($this->step_class, self::STEP_METHOD_PREFIX)
        );

        $update_required = new Metric(
            Metric::STABILITY_STABLE,
            Metric::TYPE_BOOL,
            $execution_log->getLastFinishedStep($this->step_class) !== $step_reader->getLatestStepNumber(
                $this->step_class,
                self::STEP_METHOD_PREFIX
            )
        );

        $collection = new Metric(
            Metric::STABILITY_STABLE,
            Metric::TYPE_COLLECTION,
            [
                "version" => $version,
                "available_version" => $available_version,
                "update_required" => $update_required
            ]
        );

        $storage->store($this->step_class, $collection);
    }

Here is the call graph for this function:

getHash()

ilDatabaseUpdateStepsMetricsCollectedObjective::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 87 of file class.ilDatabaseUpdateStepsMetricsCollectedObjective.php.

                             : string
    {
        return hash("sha256", static::class . $this->step_class);
    }

getLabel()

ilDatabaseUpdateStepsMetricsCollectedObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 93 of file class.ilDatabaseUpdateStepsMetricsCollectedObjective.php.

References $step_class.

                              : string
    {
        return "Status of database update steps in " . $this->step_class;
    }

getTentativePreconditions()

ilDatabaseUpdateStepsMetricsCollectedObjective::getTentativePreconditions ( Environment  $environment )

protected

Definition at line 77 of file class.ilDatabaseUpdateStepsMetricsCollectedObjective.php.

                                                                          : array
    {
        return [
            new ilDatabaseInitializedObjective(),
            new ilDBStepExecutionDBExistsObjective(),
            new ilDBStepReaderExistsObjective()
        ];
    }

Field Documentation

$step_class

string ilDatabaseUpdateStepsMetricsCollectedObjective::$step_class

protected

Definition at line 30 of file class.ilDatabaseUpdateStepsMetricsCollectedObjective.php.

Referenced by getLabel().

STEP_METHOD_PREFIX

const ilDatabaseUpdateStepsMetricsCollectedObjective::STEP_METHOD_PREFIX = "step_"

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

---

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

• components/ILIAS/Database/classes/Setup/class.ilDatabaseUpdateStepsMetricsCollectedObjective.php