This encapsulate one database update step which is a method on some ilDatabaseUpdateSteps-object. More...

Inheritance diagram for ilDatabaseUpdateStep:

Collaboration diagram for ilDatabaseUpdateStep:

Public Member Functions
	__construct (ilDatabaseUpdateSteps $parent, int $num, Objective ... $preconditions)

	getHash ()
	@inheritdocs More...

Public Member Functions inherited from ILIAS\Setup\CallableObjective
	__construct (callable $callable, string $label, bool $is_notable, Objective ... $preconditions)

	getHash ()
	@inheritdocs More...

	getLabel ()
	@inheritdocs More...

	isNotable ()
	@inheritdocs More...

	getPreconditions (Environment $environment)
	@inheritdocs More...

	achieve (Environment $environment)
	@inheritdocs More...

	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...

Protected Attributes
	$class_name

	$method_name

Protected Attributes inherited from ILIAS\Setup\CallableObjective
	$callable

	$label

	$is_notable

	$preconditions

Detailed Description

This encapsulate one database update step which is a method on some ilDatabaseUpdateSteps-object.

This is a close collaborator of ilDatabaseUpdateSteps and should most probably not be used standalone.

Definition at line 16 of file class.ilDatabaseUpdateStep.php.

Constructor & Destructor Documentation

◆ __construct()

ilDatabaseUpdateStep::__construct	(	ilDatabaseUpdateSteps	$parent,
		int	$num,
		Objective ...	$preconditions
	)

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

      {
        $this->class_name = get_class($parent);
        $this->method_name = \ilDatabaseUpdateSteps::STEP_METHOD_PREFIX . $num;
        parent::__construct(
            function (Environment $env) use ($parent, $num) {
                $db = $env->getResource(Environment::RESOURCE_DATABASE);
                $log = $env->getResource(\ilDatabaseUpdateStepExecutionLog::class);
                if ($log) {
                    $log->started($this->class_name, $num);
                }
                call_user_func([$parent, $this->method_name], $db);
                if ($log) {
                    $log->finished($this->class_name, $num);
                }
            },
            "Database update step {$this->class_name}::{$this->method_name}",
            false,
            ...$preconditions
        );
    }

References $log, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Setup\Environment\getResource(), and ilDatabaseUpdateSteps\STEP_METHOD_PREFIX.

Here is the call graph for this function:

Member Function Documentation

◆ getHash()

ilDatabaseUpdateStep::getHash ( )

@inheritdocs

Reimplemented from ILIAS\Setup\CallableObjective.

Definition at line 57 of file class.ilDatabaseUpdateStep.php.

                              : string
    {
        return hash(
            "sha256",
            $this->class_name . "::" . $this->method_name
        );
    }

Field Documentation

◆ $class_name

ilDatabaseUpdateStep::$class_name

protected

Definition at line 21 of file class.ilDatabaseUpdateStep.php.

◆ $method_name

ilDatabaseUpdateStep::$method_name

protected

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

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

Services/Database/classes/Setup/class.ilDatabaseUpdateStep.php

Public Member Functions

Protected Attributes