ilAuthenticationSetupAgent Class Reference

Inheritance diagram for ilAuthenticationSetupAgent:

Collaboration diagram for ilAuthenticationSetupAgent:

Public Member Functions
	__construct (protected Refinery\Factory $refinery)
	hasConfig ()
	Does this agent require a configuration? More...
	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. More...
	getInstallObjective (?Setup\Config $config=null)
	getUpdateObjective (?Setup\Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
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
const	DEFAULT_SESSION_EXPIRE_IN_SECONDS = 1_800

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAuthenticationSetupAgent::__construct

(

protected Refinery\Factory

$refinery

)

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

    {
    }

Member Function Documentation

getArrayToConfigTransformation()

ilAuthenticationSetupAgent::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 39 of file class.ilAuthenticationSetupAgent.php.

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

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data): \ilAuthenticationSetupConfig {
            return new ilAuthenticationSetupConfig($data["session_max_idle"] ?? self::DEFAULT_SESSION_EXPIRE_IN_SECONDS);
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilAuthenticationSetupAgent::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 85 of file class.ilAuthenticationSetupAgent.php.

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

getInstallObjective()

ilAuthenticationSetupAgent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 46 of file class.ilAuthenticationSetupAgent.php.

References null.

                                                                     : Setup\Objective
    {
        if ($config !== null) {
            return new ilSessionMaxIdleIsSetObjective($config);
        }

        return new ilSessionMaxIdleIsSetObjective(
            new ilAuthenticationSetupConfig(self::DEFAULT_SESSION_EXPIRE_IN_SECONDS)
        );
    }

getMigrations()

ilAuthenticationSetupAgent::getMigrations

(

)

Get a named map of migrations available for this Agent.

Should also return Migrations that have run completely.

Returns

array<string,Migration>|Migration[]

Implements ILIAS\Setup\Agent.

Definition at line 106 of file class.ilAuthenticationSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilAuthenticationSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 90 of file class.ilAuthenticationSetupAgent.php.

                                                                      : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Component Authentication',
            true,
            new ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new ilAuthenticationDatabaseUpdateSteps8()
            ),
            new ilDatabaseUpdateStepsMetricsCollectedObjective(
                $storage,
                new AbandonAuthRichTextEditorDatabaseUpdateSteps()
            ),
        );
    }

getUpdateObjective()

ilAuthenticationSetupAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 57 of file class.ilAuthenticationSetupAgent.php.

References null.

                                                                    : Setup\Objective
    {
        if ($config !== null) {
            return new Setup\ObjectiveCollection(
                'Authentication',
                true,
                new ilDatabaseUpdateStepsExecutedObjective(
                    new ilAuthenticationDatabaseUpdateSteps8()
                ),
                new ilDatabaseUpdateStepsExecutedObjective(
                    new AbandonAuthRichTextEditorDatabaseUpdateSteps()
                ),
                new ilSessionMaxIdleIsSetObjective($config)
            );
        }

        return new Setup\ObjectiveCollection(
            'Authentication',
            true,
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilAuthenticationDatabaseUpdateSteps8()
            ),
            new ilDatabaseUpdateStepsExecutedObjective(
                new AbandonAuthRichTextEditorDatabaseUpdateSteps()
            ),
        );
    }

hasConfig()

ilAuthenticationSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return true;
    }

Field Documentation

DEFAULT_SESSION_EXPIRE_IN_SECONDS

const ilAuthenticationSetupAgent::DEFAULT_SESSION_EXPIRE_IN_SECONDS = 1_800

protected

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

---

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

• components/ILIAS/Authentication/classes/Setup/class.ilAuthenticationSetupAgent.php