Inheritance diagram for ilNoMajorVersionSkippedConditionObjective:

Collaboration diagram for ilNoMajorVersionSkippedConditionObjective:

Public Member Functions
	__construct (Data\Factory $data_factory)

	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)

Protected Attributes
Data Factory	$data_factory

Detailed Description

Definition at line 24 of file class.ilNoMajorVersionSkippedConditionObjective.php.

Constructor & Destructor Documentation

◆ __construct()

ilNoMajorVersionSkippedConditionObjective::__construct ( Data\Factory $data_factory )

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

References $data_factory.

     {
         $this->data_factory = $data_factory;
     }

Member Function Documentation

◆ achieve()

ilNoMajorVersionSkippedConditionObjective::achieve ( Setup\Environment $environment )

Definition at line 58 of file class.ilNoMajorVersionSkippedConditionObjective.php.

References ILIAS\LTI\ToolProvider\$settings, ILIAS\Setup\Environment\getResource(), ilVersionWrittenToSettingsObjective\ILIAS_VERSION_KEY, and ILIAS_VERSION_NUMERIC.

                                                            : Setup\Environment
     {
         $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
         $settings = $factory->settingsFor("common");
 
         $current_version_string = $settings->get(ilVersionWrittenToSettingsObjective::ILIAS_VERSION_KEY);
         $current_version = $this->data_factory->version($current_version_string);
         $target_version = $this->data_factory->version(ILIAS_VERSION_NUMERIC);
 
         if (($target_version->getMajor() - $current_version->getMajor()) > 1) {
             throw new Setup\NotExecutableException(
                 "Updates may only be performed from one major version to the " .
                 "next, no major versions may be skipped."
             );
         }
 
         return $environment;
     }

Here is the call graph for this function:

◆ getHash()

ilNoMajorVersionSkippedConditionObjective::getHash ( )

Definition at line 33 of file class.ilNoMajorVersionSkippedConditionObjective.php.

                              : string
     {
         return hash(
             "sha256",
             get_class($this)
         );
     }

◆ getLabel()

ilNoMajorVersionSkippedConditionObjective::getLabel ( )

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

                               : string
     {
         return "No major version is skipped in update.";
     }

◆ getPreconditions()

ilNoMajorVersionSkippedConditionObjective::getPreconditions ( Setup\Environment $environment )

Definition at line 51 of file class.ilNoMajorVersionSkippedConditionObjective.php.

                                                                     : array
     {
         return [
             new ilSettingsFactoryExistsObjective()
         ];
     }

◆ isApplicable()

ilNoMajorVersionSkippedConditionObjective::isApplicable ( Setup\Environment $environment )

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

                                                                 : bool
     {
         return true;
     }

◆ isNotable()

ilNoMajorVersionSkippedConditionObjective::isNotable ( )

Definition at line 46 of file class.ilNoMajorVersionSkippedConditionObjective.php.

                                : bool
     {
         return true;
     }

Field Documentation

◆ $data_factory

Data Factory ilNoMajorVersionSkippedConditionObjective::$data_factory

protected

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

Referenced by __construct().

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

setup/classes/class.ilNoMajorVersionSkippedConditionObjective.php

Public Member Functions

Protected Attributes