ilECSAuthFactory Class Reference

Collaboration diagram for ilECSAuthFactory:

Public Member Functions
	__construct ()
	build (int $auth_type)
	getAuthTypes ()
	getAvailableStrategies ()

Protected Attributes
readonly ilLogger	$logger
readonly ilCtrlInterface	$ctrl
readonly ilLanguage	$lng

Detailed Description

Definition at line 20 of file class.ilECSAuthFactory.php.

Constructor & Destructor Documentation

__construct()

ilECSAuthFactory::__construct

(

)

Definition at line 26 of file class.ilECSAuthFactory.php.

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->wsrv();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

build()

ilECSAuthFactory::build

(

int

$auth_type

)

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

                                         : ?ilECSAuthStrategy
    {
        return match ($auth_type) {
            ilECSParticipantSetting::INCOMING_AUTH_TYPE_LOGIN_PAGE =>
                new ilLoginPageAuthStrategy($this->ctrl, $this->logger, $this->lng),
            ilECSParticipantSetting::INCOMING_AUTH_TYPE_SHIBBOLETH =>
                new ilShibbolethAuthStrategy($this->ctrl, $this->logger),
            ilECSParticipantSetting::INCOMING_AUTH_TYPE_OIDC =>
                new ilOIDCAuthStrategy($this->ctrl, $this->logger),
            default => null,
        };
    }

References ILIAS\Repository\ctrl(), ilECSParticipantSetting\INCOMING_AUTH_TYPE_LOGIN_PAGE, ilECSParticipantSetting\INCOMING_AUTH_TYPE_OIDC, ilECSParticipantSetting\INCOMING_AUTH_TYPE_SHIBBOLETH, ILIAS\Repository\lng(), and ILIAS\Repository\logger().

Referenced by getAvailableStrategies().

Here is the call graph for this function:

Here is the caller graph for this function:

getAuthTypes()

ilECSAuthFactory::getAuthTypes

(

)

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

                                  : array
    {
        return [
            ilECSParticipantSetting::INCOMING_AUTH_TYPE_LOGIN_PAGE,
            ilECSParticipantSetting::INCOMING_AUTH_TYPE_SHIBBOLETH,
            ilECSParticipantSetting::INCOMING_AUTH_TYPE_OIDC,
        ];
    }

References ilECSParticipantSetting\INCOMING_AUTH_TYPE_LOGIN_PAGE, ilECSParticipantSetting\INCOMING_AUTH_TYPE_OIDC, and ilECSParticipantSetting\INCOMING_AUTH_TYPE_SHIBBOLETH.

Referenced by getAvailableStrategies().

Here is the caller graph for this function:

getAvailableStrategies()

ilECSAuthFactory::getAvailableStrategies

(

)

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

                                            : array
    {
        $strategies = [];
        foreach ($this->getAuthTypes() as $auth_type) {
            $strategy = $this->build($auth_type);
            if ($strategy->isActive()) {
                $strategies[$auth_type] = $strategy;
            }
        }
        return $strategies;
    }

References build(), and getAuthTypes().

Here is the call graph for this function:

Field Documentation

$ctrl

readonly ilCtrlInterface ilECSAuthFactory::$ctrl

protected

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

$lng

readonly ilLanguage ilECSAuthFactory::$lng

protected

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

$logger

readonly ilLogger ilECSAuthFactory::$logger

protected

Definition at line 22 of file class.ilECSAuthFactory.php.

---

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

• components/ILIAS/WebServices/ECS/classes/Auth/class.ilECSAuthFactory.php