ilDatabaseUpdateStepsMetricsCollectedObjective Class Reference

Inheritance diagram for ilDatabaseUpdateStepsMetricsCollectedObjective:

Collaboration diagram for ilDatabaseUpdateStepsMetricsCollectedObjective:

Public Member Functions
	__construct (Storage $storage, ilDatabaseUpdateSteps $steps)
	getHash ()
	getLabel ()

Data Fields
const	STEP_METHOD_PREFIX = "step_"

Protected Member Functions
	collectFrom (Setup\Environment $environment, Storage $storage)
	getTentativePreconditions (Setup\Environment $environment)

Protected Attributes
string	$step_class

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

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

References ILIAS\GlobalScreen\Provider\__construct().

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

Here is the call graph for this function:

Member Function Documentation

collectFrom()

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

protected

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

References $version, 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

(

)

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

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

getLabel()

ilDatabaseUpdateStepsMetricsCollectedObjective::getLabel

(

)

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

References $step_class.

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

getTentativePreconditions()

ilDatabaseUpdateStepsMetricsCollectedObjective::getTentativePreconditions ( Setup\Environment  $environment )

protected

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

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

Field Documentation

$step_class

string ilDatabaseUpdateStepsMetricsCollectedObjective::$step_class

protected

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

Referenced by getLabel().

STEP_METHOD_PREFIX

const ilDatabaseUpdateStepsMetricsCollectedObjective::STEP_METHOD_PREFIX = "step_"

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

---

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

• Services/Database/classes/Setup/class.ilDatabaseUpdateStepsMetricsCollectedObjective.php