ilInstIdDefaultStoredObjective Class Reference

Inheritance diagram for ilInstIdDefaultStoredObjective:

Collaboration diagram for ilInstIdDefaultStoredObjective:

Public Member Functions
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...
Public Member Functions inherited from ilSetupObjective
	__construct (Setup\Config $config)

Additional Inherited Members
Protected Attributes inherited from ilSetupObjective
Setup Config	$config

Detailed Description

Definition at line 23 of file class.ilInstIdDefaultStoredObjective.php.

Member Function Documentation

achieve()

ilInstIdDefaultStoredObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 47 of file class.ilInstIdDefaultStoredObjective.php.

                                                           : Setup\Environment
    {
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $settings = $factory->settingsFor("common");
 
        $settings->set("inst_id", "0");
 
        return $environment;
    }

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

getHash()

ilInstIdDefaultStoredObjective::getHash

(

)

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

                             : string
    {
        return hash("sha256", self::class);
    }

getLabel()

ilInstIdDefaultStoredObjective::getLabel

(

)

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

                              : string
    {
        return "Store default installation id.";
    }

getPreconditions()

ilInstIdDefaultStoredObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 40 of file class.ilInstIdDefaultStoredObjective.php.

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

isApplicable()

ilInstIdDefaultStoredObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

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

                                                                : bool
    {
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $settings = $factory->settingsFor("common");
 
        return !(bool) $settings->get("inst_id");
    }

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

isNotable()

ilInstIdDefaultStoredObjective::isNotable

(

)

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

                               : bool
    {
        return false;
    }

---

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

• setup/classes/class.ilInstIdDefaultStoredObjective.php