This class attempt to achieve a set of database update steps. More...

Inheritance diagram for ilDatabaseUpdateStepsExecutedObjective:

Collaboration diagram for ilDatabaseUpdateStepsExecutedObjective:

Public Member Functions
	__construct (protected ilDatabaseUpdateSteps $steps)

	getHash ()
	The hash for the objective is calculated over the classname and the steps that are contained. More...

	getLabel ()
	Get a label that describes this objective. More...

	isNotable ()
	@inheritdocs More...

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

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

	isApplicable (Environment $environment)
	@inheritDoc 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...

	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Data Fields
const	STEP_METHOD_PREFIX = "step_"

Protected Member Functions
	throwStepNotFinishedException (int $started, int $finished)

Protected Attributes
string	$steps_class

Detailed Description

This class attempt to achieve a set of database update steps.

Look into the interface ilDatabaseUpdateSteps for further instructions.

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

Constructor & Destructor Documentation

◆ __construct()

ilDatabaseUpdateStepsExecutedObjective::__construct ( protected ilDatabaseUpdateSteps $steps )

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

    {
        $this->steps_class = $this->steps::class;
    }

Member Function Documentation

◆ achieve()

ilDatabaseUpdateStepsExecutedObjective::achieve ( Environment $environment )

@inheritdocs

Implements ILIAS\Setup\Objective.

Reimplemented in ilDataCollectionObjective.

Definition at line 78 of file class.ilDatabaseUpdateStepsExecutedObjective.php.

                                                     : Environment
    {
        $execution_log = $environment->getResource(ilDatabaseUpdateStepExecutionLog::class);
        $step_reader = $environment->getResource(ilDBStepReader::class);
 
        $last_started_step = $execution_log->getLastStartedStep($this->steps_class);
        $last_finished_step = $execution_log->getLastFinishedStep($this->steps_class);
        if ($last_started_step !== $last_finished_step) {
            $this->throwStepNotFinishedException($last_started_step, $last_finished_step);
            throw new LogicException(
                "ilDatabaseUpdateStepExecutionLog::throwStepNotFinishedException should throw an exception."
            );
        }
 
        if ($last_finished_step === $step_reader->getLatestStepNumber($this->steps_class, self::STEP_METHOD_PREFIX)) {
            return $environment;
        }
 
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
        $this->steps->prepare($db);
 
        $steps = $step_reader->readStepNumbers($this->steps_class, self::STEP_METHOD_PREFIX);
        foreach ($steps as $step) {
            if ($step <= $last_finished_step) {
                continue;
            }
            $execution_log->started($this->steps_class, $step);
            $method = self::STEP_METHOD_PREFIX . $step;
            $this->steps->$method();
            $execution_log->finished($this->steps_class, $step);
        }
 
        return $environment;
    }

References ILIAS\Setup\Environment\getResource(), and throwStepNotFinishedException().

Here is the call graph for this function:

◆ getHash()

ilDatabaseUpdateStepsExecutedObjective::getHash ( )

final

The hash for the objective is calculated over the classname and the steps that are contained.

Implements ILIAS\Setup\Objective.

Definition at line 41 of file class.ilDatabaseUpdateStepsExecutedObjective.php.

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

◆ getLabel()

ilDatabaseUpdateStepsExecutedObjective::getLabel ( )

final

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 49 of file class.ilDatabaseUpdateStepsExecutedObjective.php.

                                    : string
    {
        return "Database update steps in $this->steps_class.";
    }

◆ getPreconditions()

ilDatabaseUpdateStepsExecutedObjective::getPreconditions ( Environment $environment )

@inheritdocs

Implements ILIAS\Setup\Objective.

Reimplemented in ilDataCollectionObjective, and ilFileObjectRBACDatabase.

Definition at line 65 of file class.ilDatabaseUpdateStepsExecutedObjective.php.

                                                              : array
    {
        return [
            new ilNoMajorVersionSkippedConditionObjective(new Factory()),
            new ilDBStepExecutionDBExistsObjective(),
            new ilDatabaseUpdatedObjective(),
            new ilDBStepReaderExistsObjective()
        ];
    }

◆ isApplicable()

ilDatabaseUpdateStepsExecutedObjective::isApplicable ( Environment $environment )

@inheritDoc

Implements ILIAS\Setup\Objective.

Definition at line 116 of file class.ilDatabaseUpdateStepsExecutedObjective.php.

                                                          : bool
    {
        $execution_log = $environment->getResource(ilDatabaseUpdateStepExecutionLog::class);
        $step_reader = $environment->getResource(ilDBStepReader::class);
 
        return $execution_log->getLastFinishedStep($this->steps_class) !== $step_reader->getLatestStepNumber(
            $this->steps_class,
            self::STEP_METHOD_PREFIX
        );
    }

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

◆ isNotable()

ilDatabaseUpdateStepsExecutedObjective::isNotable ( )

final

@inheritdocs

Implements ILIAS\Setup\Objective.

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

                                     : bool
    {
        return true;
    }

◆ throwStepNotFinishedException()

ilDatabaseUpdateStepsExecutedObjective::throwStepNotFinishedException	(	int	$started,
		int	$finished
	)

protected

Definition at line 127 of file class.ilDatabaseUpdateStepsExecutedObjective.php.

                                                                                 : void
    {
        throw new RuntimeException(
            "For update steps in $this->steps_class: step $started was started " .
            "last, but step $finished was finished last. Aborting because of that " .
            "mismatch."
        );
    }

Referenced by achieve().

Here is the caller graph for this function:

Field Documentation

◆ $steps_class

string ilDatabaseUpdateStepsExecutedObjective::$steps_class

protected

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

◆ STEP_METHOD_PREFIX

const ilDatabaseUpdateStepsExecutedObjective::STEP_METHOD_PREFIX = "step_"

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

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

components/ILIAS/Database/classes/Setup/class.ilDatabaseUpdateStepsExecutedObjective.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ achieve()

◆ getHash()

◆ getLabel()

◆ getPreconditions()

◆ isApplicable()

◆ isNotable()

◆ throwStepNotFinishedException()

Field Documentation

◆ $steps_class

◆ STEP_METHOD_PREFIX