ilVersionWrittenToSettingsObjective Class Reference

Inheritance diagram for ilVersionWrittenToSettingsObjective:

Collaboration diagram for ilVersionWrittenToSettingsObjective:

Public Member Functions
	__construct (Data\Factory $data_factory)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)

Data Fields
const	ILIAS_VERSION_KEY = "ilias_version"

Protected Attributes
Data Factory	$data_factory

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilVersionWrittenToSettingsObjective::__construct

(

Data\Factory

$data_factory

)

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

    {
        $this->data_factory = $data_factory;
    }

References $data_factory.

Member Function Documentation

achieve()

ilVersionWrittenToSettingsObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 60 of file class.ilVersionWrittenToSettingsObjective.php.

                                                           : Setup\Environment
    {
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $settings = $factory->settingsFor("common");
 
        $current_version = $this->data_factory->version(ILIAS_VERSION_NUMERIC);
        $settings->set(self::ILIAS_VERSION_KEY, (string) $current_version);
 
        return $environment;
    }

References $factory, ILIAS\LTI\ToolProvider\$settings, and ILIAS_VERSION_NUMERIC.

getHash()

ilVersionWrittenToSettingsObjective::getHash

(

)

Definition at line 35 of file class.ilVersionWrittenToSettingsObjective.php.

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

getLabel()

ilVersionWrittenToSettingsObjective::getLabel

(

)

Definition at line 43 of file class.ilVersionWrittenToSettingsObjective.php.

                              : string
    {
        return "The ILIAS Version is written to the settings.";
    }

getPreconditions()

ilVersionWrittenToSettingsObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 53 of file class.ilVersionWrittenToSettingsObjective.php.

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

isApplicable()

ilVersionWrittenToSettingsObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 71 of file class.ilVersionWrittenToSettingsObjective.php.

                                                                : bool
    {
        return true;
    }

isNotable()

ilVersionWrittenToSettingsObjective::isNotable

(

)

Definition at line 48 of file class.ilVersionWrittenToSettingsObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$data_factory

Data Factory ilVersionWrittenToSettingsObjective::$data_factory

protected

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

Referenced by __construct().

ILIAS_VERSION_KEY

const ilVersionWrittenToSettingsObjective::ILIAS_VERSION_KEY = "ilias_version"

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

Referenced by ilNoMajorVersionSkippedConditionObjective\achieve(), and ilNoVersionDowngradeConditionObjective\achieve().

---

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

• setup/classes/class.ilVersionWrittenToSettingsObjective.php