ilPrivacySecuritySetupAgent Class Reference

Inheritance diagram for ilPrivacySecuritySetupAgent:

Collaboration diagram for ilPrivacySecuritySetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery)
	hasConfig ()
	Does this agent require a configuration? More...
	getConfigInput (Setup\Config $config=null)
	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. Exceptions LogicException if Agent has no Config More...
	getInstallObjective (Setup\Config $config=null)
	getUpdateObjective (Setup\Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. Exceptions InvalidArgumentException if Config does not match the Agent. More...
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
Public Member Functions inherited from ILIAS\Setup\Agent
	getInstallObjective (Config $config=null)
	Get the goals the agent wants to achieve on setup. More...
	getUpdateObjective (Config $config=null)
	Get the goal the agent wants to achieve on update. More...
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...
	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...

Protected Attributes
Refinery Factory	$refinery

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilPrivacySecuritySetupAgent::__construct

(

Refinery\Factory

$refinery

)

Definition at line 34 of file class.ilPrivacySecuritySetupAgent.php.

References $refinery, and ILIAS\Repository\refinery().

    {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilPrivacySecuritySetupAgent::getArrayToConfigTransformation

(

)

Agents must be able to tell how to create a configuration from a nested array.

Exceptions

LogicException

if Agent has no Config

Implements ILIAS\Setup\Agent.

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

References $data, and ILIAS\Repository\refinery().

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new ilPrivacySecuritySetupConfig(
                (bool) ($data["https_enabled"] ?? false),
                (isset($data["auth_duration"])) ? (int) $data["auth_duration"] : null,
                (isset($data["account_assistance_duration"])) ? (int) $data["account_assistance_duration"] : null,
                (isset($data["registration_duration"])) ? (int) $data["registration_duration"] : null,
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilPrivacySecuritySetupAgent::getBuildObjective

(

)

Get the goal the agent wants to achieve to build artifacts.

Exceptions

InvalidArgumentException

if Config does not match the Agent.

Implements ILIAS\Setup\Agent.

Definition at line 97 of file class.ilPrivacySecuritySetupAgent.php.

                                       : Setup\Objective
    {
        return new Setup\Objective\NullObjective();
    }

getConfigInput()

ilPrivacySecuritySetupAgent::getConfigInput

(

Setup\Config

$config = null

)

Definition at line 50 of file class.ilPrivacySecuritySetupAgent.php.

                                                               : UI\Component\Input\Container\Form\FormInput
    {
        throw new LogicException("Not yet implemented.");
    }

getInstallObjective()

ilPrivacySecuritySetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

Definition at line 73 of file class.ilPrivacySecuritySetupAgent.php.

Referenced by getUpdateObjective().

                                                                    : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            "Complete objectives from Services/PrivacySecurity",
            false,
            new ilPrivacySecurityConfigStoredObjective($config)
        );
    }

Here is the caller graph for this function:

getMigrations()

ilPrivacySecuritySetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 113 of file class.ilPrivacySecuritySetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilPrivacySecuritySetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 105 of file class.ilPrivacySecuritySetupAgent.php.

                                                                      : Setup\Objective
    {
        return new Setup\Objective\NullObjective();
    }

getUpdateObjective()

ilPrivacySecuritySetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

Definition at line 85 of file class.ilPrivacySecuritySetupAgent.php.

References getInstallObjective().

                                                                   : Setup\Objective
    {
        if ($config === null || $config instanceof Setup\NullConfig) {
            return new Setup\Objective\NullObjective();
        }

        return $this->getInstallObjective($config);
    }

Here is the call graph for this function:

hasConfig()

ilPrivacySecuritySetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 42 of file class.ilPrivacySecuritySetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

Refinery Factory ilPrivacySecuritySetupAgent::$refinery

protected

Definition at line 32 of file class.ilPrivacySecuritySetupAgent.php.

Referenced by __construct().

---

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

• components/ILIAS/PrivacySecurity/classes/Setup/class.ilPrivacySecuritySetupAgent.php