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)
	@inheritDoc More...
Public Member Functions inherited from ilSetupObjective
	__construct (\ilSetupConfig $config)

Protected Member Functions
	generateNICKey ()

Additional Inherited Members
Protected Attributes inherited from ilSetupObjective
	$config

Detailed Description

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

Member Function Documentation

achieve()

ilNICKeyStoredObjective::achieve

(

Setup\Environment

$environment

)

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

                                                            : 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;
    }

References $factory, and generateNICKey().

Here is the call graph for this function:

generateNICKey()

ilNICKeyStoredObjective::generateNICKey ( )

protected

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

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

Referenced by achieve().

Here is the caller graph for this function:

getHash()

ilNICKeyStoredObjective::getHash

(

)

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

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

getLabel()

ilNICKeyStoredObjective::getLabel

(

)

Definition at line 14 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 24 of file class.ilNICKeyStoredObjective.php.

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

isApplicable()

ilNICKeyStoredObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

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

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

References $factory.

isNotable()

ilNICKeyStoredObjective::isNotable

(

)

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

                                : bool
    {
        return true;
    }

---

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

• setup/classes/class.ilNICKeyStoredObjective.php