Class ilOpenIdConnectSettingsGUI. More...

Collaboration diagram for ilOpenIdConnectSettings:

Public Member Functions
	setActive (bool $active)

	getActive ()

	setProvider (string $url)

	getProvider ()

	setClientId (string $client_id)

	getClientId ()

	setSecret (string $secret)

	getSecret ()
	Get secret. More...

	setLoginElementType (int $type)
	Set login element type. More...

	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 ()

	deleteImageFile ()
	Delete image file. More...

	hasImageFile ()

	getImageFilePath ()

	setRoleMappings (array $a_role_mappings)

	getRoleMappings ()
	Get role mappings. More...

	getRoleMappingValueForId ($a_role_id)

	getRoleMappingUpdateForId ($a_role_id)

	save ()
	Save in settings. More...

	getProfileMappingFieldValue (string $field)

	setProfileMappingFieldValue (string $field, string $value)

	getProfileMappingFieldUpdate (string $field)

	setProfileMappingFieldUpdate (string $field, bool $value)

	getProfileMappingFields ()

Static Public Member Functions
static	getInstance ()
	Get singleton instance. More...

Data Fields
const	FILE_STORAGE = 'openidconnect/login_form_image'

const	STORAGE_ID = 'oidc'

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

Protected Member Functions
	load ()
	Load from settings. More...

Private Member Functions
	__construct ()
	ilOpenIdConnectSettings constructor. More...

Private Attributes
	$storage = null

	$filesystem = null

	$active = false

	$provider = ''

	$client_id = ''

	$secret = ''

	$login_element_type = self::LOGIN_ELEMENT_TYPE_TXT

	$login_element_img_name

	$login_element_text

	$login_prompt_type = self::LOGIN_ENFORCE

	$logout_scope

	$custom_session = false

	$session_duration = 60

	$allow_sync

	$role

	$uid = ''

	$profile_map = []

	$profile_update_map = []

	$role_mappings = []

Static Private Attributes
static	$instance = null

Detailed Description

Class ilOpenIdConnectSettingsGUI.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilOpenIdConnectSettings::__construct ( )

private

ilOpenIdConnectSettings constructor.

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

References $DIC, and load().

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

Here is the call graph for this function:

Member Function Documentation

◆ allowSync()

ilOpenIdConnectSettings::allowSync ( bool $a_stat )

Parameters

bool $a_stat

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

Referenced by load().

     {
         $this->allow_sync = $a_stat;
     }

Here is the caller graph for this function:

◆ deleteImageFile()

ilOpenIdConnectSettings::deleteImageFile ( )

Delete image file.

Exceptions

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

References getLoginElementImage().

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

Here is the call graph for this function:

◆ getActive()

ilOpenIdConnectSettings::getActive ( )

Returns: bool

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

References $active.

Referenced by save().

                                 : bool
     {
         return $this->active;
     }

Here is the caller graph for this function:

◆ getClientId()

ilOpenIdConnectSettings::getClientId ( )

Returns: string

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

References $client_id.

Referenced by save().

                                   : string
     {
         return $this->client_id;
     }

Here is the caller graph for this function:

◆ getImageFilePath()

ilOpenIdConnectSettings::getImageFilePath ( )

Returns: string

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

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

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

Here is the call graph for this function:

◆ getInstance()

static ilOpenIdConnectSettings::getInstance ( )

static

Get singleton instance.

Returns

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

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

                                          : \ilOpenIdConnectSettings
     {
         if (!self::$instance) {
             self::$instance = new self();
         }
         return new self::$instance;
     }

Here is the caller graph for this function:

◆ getLoginElemenText()

ilOpenIdConnectSettings::getLoginElemenText ( )

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

References $login_element_text.

Referenced by save().

                                          : string
     {
         return $this->login_element_text;
     }

Here is the caller graph for this function:

◆ getLoginElementImage()

ilOpenIdConnectSettings::getLoginElementImage ( )

Returns: string

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

References $login_element_img_name.

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

                                            : string
     {
         return $this->login_element_img_name;
     }

Here is the caller graph for this function:

◆ getLoginElementType()

ilOpenIdConnectSettings::getLoginElementType ( )

Returns: int

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

References $login_element_type.

Referenced by save().

                                           : int
     {
         return $this->login_element_type;
     }

Here is the caller graph for this function:

◆ getLoginPromptType()

ilOpenIdConnectSettings::getLoginPromptType ( )

Returns: int

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

References $login_prompt_type.

Referenced by save().

                                          : int
     {
         return $this->login_prompt_type;
     }

Here is the caller graph for this function:

◆ getLogoutScope()

ilOpenIdConnectSettings::getLogoutScope ( )

Returns: int

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

References $logout_scope.

Referenced by save().

                                      : int
     {
         return $this->logout_scope;
     }

Here is the caller graph for this function:

◆ getProfileMappingFields()

ilOpenIdConnectSettings::getProfileMappingFields ( )

Returns: array

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

Referenced by load(), and save().

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

Here is the caller graph for this function:

◆ getProfileMappingFieldUpdate()

ilOpenIdConnectSettings::getProfileMappingFieldUpdate ( string $field )

Parameters

string $value

Returns: bool

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

Referenced by save().

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

Here is the caller graph for this function:

◆ getProfileMappingFieldValue()

ilOpenIdConnectSettings::getProfileMappingFieldValue ( string $field )

Parameters

string $field

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

Referenced by save().

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

Here is the caller graph for this function:

◆ getProvider()

ilOpenIdConnectSettings::getProvider ( )

Returns: string

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

References $provider.

Referenced by save().

                                   : string
     {
         return $this->provider;
     }

Here is the caller graph for this function:

◆ getRole()

ilOpenIdConnectSettings::getRole ( )

Returns: int

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

References $role.

Referenced by save().

                               : int
     {
         return $this->role;
     }

Here is the caller graph for this function:

◆ getRoleMappings()

ilOpenIdConnectSettings::getRoleMappings ( )

Get role mappings.

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

References $role_mappings.

Referenced by save().

                                       : array
     {
         return (array) $this->role_mappings;
     }

Here is the caller graph for this function:

◆ getRoleMappingUpdateForId()

ilOpenIdConnectSettings::getRoleMappingUpdateForId ( $a_role_id )

Parameters

$a_role_id

Returns: string

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

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

◆ getRoleMappingValueForId()

ilOpenIdConnectSettings::getRoleMappingValueForId ( $a_role_id )

Parameters

$a_role_id

Returns: string

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

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

◆ getSecret()

ilOpenIdConnectSettings::getSecret ( )

Get secret.

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

References $secret.

Referenced by save().

                                 : string
     {
         return $this->secret;
     }

Here is the caller graph for this function:

◆ getSessionDuration()

ilOpenIdConnectSettings::getSessionDuration ( )

Returns: int

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

References $session_duration.

Referenced by save().

                                          : int
     {
         return $this->session_duration;
     }

Here is the caller graph for this function:

◆ getUidField()

ilOpenIdConnectSettings::getUidField ( )

Returns: string

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

References $uid.

Referenced by save().

                                   : string
     {
         return $this->uid;
     }

Here is the caller graph for this function:

◆ hasImageFile()

ilOpenIdConnectSettings::hasImageFile ( )

Returns: bool

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

References getLoginElementImage().

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

Here is the call graph for this function:

◆ isCustomSession()

ilOpenIdConnectSettings::isCustomSession ( )

Returns: bool

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

References $custom_session.

Referenced by save().

                                       : bool
     {
         return $this->custom_session;
     }

Here is the caller graph for this function:

◆ isSyncAllowed()

ilOpenIdConnectSettings::isSyncAllowed ( )

Returns: bool

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

References $allow_sync.

Referenced by save().

                                     : bool
     {
         return $this->allow_sync;
     }

Here is the caller graph for this function:

◆ load()

ilOpenIdConnectSettings::load ( )

protected

Load from settings.

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

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

Referenced by __construct().

     {
         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, '');
         }
 
         $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->setLoginElementImage($this->storage->get('le_img', ''));
         $this->setLoginElementText($this->storage->get('le_text'));
         $this->setLoginElementType($this->storage->get('le_type'));
         $this->setLoginPromptType((int) $this->storage->get('prompt_type', self::LOGIN_ENFORCE));
         $this->setLogoutScope((int) $this->storage->get('logout_scope', self::LOGOUT_SCOPE_GLOBAL));
         $this->useCustomSession((bool) $this->storage->get('custom_session'), false);
         $this->setSessionDuration((int) $this->storage->get('session_duration', 60));
         $this->allowSync((bool) $this->storage->get('allow_sync'), false);
         $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([]))));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilOpenIdConnectSettings::save ( )

Save in settings.

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

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

     {
         $this->storage->set('active', (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('le_img', $this->getLoginElementImage());
         $this->storage->set('le_text', $this->getLoginElemenText());
         $this->storage->set('le_type', $this->getLoginElementType());
         $this->storage->set('prompt_type', $this->getLoginPromptType());
         $this->storage->set('logout_scope', $this->getLogoutScope());
         $this->storage->set('custom_session', (int) $this->isCustomSession());
         $this->storage->set('session_duration', (int) $this->getSessionDuration());
         $this->storage->set('allow_sync', (int) $this->isSyncAllowed());
         $this->storage->set('role', (int) $this->getRole());
         $this->storage->set('uid', (string) $this->getUidField());
 
         foreach ($this->getProfileMappingFields() as $field => $lang_key) {
             $this->storage->set('pmap_' . $field, $this->getProfileMappingFieldValue($field));
             $this->storage->set('pumap_' . $field, $this->getProfileMappingFieldUpdate($field));
         }
         $this->storage->set('role_mappings', (string) serialize($this->getRoleMappings()));
     }

Here is the call graph for this function:

◆ setActive()

ilOpenIdConnectSettings::setActive ( bool $active )

Parameters

bool $active

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

References $active.

Referenced by load().

     {
         $this->active = $active;
     }

Here is the caller graph for this function:

◆ setClientId()

ilOpenIdConnectSettings::setClientId ( string $client_id )

Parameters

string $client_id

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

References $client_id.

Referenced by load().

     {
         $this->client_id = $client_id;
     }

Here is the caller graph for this function:

◆ setLoginElementImage()

ilOpenIdConnectSettings::setLoginElementImage ( string $a_img_name )

Parameters

string $a_img_name

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

Referenced by load().

     {
         $this->login_element_img_name = $a_img_name;
     }

Here is the caller graph for this function:

◆ setLoginElementText()

ilOpenIdConnectSettings::setLoginElementText ( string $text )

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

References $text.

Referenced by load().

     {
         $this->login_element_text = $text;
     }

Here is the caller graph for this function:

◆ setLoginElementType()

ilOpenIdConnectSettings::setLoginElementType ( int $type )

Set login element type.

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

References $type.

Referenced by load().

     {
         $this->login_element_type = $type;
     }

Here is the caller graph for this function:

◆ setLoginPromptType()

ilOpenIdConnectSettings::setLoginPromptType ( int $a_type )

Parameters

int $a_type

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

References $a_type.

Referenced by load().

     {
         $this->login_prompt_type = $a_type;
     }

Here is the caller graph for this function:

◆ setLogoutScope()

ilOpenIdConnectSettings::setLogoutScope ( int $a_scope )

Parameters

int $a_scope

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

Referenced by load().

     {
         $this->logout_scope = $a_scope;
     }

Here is the caller graph for this function:

◆ setProfileMappingFieldUpdate()

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

Parameters

string	$field
bool	$value

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

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

◆ setProfileMappingFieldValue()

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

Parameters

string	$field
string	$value

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

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

◆ setProvider()

ilOpenIdConnectSettings::setProvider ( string $url )

Parameters

string $url

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

References $url.

Referenced by load().

     {
         $this->provider = $url;
     }

Here is the caller graph for this function:

◆ setRole()

ilOpenIdConnectSettings::setRole ( int $role )

Parameters

int $role

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

References $role.

Referenced by load().

     {
         $this->role = $role;
     }

Here is the caller graph for this function:

◆ setRoleMappings()

ilOpenIdConnectSettings::setRoleMappings ( array $a_role_mappings )

Parameters

array $a_role_mappings

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

Referenced by load().

     {
         $this->role_mappings = $a_role_mappings;
     }

Here is the caller graph for this function:

◆ setSecret()

ilOpenIdConnectSettings::setSecret ( string $secret )

Parameters

string $secret

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

References $secret.

Referenced by load().

     {
         $this->secret = $secret;
     }

Here is the caller graph for this function:

◆ setSessionDuration()

ilOpenIdConnectSettings::setSessionDuration ( int $a_duration )

Parameters

int $a_duration

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

Referenced by load().

     {
         $this->session_duration = $a_duration;
     }

Here is the caller graph for this function:

◆ setUidField()

ilOpenIdConnectSettings::setUidField ( string $field )

Parameters

string $field

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

Referenced by load().

     {
         $this->uid = $field;
     }

Here is the caller graph for this function:

◆ useCustomSession()

ilOpenIdConnectSettings::useCustomSession ( bool $a_stat )

Parameters

bool $a_stat

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

Referenced by load().

     {
         $this->custom_session = $a_stat;
     }

Here is the caller graph for this function:

Field Documentation

◆ $active

ilOpenIdConnectSettings::$active = false

private

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

Referenced by getActive(), and setActive().

◆ $allow_sync

ilOpenIdConnectSettings::$allow_sync

private

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

Referenced by isSyncAllowed().

◆ $client_id

ilOpenIdConnectSettings::$client_id = ''

private

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

Referenced by getClientId(), and setClientId().

◆ $custom_session

ilOpenIdConnectSettings::$custom_session = false

private

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

Referenced by isCustomSession().

◆ $filesystem

ilOpenIdConnectSettings::$filesystem = null

private

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

◆ $instance

ilOpenIdConnectSettings::$instance = null

staticprivate

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

◆ $login_element_img_name

ilOpenIdConnectSettings::$login_element_img_name

private

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

Referenced by getLoginElementImage().

◆ $login_element_text

ilOpenIdConnectSettings::$login_element_text

private

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

Referenced by getLoginElemenText().

◆ $login_element_type

ilOpenIdConnectSettings::$login_element_type = self::LOGIN_ELEMENT_TYPE_TXT

private

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

Referenced by getLoginElementType().

◆ $login_prompt_type

ilOpenIdConnectSettings::$login_prompt_type = self::LOGIN_ENFORCE

private

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

Referenced by getLoginPromptType().

◆ $logout_scope

ilOpenIdConnectSettings::$logout_scope

private

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

Referenced by getLogoutScope().

◆ $profile_map

ilOpenIdConnectSettings::$profile_map = []

private

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

◆ $profile_update_map

ilOpenIdConnectSettings::$profile_update_map = []

private

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

◆ $provider

ilOpenIdConnectSettings::$provider = ''

private

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

Referenced by getProvider().

◆ $role

ilOpenIdConnectSettings::$role

private

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

Referenced by getRole(), and setRole().

◆ $role_mappings

ilOpenIdConnectSettings::$role_mappings = []

private

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

Referenced by getRoleMappings().

◆ $secret

ilOpenIdConnectSettings::$secret = ''

private

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

Referenced by getSecret(), and setSecret().

◆ $session_duration

ilOpenIdConnectSettings::$session_duration = 60

private

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

Referenced by getSessionDuration().

◆ $storage

ilOpenIdConnectSettings::$storage = null

private

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

◆ $uid

ilOpenIdConnectSettings::$uid = ''

private

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

Referenced by getUidField().

◆ FILE_STORAGE

const ilOpenIdConnectSettings::FILE_STORAGE = 'openidconnect/login_form_image'

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

Referenced by ilOpenIdConnectSettingsGUI\saveImageFromHttpRequest().

◆ LOGIN_ELEMENT_TYPE_IMG

const ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_IMG = 1

Definition at line 17 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 16 of file class.ilOpenIdConnectSettings.php.

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

◆ LOGIN_ENFORCE

const ilOpenIdConnectSettings::LOGIN_ENFORCE = 0

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

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

◆ LOGIN_STANDARD

const ilOpenIdConnectSettings::LOGIN_STANDARD = 1

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

Referenced by ilOpenIdConnectSettingsGUI\initSettingsForm().

◆ LOGOUT_SCOPE_GLOBAL

const ilOpenIdConnectSettings::LOGOUT_SCOPE_GLOBAL = 0

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

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

◆ LOGOUT_SCOPE_LOCAL

const ilOpenIdConnectSettings::LOGOUT_SCOPE_LOCAL = 1

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

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

◆ STORAGE_ID

const ilOpenIdConnectSettings::STORAGE_ID = 'oidc'

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

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()

◆ getClientId()

◆ getImageFilePath()

◆ getInstance()

◆ getLoginElemenText()

◆ getLoginElementImage()

◆ getLoginElementType()

◆ getLoginPromptType()

◆ getLogoutScope()

◆ getProfileMappingFields()

◆ getProfileMappingFieldUpdate()

◆ getProfileMappingFieldValue()

◆ getProvider()

◆ getRole()

◆ getRoleMappings()

◆ getRoleMappingUpdateForId()

◆ getRoleMappingValueForId()

◆ getSecret()

◆ getSessionDuration()

◆ getUidField()

◆ hasImageFile()

◆ isCustomSession()

◆ isSyncAllowed()

◆ load()

◆ save()

◆ setActive()

◆ setClientId()

◆ setLoginElementImage()

◆ setLoginElementText()

◆ setLoginElementType()

◆ setLoginPromptType()

◆ setLogoutScope()

◆ setProfileMappingFieldUpdate()

◆ setProfileMappingFieldValue()

◆ setProvider()

◆ setRole()

◆ setRoleMappings()

◆ setSecret()

◆ setSessionDuration()

◆ setUidField()

◆ useCustomSession()

Field Documentation

◆ $active

◆ $allow_sync

◆ $client_id

◆ $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

◆ $role_mappings

◆ $secret

◆ $session_duration

◆ $storage

◆ $uid

◆ FILE_STORAGE

◆ LOGIN_ELEMENT_TYPE_IMG

◆ LOGIN_ELEMENT_TYPE_TXT

◆ LOGIN_ENFORCE

◆ LOGIN_STANDARD