ilNICKeyStoredObjective Class Reference

Inheritance diagram for ilNICKeyStoredObjective:

Collaboration diagram for ilNICKeyStoredObjective:

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

Protected Member Functions
	generateNICKey ()

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

Detailed Description

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

Member Function Documentation

achieve()

ilNICKeyStoredObjective::achieve

(

Setup\Environment

$environment

)

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

References ILIAS\LTI\ToolProvider\$settings, generateNICKey(), and ILIAS\Setup\Environment\getResource().

                                                           : Setup\Environment
    {
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $settings = $factory->settingsFor("common");

        $nic_key = $this->generateNICKey();
        $settings->set("nic_key", $nic_key);

        return $environment;
    }

Here is the call graph for this function:

generateNICKey()

ilNICKeyStoredObjective::generateNICKey ( )

protected

Definition at line 70 of file class.ilNICKeyStoredObjective.php.

Referenced by achieve().

    {
        return md5(uniqid((string) $this->config->getClientId(), true));
    }

Here is the caller graph for this function:

getHash()

ilNICKeyStoredObjective::getHash

(

)

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

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

getLabel()

ilNICKeyStoredObjective::getLabel

(

)

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

                              : string
    {
        return "A NIC key for the installation is generated and stored";
    }

getPreconditions()

ilNICKeyStoredObjective::getPreconditions

(

Setup\Environment

$environment

)

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

                                                                    : array
    {
        return [
            new \ilSettingsFactoryExistsObjective(),
            new ilInstIdDefaultStoredObjective($this->config)
        ];
    }

isApplicable()

ilNICKeyStoredObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 62 of file class.ilNICKeyStoredObjective.php.

References ILIAS\LTI\ToolProvider\$settings.

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

        return !(bool) $settings->get("nic_key");
    }

isNotable()

ilNICKeyStoredObjective::isNotable

(

)

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

                               : bool
    {
        return true;
    }

---

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

• setup/classes/class.ilNICKeyStoredObjective.php