class.ilAuthenticationSetupAgent.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Authentication\Setup\AbandonCASAuthModeUpdateObjective;
use ILIAS\Authentication\Setup\SessionReminderKeyCreatedObjective;
use ILIAS\Setup;
use ILIAS\Refinery;
 
class ilAuthenticationSetupAgent implements Setup\Agent
{
    use Setup\Agent\HasNoNamedObjective;
 
    protected const int DEFAULT_SESSION_EXPIRE_IN_SECONDS = 1_800;
 
    public function __construct(protected Refinery\Factory $refinery)
    {
    }
 
    public function hasConfig(): bool
    {
        return true;
    }
 
    public function getArrayToConfigTransformation(): Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data): ilAuthenticationSetupConfig {
            return new ilAuthenticationSetupConfig($data['session_max_idle'] ?? self::DEFAULT_SESSION_EXPIRE_IN_SECONDS);
        });
    }
 
    public function getInstallObjective(?Setup\Config $config = null): Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Authentication',
            true,
            new ilSessionMaxIdleIsSetObjective(
                $config ?? new ilAuthenticationSetupConfig(self::DEFAULT_SESSION_EXPIRE_IN_SECONDS)
            ),
            new SessionReminderKeyCreatedObjective(),
        );
    }
 
    public function getUpdateObjective(?Setup\Config $config = null): Setup\Objective
    {
        if ($config !== null) {
            return new Setup\ObjectiveCollection(
                'Authentication',
                true,
                new ilSessionMaxIdleIsSetObjective($config),
                new SessionReminderKeyCreatedObjective(),
            );
        }
 
        return new SessionReminderKeyCreatedObjective();
    }
 
    public function getBuildObjective(): Setup\Objective
    {
        return new Setup\Objective\NullObjective();
    }
 
    public function getStatusObjective(Setup\Metrics\Storage $storage): Setup\Objective
    {
        return new Setup\Objective\NullObjective();
    }
 
    public function getMigrations(): array
    {
        return [];
    }
}