Collaboration diagram for ilOpenIdConnectSettings:

Public Member Functions
	setActive (bool $active)

	getActive ()

	setProvider (string $url)

	getProvider ()

	setClientId (string $client_id)

	getClientId ()

	setSecret (string $secret)

	getSecret ()

	setLoginElementType (int $type)

	getLoginElementType ()

	setLoginElementImage (string $a_img_name)

	getLoginElementImage ()

	setLoginElementText (string $text)

	getLoginElemenText ()

	setLoginPromptType (int $a_type)

	getLoginPromptType ()

	setLogoutScope (int $a_scope)

	getLogoutScope ()

	useCustomSession (bool $a_stat)

	isCustomSession ()

	setSessionDuration (int $a_duration)

	getSessionDuration ()

	isSyncAllowed ()

	allowSync (bool $a_stat)

	setRole (int $role)

	getRole ()

	setUidField (string $field)

	getUidField ()

	getAdditionalScopes ()

	setAdditionalScopes (array $additional_scopes)

	getAllScopes ()

	deleteImageFile ()

	hasImageFile ()

	getImageFilePath ()

	setRoleMappings (array $a_role_mappings)

	getRoleMappings ()

	getRoleMappingValueForId (int $a_role_id)

	getRoleMappingUpdateForId (int $a_role_id)

	validateScopes (string $discoveryURL, array $custom_scopes)

	save ()

	getProfileMappingFieldValue (string $field)

	setProfileMappingFieldValue (string $field, string $value)

	getProfileMappingFieldUpdate (string $field)

	setProfileMappingFieldUpdate (string $field, bool $value)

	setValidateScopes (int $validation_mode)

	getValidateScopes ()

	setCustomDiscoveryUrl (?string $discoveryUrl)

	getCustomDiscoveryUrl ()

	getProfileMappingFields ()

Static Public Member Functions
static	getInstance ()

Data Fields
const	FILE_STORAGE = 'openidconnect/login_form_image'

const	DEFAULT_SCOPE = 'openid'

const	LOGIN_ELEMENT_TYPE_TXT = 0

const	LOGIN_ELEMENT_TYPE_IMG = 1

const	LOGIN_ENFORCE = 0

const	LOGIN_STANDARD = 1

const	LOGOUT_SCOPE_GLOBAL = 0

const	LOGOUT_SCOPE_LOCAL = 1

const	URL_VALIDATION_PROVIDER = 0

const	URL_VALIDATION_CUSTOM = 1

const	URL_VALIDATION_NONE = 2

const	VALIDATION_ISSUE_INVALID_SCOPE = 0

const	VALIDATION_ISSUE_DISCOVERY_ERROR = 1

Protected Member Functions
	load ()

Private Member Functions
	__construct ()

Private Attributes
const	STORAGE_ID = 'oidc'

ilSetting	$storage

Filesystem	$filesystem

bool	$active = false

string	$provider = ''

string	$client_id = ''

string	$secret = ''

int	$login_element_type = self::LOGIN_ELEMENT_TYPE_TXT

string	$login_element_img_name = null

string	$login_element_text = null

int	$login_prompt_type = self::LOGIN_ENFORCE

int	$logout_scope = null

bool	$custom_session = false

int	$session_duration = 60

bool	$allow_sync

int	$role

string	$uid = ''

array	$profile_map = []

array	$profile_update_map = []

array	$role_mappings = []

array	$additional_scopes = []

int	$validate_scopes = self::URL_VALIDATION_PROVIDER

string	$custom_discovery_url = null

Static Private Attributes
static self	$instance = null

Detailed Description

Definition at line 27 of file class.ilOpenIdConnectSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilOpenIdConnectSettings::__construct ( )

private

Definition at line 76 of file class.ilOpenIdConnectSettings.php.

    {
        global $DIC;
 
        $this->storage = new ilSetting(self::STORAGE_ID);
        $this->filesystem = $DIC->filesystem()->web();
        $this->load();
    }

References $DIC, ILIAS\Repository\filesystem(), and load().

Here is the call graph for this function:

Member Function Documentation

◆ allowSync()

ilOpenIdConnectSettings::allowSync ( bool $a_stat )

Definition at line 210 of file class.ilOpenIdConnectSettings.php.

                                           : void
    {
        $this->allow_sync = $a_stat;
    }

Referenced by load().

Here is the caller graph for this function:

◆ deleteImageFile()

ilOpenIdConnectSettings::deleteImageFile ( )

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

Definition at line 267 of file class.ilOpenIdConnectSettings.php.

                                     : void
    {
        if ($this->filesystem->has(self::FILE_STORAGE . '/' . $this->getLoginElementImage())) {
            $this->filesystem->delete(self::FILE_STORAGE . '/' . $this->getLoginElementImage());
        }
    }

References ILIAS\Repository\filesystem(), and getLoginElementImage().

Here is the call graph for this function:

◆ getActive()

ilOpenIdConnectSettings::getActive ( )

Definition at line 99 of file class.ilOpenIdConnectSettings.php.

                               : bool
    {
        return $this->active;
    }

References $active.

Referenced by save().

Here is the caller graph for this function:

◆ getAdditionalScopes()

ilOpenIdConnectSettings::getAdditionalScopes ( )

Returns: string[]

Definition at line 238 of file class.ilOpenIdConnectSettings.php.

                                         : array
    {
        return $this->additional_scopes;
    }

References $additional_scopes.

Referenced by save().

Here is the caller graph for this function:

◆ getAllScopes()

ilOpenIdConnectSettings::getAllScopes ( )

Returns: string[]

Definition at line 255 of file class.ilOpenIdConnectSettings.php.

                                  : array
    {
        $scopes = $this->additional_scopes;
        array_unshift($scopes, self::DEFAULT_SCOPE);
 
        return $scopes;
    }

References $additional_scopes, and $scopes.

◆ getClientId()

ilOpenIdConnectSettings::getClientId ( )

Definition at line 119 of file class.ilOpenIdConnectSettings.php.

                                 : string
    {
        return $this->client_id;
    }

References $client_id.

Referenced by save().

Here is the caller graph for this function:

◆ getCustomDiscoveryUrl()

ilOpenIdConnectSettings::getCustomDiscoveryUrl ( )

Definition at line 458 of file class.ilOpenIdConnectSettings.php.

                                           : ?string
    {
        return $this->custom_discovery_url;
    }

References $custom_discovery_url.

Referenced by save().

Here is the caller graph for this function:

◆ getImageFilePath()

ilOpenIdConnectSettings::getImageFilePath ( )

Definition at line 281 of file class.ilOpenIdConnectSettings.php.

                                      : string
    {
        return implode(
            '/',
            [
                ilFileUtils::getWebspaceDir(),
                self::FILE_STORAGE . '/' . $this->getLoginElementImage()
            ]
        );
    }

References getLoginElementImage(), and ilFileUtils\getWebspaceDir().

Here is the call graph for this function:

◆ getInstance()

static ilOpenIdConnectSettings::getInstance ( )

static

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

                                        : self
    {
        if (self::$instance === null) {
            self::$instance = new self();
        }
 
        return self::$instance;
    }

References $instance.

Referenced by ilAuthFrontendCredentialsOpenIdConnect\__construct(), ilAuthProviderOpenIdConnect\__construct(), ilOpenIdConnectSettingsGUI\__construct(), ilAuthUtils\_getActiveAuthModes(), ilAuthUtils\_isExternalAccountEnabled(), ilObjAuthSettingsGUI\authSettingsObject(), and ilStartUpGUI\showOpenIdConnectLoginForm().

Here is the caller graph for this function:

◆ getLoginElemenText()

ilOpenIdConnectSettings::getLoginElemenText ( )

Definition at line 160 of file class.ilOpenIdConnectSettings.php.

                                        : string
    {
        return $this->login_element_text;
    }

References $login_element_text.

Referenced by save().

Here is the caller graph for this function:

◆ getLoginElementImage()

ilOpenIdConnectSettings::getLoginElementImage ( )

Definition at line 149 of file class.ilOpenIdConnectSettings.php.

                                          : string
    {
        return $this->login_element_img_name;
    }

References $login_element_img_name.

Referenced by deleteImageFile(), getImageFilePath(), hasImageFile(), and save().

Here is the caller graph for this function:

◆ getLoginElementType()

ilOpenIdConnectSettings::getLoginElementType ( )

Definition at line 139 of file class.ilOpenIdConnectSettings.php.

                                         : int
    {
        return $this->login_element_type;
    }

References $login_element_type.

Referenced by save().

Here is the caller graph for this function:

◆ getLoginPromptType()

ilOpenIdConnectSettings::getLoginPromptType ( )

Definition at line 170 of file class.ilOpenIdConnectSettings.php.

                                        : int
    {
        return $this->login_prompt_type;
    }

References $login_prompt_type.

Referenced by save().

Here is the caller graph for this function:

◆ getLogoutScope()

ilOpenIdConnectSettings::getLogoutScope ( )

Definition at line 180 of file class.ilOpenIdConnectSettings.php.

                                    : int
    {
        return $this->logout_scope;
    }

References $logout_scope.

Referenced by save().

Here is the caller graph for this function:

◆ getProfileMappingFields()

ilOpenIdConnectSettings::getProfileMappingFields ( )

Returns: array<string, string>

Definition at line 465 of file class.ilOpenIdConnectSettings.php.

                                             : array
    {
        return [
            'firstname' => 'firstname',
            'lastname' => 'lastname',
            'email' => 'email',
            'birthday' => 'birthday'
        ];
    }

Referenced by load(), and save().

Here is the caller graph for this function:

◆ getProfileMappingFieldUpdate()

ilOpenIdConnectSettings::getProfileMappingFieldUpdate ( string $field )

Definition at line 433 of file class.ilOpenIdConnectSettings.php.

                                                               : bool
    {
        return (bool) ($this->profile_update_map[$field] ?? false);
    }

Referenced by save().

Here is the caller graph for this function:

◆ getProfileMappingFieldValue()

ilOpenIdConnectSettings::getProfileMappingFieldValue ( string $field )

Definition at line 423 of file class.ilOpenIdConnectSettings.php.

                                                              : string
    {
        return (string) ($this->profile_map[$field] ?? '');
    }

Referenced by save().

Here is the caller graph for this function:

◆ getProvider()

ilOpenIdConnectSettings::getProvider ( )

Definition at line 109 of file class.ilOpenIdConnectSettings.php.

                                 : string
    {
        return $this->provider;
    }

References $provider.

Referenced by save().

Here is the caller graph for this function:

◆ getRole()

ilOpenIdConnectSettings::getRole ( )

Definition at line 220 of file class.ilOpenIdConnectSettings.php.

                             : int
    {
        return $this->role;
    }

References $role.

Referenced by save().

Here is the caller graph for this function:

◆ getRoleMappings()

ilOpenIdConnectSettings::getRoleMappings ( )

Returns: array<int, array{value: string, update: bool}>

Definition at line 303 of file class.ilOpenIdConnectSettings.php.

                                     : array
    {
        return $this->role_mappings;
    }

References $role_mappings.

Referenced by save().

Here is the caller graph for this function:

◆ getRoleMappingUpdateForId()

ilOpenIdConnectSettings::getRoleMappingUpdateForId ( int $a_role_id )

Definition at line 317 of file class.ilOpenIdConnectSettings.php.

                                                             : bool
    {
        if (isset($this->role_mappings[$a_role_id]['update'])) {
            return (bool) $this->role_mappings[$a_role_id]['update'];
        }
 
        return false;
    }

◆ getRoleMappingValueForId()

ilOpenIdConnectSettings::getRoleMappingValueForId ( int $a_role_id )

Definition at line 308 of file class.ilOpenIdConnectSettings.php.

                                                            : string
    {
        if (isset($this->role_mappings[$a_role_id]['value'])) {
            return (string) $this->role_mappings[$a_role_id]['value'];
        }
 
        return '';
    }

◆ getSecret()

ilOpenIdConnectSettings::getSecret ( )

Definition at line 129 of file class.ilOpenIdConnectSettings.php.

                               : string
    {
        return $this->secret;
    }

References $secret.

Referenced by save().

Here is the caller graph for this function:

◆ getSessionDuration()

ilOpenIdConnectSettings::getSessionDuration ( )

Definition at line 200 of file class.ilOpenIdConnectSettings.php.

                                        : int
    {
        return $this->session_duration;
    }

References $session_duration.

Referenced by save().

Here is the caller graph for this function:

◆ getUidField()

ilOpenIdConnectSettings::getUidField ( )

Definition at line 230 of file class.ilOpenIdConnectSettings.php.

                                 : string
    {
        return $this->uid;
    }

References $uid.

Referenced by save().

Here is the caller graph for this function:

◆ getValidateScopes()

ilOpenIdConnectSettings::getValidateScopes ( )

Definition at line 448 of file class.ilOpenIdConnectSettings.php.

                                       : int
    {
        return $this->validate_scopes;
    }

References $validate_scopes.

Referenced by load(), and save().

Here is the caller graph for this function:

◆ hasImageFile()

ilOpenIdConnectSettings::hasImageFile ( )

Definition at line 274 of file class.ilOpenIdConnectSettings.php.

                                  : bool
    {
        return
            $this->getLoginElementImage() !== '' &&
            $this->filesystem->has(self::FILE_STORAGE . '/' . $this->getLoginElementImage());
    }

References ILIAS\Repository\filesystem(), and getLoginElementImage().

Here is the call graph for this function:

◆ isCustomSession()

ilOpenIdConnectSettings::isCustomSession ( )

Definition at line 190 of file class.ilOpenIdConnectSettings.php.

                                     : bool
    {
        return $this->custom_session;
    }

References $custom_session.

Referenced by save().

Here is the caller graph for this function:

◆ isSyncAllowed()

ilOpenIdConnectSettings::isSyncAllowed ( )

Definition at line 205 of file class.ilOpenIdConnectSettings.php.

                                   : bool
    {
        return $this->allow_sync;
    }

References $allow_sync.

Referenced by save().

Here is the caller graph for this function:

◆ load()

ilOpenIdConnectSettings::load ( )

protected

Definition at line 388 of file class.ilOpenIdConnectSettings.php.

                             : void
    {
        foreach ($this->getProfileMappingFields() as $field => $lang_key) {
            $this->profile_map[$field] = (string) $this->storage->get('pmap_' . $field, '');
            $this->profile_update_map[$field] = (bool) $this->storage->get('pumap_' . $field, '0');
        }
 
        $this->setActive((bool) $this->storage->get('active', '0'));
        $this->setProvider($this->storage->get('provider', ''));
        $this->setClientId($this->storage->get('client_id', ''));
        $this->setSecret($this->storage->get('secret', ''));
        $this->setAdditionalScopes((array) unserialize(
            $this->storage->get('scopes', serialize([])),
            ['allowed_classes' => false]
        ));
        $this->setLoginElementImage($this->storage->get('le_img', ''));
        $this->setLoginElementText((string) $this->storage->get('le_text'));
        $this->setLoginElementType((int) $this->storage->get('le_type'));
        $this->setLoginPromptType((int) $this->storage->get('prompt_type', (string) self::LOGIN_ENFORCE));
        $this->setLogoutScope((int) $this->storage->get('logout_scope', (string) self::LOGOUT_SCOPE_GLOBAL));
        $this->useCustomSession((bool) $this->storage->get('custom_session', '0'));
        $this->setSessionDuration((int) $this->storage->get('session_duration', '60'));
        $this->allowSync((bool) $this->storage->get('allow_sync', '0'));
        $this->setRole((int) $this->storage->get('role', '0'));
        $this->setUidField((string) $this->storage->get('uid', ''));
        $this->setRoleMappings((array) unserialize(
            $this->storage->get('role_mappings', serialize([])),
            ['allowed_classes' => false]
        ));
        $this->setValidateScopes((int) $this->storage->get('validate_scopes', (string) self::URL_VALIDATION_PROVIDER));
        if (self::URL_VALIDATION_CUSTOM === $this->getValidateScopes()) {
            $this->setCustomDiscoveryUrl($this->storage->get('custom_discovery_url'));
        }
    }

References allowSync(), getProfileMappingFields(), getValidateScopes(), setActive(), setAdditionalScopes(), setClientId(), setCustomDiscoveryUrl(), setLoginElementImage(), setLoginElementText(), setLoginElementType(), setLoginPromptType(), setLogoutScope(), setProvider(), setRole(), setRoleMappings(), setSecret(), setSessionDuration(), setUidField(), setValidateScopes(), and useCustomSession().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilOpenIdConnectSettings::save ( )

Definition at line 357 of file class.ilOpenIdConnectSettings.php.

                          : void
    {
        $this->storage->set('active', (string) ((int) $this->getActive()));
        $this->storage->set('provider', $this->getProvider());
        $this->storage->set('client_id', $this->getClientId());
        $this->storage->set('secret', $this->getSecret());
        $this->storage->set('scopes', serialize($this->getAdditionalScopes()));
        $this->storage->set('le_img', $this->getLoginElementImage());
        $this->storage->set('le_text', $this->getLoginElemenText());
        $this->storage->set('le_type', (string) $this->getLoginElementType());
        $this->storage->set('prompt_type', (string) $this->getLoginPromptType());
        $this->storage->set('logout_scope', (string) $this->getLogoutScope());
        $this->storage->set('custom_session', (string) ((int) $this->isCustomSession()));
        $this->storage->set('session_duration', (string) $this->getSessionDuration());
        $this->storage->set('allow_sync', (string) ((int) $this->isSyncAllowed()));
        $this->storage->set('role', (string) $this->getRole());
        $this->storage->set('uid', $this->getUidField());
 
        foreach ($this->getProfileMappingFields() as $field => $lang_key) {
            $this->storage->set('pmap_' . $field, $this->getProfileMappingFieldValue($field));
            $this->storage->set('pumap_' . $field, (string) ((int) $this->getProfileMappingFieldUpdate($field)));
        }
        $this->storage->set('role_mappings', serialize($this->getRoleMappings()));
        $this->storage->set('validate_scopes', (string) $this->getValidateScopes());
        if (self::URL_VALIDATION_CUSTOM === $this->getValidateScopes()) {
            $this->storage->set('custom_discovery_url', $this->getCustomDiscoveryUrl());
        } else {
            $this->storage->delete('custom_discovery_url');
        }
    }

References getActive(), getAdditionalScopes(), getClientId(), getCustomDiscoveryUrl(), getLoginElemenText(), getLoginElementImage(), getLoginElementType(), getLoginPromptType(), getLogoutScope(), getProfileMappingFields(), getProfileMappingFieldUpdate(), getProfileMappingFieldValue(), getProvider(), getRole(), getRoleMappings(), getSecret(), getSessionDuration(), getUidField(), getValidateScopes(), isCustomSession(), and isSyncAllowed().

Here is the call graph for this function:

◆ setActive()

ilOpenIdConnectSettings::setActive ( bool $active )

Definition at line 94 of file class.ilOpenIdConnectSettings.php.

                                           : void
    {
        $this->active = $active;
    }

References $active.

Referenced by load().

Here is the caller graph for this function:

◆ setAdditionalScopes()

ilOpenIdConnectSettings::setAdditionalScopes ( array $additional_scopes )

Parameters

string[] $additional_scopes

Returns: void

Definition at line 247 of file class.ilOpenIdConnectSettings.php.

                                                                 : void
    {
        $this->additional_scopes = $additional_scopes;
    }

References $additional_scopes.

Referenced by load().

Here is the caller graph for this function:

◆ setClientId()

ilOpenIdConnectSettings::setClientId ( string $client_id )

Definition at line 114 of file class.ilOpenIdConnectSettings.php.

                                                  : void
    {
        $this->client_id = $client_id;
    }

References $client_id.

Referenced by load().

Here is the caller graph for this function:

◆ setCustomDiscoveryUrl()

ilOpenIdConnectSettings::setCustomDiscoveryUrl ( ?string $discoveryUrl )

Definition at line 453 of file class.ilOpenIdConnectSettings.php.

                                                                : void
    {
        $this->custom_discovery_url = $discoveryUrl;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setLoginElementImage()

ilOpenIdConnectSettings::setLoginElementImage ( string $a_img_name )

Definition at line 144 of file class.ilOpenIdConnectSettings.php.

                                                            : void
    {
        $this->login_element_img_name = $a_img_name;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setLoginElementText()

ilOpenIdConnectSettings::setLoginElementText ( string $text )

Definition at line 154 of file class.ilOpenIdConnectSettings.php.

                                                     : void
    {
        $this->login_element_text = $text;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setLoginElementType()

ilOpenIdConnectSettings::setLoginElementType ( int $type )

Definition at line 134 of file class.ilOpenIdConnectSettings.php.

                                                  : void
    {
        $this->login_element_type = $type;
    }

References $type.

Referenced by load().

Here is the caller graph for this function:

◆ setLoginPromptType()

ilOpenIdConnectSettings::setLoginPromptType ( int $a_type )

Definition at line 165 of file class.ilOpenIdConnectSettings.php.

                                                   : void
    {
        $this->login_prompt_type = $a_type;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setLogoutScope()

ilOpenIdConnectSettings::setLogoutScope ( int $a_scope )

Definition at line 175 of file class.ilOpenIdConnectSettings.php.

                                                : void
    {
        $this->logout_scope = $a_scope;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setProfileMappingFieldUpdate()

ilOpenIdConnectSettings::setProfileMappingFieldUpdate	(	string	$field,
		bool	$value
	)

Definition at line 438 of file class.ilOpenIdConnectSettings.php.

                                                                            : void
    {
        $this->profile_update_map[$field] = $value;
    }

◆ setProfileMappingFieldValue()

ilOpenIdConnectSettings::setProfileMappingFieldValue	(	string	$field,
		string	$value
	)

Definition at line 428 of file class.ilOpenIdConnectSettings.php.

                                                                             : void
    {
        $this->profile_map[$field] = $value;
    }

◆ setProvider()

ilOpenIdConnectSettings::setProvider ( string $url )

Definition at line 104 of file class.ilOpenIdConnectSettings.php.

                                            : void
    {
        $this->provider = $url;
    }

References $url.

Referenced by load().

Here is the caller graph for this function:

◆ setRole()

ilOpenIdConnectSettings::setRole ( int $role )

Definition at line 215 of file class.ilOpenIdConnectSettings.php.

                                      : void
    {
        $this->role = $role;
    }

References $role.

Referenced by load().

Here is the caller graph for this function:

◆ setRoleMappings()

ilOpenIdConnectSettings::setRoleMappings ( array $a_role_mappings )

Parameters

array<int,array{value string, update: bool}> $a_role_mappings

Definition at line 295 of file class.ilOpenIdConnectSettings.php.

                                                           : void
    {
        $this->role_mappings = $a_role_mappings;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setSecret()

ilOpenIdConnectSettings::setSecret ( string $secret )

Definition at line 124 of file class.ilOpenIdConnectSettings.php.

                                             : void
    {
        $this->secret = $secret;
    }

References $secret.

Referenced by load().

Here is the caller graph for this function:

◆ setSessionDuration()

ilOpenIdConnectSettings::setSessionDuration ( int $a_duration )

Definition at line 195 of file class.ilOpenIdConnectSettings.php.

                                                       : void
    {
        $this->session_duration = $a_duration;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setUidField()

ilOpenIdConnectSettings::setUidField ( string $field )

Definition at line 225 of file class.ilOpenIdConnectSettings.php.

                                              : void
    {
        $this->uid = $field;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setValidateScopes()

ilOpenIdConnectSettings::setValidateScopes ( int $validation_mode )

Definition at line 443 of file class.ilOpenIdConnectSettings.php.

                                                           : void
    {
        $this->validate_scopes = $validation_mode;
    }

Referenced by load().

Here is the caller graph for this function:

◆ useCustomSession()

ilOpenIdConnectSettings::useCustomSession ( bool $a_stat )

Definition at line 185 of file class.ilOpenIdConnectSettings.php.

                                                  : void
    {
        $this->custom_session = $a_stat;
    }

Referenced by load().

Here is the caller graph for this function:

◆ validateScopes()

ilOpenIdConnectSettings::validateScopes	(	string	$discoveryURL,
		array	$custom_scopes
	)

Definition at line 326 of file class.ilOpenIdConnectSettings.php.

                                                                              : array
    {
        $result = [];
        try {
            $curl = new ilCurlConnection($discoveryURL);
            $curl->init();
 
            $curl->setOpt(CURLOPT_HEADER, 0);
            $curl->setOpt(CURLOPT_RETURNTRANSFER, true);
            $curl->setOpt(CURLOPT_TIMEOUT, 4);
 
            $response = $curl->exec();
 
            if ($curl->getInfo(CURLINFO_RESPONSE_CODE) === 200) {
                $decoded_response = json_decode($response, false, 512, JSON_THROW_ON_ERROR);
                $available_scopes = $decoded_response->scopes_supported;
                array_unshift($custom_scopes, self::DEFAULT_SCOPE);
                if (!empty(array_diff($custom_scopes, $available_scopes))) {
                    $result = [self::VALIDATION_ISSUE_INVALID_SCOPE, array_diff($custom_scopes, $available_scopes)];
                }
            } else {
                $result = [self::VALIDATION_ISSUE_DISCOVERY_ERROR, $response];
            }
        } finally {
            if (isset($curl)) {
                $curl->close();
            }
        }
        return $result;
    }

References $response, VALIDATION_ISSUE_DISCOVERY_ERROR, and VALIDATION_ISSUE_INVALID_SCOPE.

Field Documentation

◆ $active

bool ilOpenIdConnectSettings::$active = false

private

Definition at line 51 of file class.ilOpenIdConnectSettings.php.

Referenced by getActive(), and setActive().

◆ $additional_scopes

array ilOpenIdConnectSettings::$additional_scopes = []

private

Definition at line 72 of file class.ilOpenIdConnectSettings.php.

Referenced by getAdditionalScopes(), getAllScopes(), and setAdditionalScopes().

◆ $allow_sync

bool ilOpenIdConnectSettings::$allow_sync

private

Definition at line 62 of file class.ilOpenIdConnectSettings.php.

Referenced by isSyncAllowed().

◆ $client_id

string ilOpenIdConnectSettings::$client_id = ''

private

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

Referenced by getClientId(), and setClientId().

◆ $custom_discovery_url

string ilOpenIdConnectSettings::$custom_discovery_url = null

private

Definition at line 74 of file class.ilOpenIdConnectSettings.php.

Referenced by getCustomDiscoveryUrl().

◆ $custom_session

bool ilOpenIdConnectSettings::$custom_session = false

private

Definition at line 60 of file class.ilOpenIdConnectSettings.php.

Referenced by isCustomSession().

◆ $filesystem

Filesystem ilOpenIdConnectSettings::$filesystem

private

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

◆ $instance

self ilOpenIdConnectSettings::$instance = null

staticprivate

Definition at line 47 of file class.ilOpenIdConnectSettings.php.

Referenced by getInstance().

◆ $login_element_img_name

string ilOpenIdConnectSettings::$login_element_img_name = null

private

Definition at line 56 of file class.ilOpenIdConnectSettings.php.

Referenced by getLoginElementImage().

◆ $login_element_text

string ilOpenIdConnectSettings::$login_element_text = null

private

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

Referenced by getLoginElemenText().

◆ $login_element_type

int ilOpenIdConnectSettings::$login_element_type = self::LOGIN_ELEMENT_TYPE_TXT

private

Definition at line 55 of file class.ilOpenIdConnectSettings.php.

Referenced by getLoginElementType().

◆ $login_prompt_type

int ilOpenIdConnectSettings::$login_prompt_type = self::LOGIN_ENFORCE

private

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

Referenced by getLoginPromptType().

◆ $logout_scope

int ilOpenIdConnectSettings::$logout_scope = null

private

Definition at line 59 of file class.ilOpenIdConnectSettings.php.

Referenced by getLogoutScope().

◆ $profile_map

array ilOpenIdConnectSettings::$profile_map = []

private

Definition at line 66 of file class.ilOpenIdConnectSettings.php.

◆ $profile_update_map

array ilOpenIdConnectSettings::$profile_update_map = []

private

Definition at line 68 of file class.ilOpenIdConnectSettings.php.

◆ $provider

string ilOpenIdConnectSettings::$provider = ''

private

Definition at line 52 of file class.ilOpenIdConnectSettings.php.

Referenced by getProvider().

◆ $role

int ilOpenIdConnectSettings::$role

private

Definition at line 63 of file class.ilOpenIdConnectSettings.php.

Referenced by getRole(), and setRole().

◆ $role_mappings

array ilOpenIdConnectSettings::$role_mappings = []

private

Definition at line 70 of file class.ilOpenIdConnectSettings.php.

Referenced by getRoleMappings().

◆ $secret

string ilOpenIdConnectSettings::$secret = ''

private

Definition at line 54 of file class.ilOpenIdConnectSettings.php.

Referenced by getSecret(), and setSecret().

◆ $session_duration

int ilOpenIdConnectSettings::$session_duration = 60

private

Definition at line 61 of file class.ilOpenIdConnectSettings.php.

Referenced by getSessionDuration().

◆ $storage

ilSetting ilOpenIdConnectSettings::$storage

private

Definition at line 49 of file class.ilOpenIdConnectSettings.php.

◆ $uid

string ilOpenIdConnectSettings::$uid = ''

private

Definition at line 64 of file class.ilOpenIdConnectSettings.php.

Referenced by getUidField().

◆ $validate_scopes

int ilOpenIdConnectSettings::$validate_scopes = self::URL_VALIDATION_PROVIDER

private

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

Referenced by getValidateScopes().

◆ DEFAULT_SCOPE

const ilOpenIdConnectSettings::DEFAULT_SCOPE = 'openid'

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ FILE_STORAGE

const ilOpenIdConnectSettings::FILE_STORAGE = 'openidconnect/login_form_image'

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

Referenced by ilOpenIdConnectSettingsGUI\saveImageFromHttpRequest().

◆ LOGIN_ELEMENT_TYPE_IMG

const ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_IMG = 1

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm(), and ilStartUpGUI\showOpenIdConnectLoginForm().

◆ LOGIN_ELEMENT_TYPE_TXT

const ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_TXT = 0

Definition at line 33 of file class.ilOpenIdConnectSettings.php.

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm(), and ilStartUpGUI\showOpenIdConnectLoginForm().

◆ LOGIN_ENFORCE

const ilOpenIdConnectSettings::LOGIN_ENFORCE = 0

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

Referenced by ilAuthProviderOpenIdConnect\doAuthentication(), and ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ LOGIN_STANDARD

const ilOpenIdConnectSettings::LOGIN_STANDARD = 1

Definition at line 36 of file class.ilOpenIdConnectSettings.php.

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ LOGOUT_SCOPE_GLOBAL

const ilOpenIdConnectSettings::LOGOUT_SCOPE_GLOBAL = 0

Definition at line 37 of file class.ilOpenIdConnectSettings.php.

Referenced by ilAuthProviderOpenIdConnect\doAuthentication(), and ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ LOGOUT_SCOPE_LOCAL

const ilOpenIdConnectSettings::LOGOUT_SCOPE_LOCAL = 1

Definition at line 38 of file class.ilOpenIdConnectSettings.php.

Referenced by ilAuthProviderOpenIdConnect\handleLogout(), and ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ STORAGE_ID

const ilOpenIdConnectSettings::STORAGE_ID = 'oidc'

private

Definition at line 29 of file class.ilOpenIdConnectSettings.php.

◆ URL_VALIDATION_CUSTOM

const ilOpenIdConnectSettings::URL_VALIDATION_CUSTOM = 1

Definition at line 41 of file class.ilOpenIdConnectSettings.php.

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm(), and ilOpenIdConnectSettingsGUI\saveSettings().

◆ URL_VALIDATION_NONE

const ilOpenIdConnectSettings::URL_VALIDATION_NONE = 2

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ URL_VALIDATION_PROVIDER

const ilOpenIdConnectSettings::URL_VALIDATION_PROVIDER = 0

Definition at line 40 of file class.ilOpenIdConnectSettings.php.

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm(), and ilOpenIdConnectSettingsGUI\saveSettings().

◆ VALIDATION_ISSUE_DISCOVERY_ERROR

const ilOpenIdConnectSettings::VALIDATION_ISSUE_DISCOVERY_ERROR = 1

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

Referenced by validateScopes().

◆ VALIDATION_ISSUE_INVALID_SCOPE

const ilOpenIdConnectSettings::VALIDATION_ISSUE_INVALID_SCOPE = 0

Definition at line 44 of file class.ilOpenIdConnectSettings.php.

Referenced by ilOpenIdConnectSettingsGUI\saveSettings(), and validateScopes().

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

Services/OpenIdConnect/classes/class.ilOpenIdConnectSettings.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowSync()

◆ deleteImageFile()

◆ getActive()

◆ getAdditionalScopes()

◆ getAllScopes()

◆ getClientId()

◆ getCustomDiscoveryUrl()

◆ getImageFilePath()

◆ getInstance()

◆ getLoginElemenText()

◆ getLoginElementImage()

◆ getLoginElementType()

◆ getLoginPromptType()

◆ getLogoutScope()

◆ getProfileMappingFields()

◆ getProfileMappingFieldUpdate()

◆ getProfileMappingFieldValue()

◆ getProvider()

◆ getRole()

◆ getRoleMappings()

◆ getRoleMappingUpdateForId()

◆ getRoleMappingValueForId()

◆ getSecret()

◆ getSessionDuration()

◆ getUidField()

◆ getValidateScopes()

◆ hasImageFile()

◆ isCustomSession()

◆ isSyncAllowed()

◆ load()

◆ save()

◆ setActive()

◆ setAdditionalScopes()

◆ setClientId()

◆ setCustomDiscoveryUrl()

◆ setLoginElementImage()

◆ setLoginElementText()

◆ setLoginElementType()

◆ setLoginPromptType()

◆ setLogoutScope()

◆ setProfileMappingFieldUpdate()

◆ setProfileMappingFieldValue()

◆ setProvider()

◆ setRole()

◆ setRoleMappings()

◆ setSecret()

◆ setSessionDuration()

◆ setUidField()

◆ setValidateScopes()

◆ useCustomSession()

◆ validateScopes()

Field Documentation

◆ $active

◆ $additional_scopes

◆ $allow_sync

◆ $client_id

◆ $custom_discovery_url

◆ $custom_session

◆ $filesystem

◆ $instance

◆ $login_element_img_name

◆ $login_element_text

◆ $login_element_type

◆ $login_prompt_type

◆ $logout_scope

◆ $profile_map

◆ $profile_update_map

◆ $provider

◆ $role