Collaboration diagram for ilRegistrationSettings:

Public Member Functions
	__construct (?ilSetting $settings=null)

	getRegistrationType ()

	setRegistrationType (int $a_type)

	enabled ()

	directEnabled ()

	approveEnabled ()

	activationEnabled ()

	registrationCodeRequired ()

	passwordGenerationEnabled ()

	setPasswordGenerationStatus (bool $a_status)

	getAccessLimitation ()

	setAccessLimitation (bool $a_access_limitation)

	setApproveRecipientLogins (string $a_rec_string)

	getApproveRecipientLogins ()

	getApproveRecipients ()

	getUnknown ()

	roleSelectionEnabled ()

	automaticRoleAssignmentEnabled ()

	setRoleType (int $a_type)

	setRegistrationHashLifetime (int $a_lifetime)

	getRegistrationHashLifetime ()

	setAllowCodes (bool $a_allow_codes)

	getAllowCodes ()

	setAllowedDomains (string $a_value)

	getAllowedDomains ()

	validate ()

	save ()

Static Public Member Functions
static	_lookupRegistrationType ()

Data Fields
const	ERR_UNKNOWN_RCP = 1

const	ERR_MISSING_RCP = 2

const	REG_HASH_LIFETIME_MIN_VALUE = 60

const	IL_REG_DISABLED = 1

const	IL_REG_DIRECT = 2

const	IL_REG_APPROVE = 3

const	IL_REG_ACTIVATION = 4

const	IL_REG_CODES = 5

const	IL_REG_ROLE_UNDEFINED = 0

const	IL_REG_ROLES_FIXED = 1

const	IL_REG_ROLES_EMAIL = 2

const	IL_REG_ERROR_UNKNOWN = 1

const	IL_REG_ERROR_NO_PERM = 2

Protected Attributes
ilSetting	$settings

Private Member Functions
	read ()

Private Attributes
int	$registration_type

bool	$password_generation_enabled = false

bool	$access_limitation = false

string	$approve_recipient_logins = ''

array	$approve_recipient_ids = []

int	$role_type = self::IL_REG_ROLE_UNDEFINED

array	$unknown = []

int	$reg_hash_life_time = 0

bool	$reg_allow_codes = false

array	$allowed_domains = []

Detailed Description

Class ilObjAuthSettingsGUI.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilRegistrationSettings::__construct ( ?ilSetting $settings = null )

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

References $DIC, $settings, null, read(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         if (null == $settings) {
             $settings = $DIC->settings();
         }
 
         $this->settings = $settings;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _lookupRegistrationType()

static ilRegistrationSettings::_lookupRegistrationType ( )

static

Definition at line 79 of file class.ilRegistrationSettings.php.

References $DIC, $ilSetting, and ILIAS\Repository\int().

Referenced by ilStartUpGUI\showRegistrationLinks().

                                                     : int
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
         $ret = (int) $ilSetting->get('new_registration_type', (string) self::IL_REG_DISABLED);
 
         if ($ret < 1 || $ret > 5) {
             //data is corrupted and should be processed like "No Registration possible" (#18261)
             $ret = self::IL_REG_DISABLED;
         }
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activationEnabled()

ilRegistrationSettings::activationEnabled ( )

Definition at line 108 of file class.ilRegistrationSettings.php.

                                        : bool
     {
         return $this->registration_type === self::IL_REG_ACTIVATION;
     }

◆ approveEnabled()

ilRegistrationSettings::approveEnabled ( )

Definition at line 103 of file class.ilRegistrationSettings.php.

                                     : bool
     {
         return $this->registration_type === self::IL_REG_APPROVE;
     }

◆ automaticRoleAssignmentEnabled()

ilRegistrationSettings::automaticRoleAssignmentEnabled ( )

Definition at line 171 of file class.ilRegistrationSettings.php.

                                                     : bool
     {
         return $this->role_type === self::IL_REG_ROLES_EMAIL;
     }

◆ directEnabled()

ilRegistrationSettings::directEnabled ( )

Definition at line 98 of file class.ilRegistrationSettings.php.

                                    : bool
     {
         return $this->registration_type === self::IL_REG_DIRECT;
     }

◆ enabled()

ilRegistrationSettings::enabled ( )

Definition at line 93 of file class.ilRegistrationSettings.php.

                              : bool
     {
         return $this->registration_type !== self::IL_REG_DISABLED;
     }

◆ getAccessLimitation()

ilRegistrationSettings::getAccessLimitation ( )

Definition at line 128 of file class.ilRegistrationSettings.php.

References $access_limitation.

                                          : bool
     {
         return $this->access_limitation;
     }

◆ getAllowCodes()

ilRegistrationSettings::getAllowCodes ( )

Definition at line 199 of file class.ilRegistrationSettings.php.

References $reg_allow_codes.

                                    : bool
     {
         return $this->reg_allow_codes;
     }

◆ getAllowedDomains()

ilRegistrationSettings::getAllowedDomains ( )

Definition at line 216 of file class.ilRegistrationSettings.php.

References $allowed_domains.

                                        : array
     {
         return $this->allowed_domains;
     }

◆ getApproveRecipientLogins()

ilRegistrationSettings::getApproveRecipientLogins ( )

Definition at line 151 of file class.ilRegistrationSettings.php.

References $approve_recipient_logins.

Referenced by validate().

                                                : string
     {
         return $this->approve_recipient_logins;
     }

Here is the caller graph for this function:

◆ getApproveRecipients()

ilRegistrationSettings::getApproveRecipients ( )

Definition at line 156 of file class.ilRegistrationSettings.php.

References $approve_recipient_ids.

                                           : array
     {
         return $this->approve_recipient_ids;
     }

◆ getRegistrationHashLifetime()

ilRegistrationSettings::getRegistrationHashLifetime ( )

Definition at line 187 of file class.ilRegistrationSettings.php.

                                                  : int
     {
         return max($this->reg_hash_life_time, self::REG_HASH_LIFETIME_MIN_VALUE);
     }

◆ getRegistrationType()

ilRegistrationSettings::getRegistrationType ( )

Definition at line 69 of file class.ilRegistrationSettings.php.

References $registration_type.

Referenced by validate().

                                          : int
     {
         return $this->registration_type;
     }

Here is the caller graph for this function:

◆ getUnknown()

ilRegistrationSettings::getUnknown ( )

Definition at line 161 of file class.ilRegistrationSettings.php.

                                 : string
     {
         return implode(',', $this->unknown);
     }

◆ passwordGenerationEnabled()

ilRegistrationSettings::passwordGenerationEnabled ( )

Definition at line 118 of file class.ilRegistrationSettings.php.

References $password_generation_enabled.

Referenced by ilUserProfile\addFieldToForm(), and ilUserProfile\getPasswordInput().

                                                : bool
     {
         return $this->password_generation_enabled;
     }

Here is the caller graph for this function:

◆ read()

ilRegistrationSettings::read ( )

private

Definition at line 260 of file class.ilRegistrationSettings.php.

References $id, ilObjUser\_lookupLogin(), ILIAS\Repository\int(), setAllowedDomains(), and ILIAS\Repository\settings().

Referenced by __construct().

                            : void
     {
         //static method validates value
         $this->registration_type = self::_lookupRegistrationType();
 
         $this->role_type = (int) $this->settings->get('reg_role_assignment', '1');
         $this->password_generation_enabled = (bool) $this->settings->get('passwd_reg_auto_generate');
         $this->access_limitation = (bool) $this->settings->get('reg_access_limitation');
         $this->reg_hash_life_time = (int) $this->settings->get('reg_hash_life_time');
         $this->reg_allow_codes = (bool) $this->settings->get('reg_allow_codes');
 
         $this->approve_recipient_ids = unserialize(
             stripslashes($this->settings->get('approve_recipient', serialize([]))),
             ['allowed_classes' => false]
         ) ?: [];
 
         // create login array
         $tmp_logins = [];
         foreach ($this->approve_recipient_ids as $id) {
             if ($login = ilObjUser::_lookupLogin((int) $id)) {
                 $tmp_logins[] = $login;
             }
         }
         $this->approve_recipient_logins = implode(',', $tmp_logins);
         $this->setAllowedDomains((string) $this->settings->get('reg_allowed_domains'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registrationCodeRequired()

ilRegistrationSettings::registrationCodeRequired ( )

Definition at line 113 of file class.ilRegistrationSettings.php.

                                               : bool
     {
         return $this->registration_type === self::IL_REG_CODES;
     }

◆ roleSelectionEnabled()

ilRegistrationSettings::roleSelectionEnabled ( )

Definition at line 166 of file class.ilRegistrationSettings.php.

Referenced by ilUserProfile\getRolesInput().

                                           : bool
     {
         return $this->role_type === self::IL_REG_ROLES_FIXED;
     }

Here is the caller graph for this function:

◆ save()

ilRegistrationSettings::save ( )

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

References ILIAS\Repository\settings().

                           : bool
     {
         $this->settings->set('reg_role_assignment', (string) $this->role_type);
         $this->settings->set('new_registration_type', (string) $this->registration_type);
         $this->settings->set('passwd_reg_auto_generate', (string) $this->password_generation_enabled);
         $this->settings->set('approve_recipient', addslashes(serialize($this->approve_recipient_ids)));
         $this->settings->set('reg_access_limitation', (string) $this->access_limitation);
         $this->settings->set('reg_hash_life_time', (string) $this->reg_hash_life_time);
         $this->settings->set('reg_allow_codes', (string) $this->reg_allow_codes);
         $this->settings->set('reg_allowed_domains', implode(';', $this->allowed_domains));
         return true;
     }

Here is the call graph for this function:

◆ setAccessLimitation()

ilRegistrationSettings::setAccessLimitation ( bool $a_access_limitation )

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

                                                                   : void
     {
         $this->access_limitation = $a_access_limitation;
     }

◆ setAllowCodes()

ilRegistrationSettings::setAllowCodes ( bool $a_allow_codes )

Definition at line 192 of file class.ilRegistrationSettings.php.

                                                       : self
     {
         $this->reg_allow_codes = $a_allow_codes;
 
         return $this;
     }

◆ setAllowedDomains()

ilRegistrationSettings::setAllowedDomains ( string $a_value )

Definition at line 204 of file class.ilRegistrationSettings.php.

Referenced by read().

                                                       : void
     {
         $a_value = array_map(
             static function (string $value): string {
                 return trim($value);
             },
             explode(";", trim($a_value))
         );
 
         $this->allowed_domains = $a_value;
     }

Here is the caller graph for this function:

◆ setApproveRecipientLogins()

ilRegistrationSettings::setApproveRecipientLogins ( string $a_rec_string )

Definition at line 138 of file class.ilRegistrationSettings.php.

References ilObjUser\_lookupId().

                                                                    : void
     {
         $this->approve_recipient_logins = $a_rec_string;
         $this->approve_recipient_ids = [];
 
         // convert logins to array of ids
         foreach (explode(',', trim($this->approve_recipient_logins)) as $login) {
             if ($uid = ilObjUser::_lookupId(trim($login))) {
                 $this->approve_recipient_ids[] = $uid;
             }
         }
     }

Here is the call graph for this function:

◆ setPasswordGenerationStatus()

ilRegistrationSettings::setPasswordGenerationStatus ( bool $a_status )

Definition at line 123 of file class.ilRegistrationSettings.php.

                                                                : void
     {
         $this->password_generation_enabled = $a_status;
     }

◆ setRegistrationHashLifetime()

ilRegistrationSettings::setRegistrationHashLifetime ( int $a_lifetime )

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

                                                                 : self
     {
         $this->reg_hash_life_time = $a_lifetime;
         return $this;
     }

◆ setRegistrationType()

ilRegistrationSettings::setRegistrationType ( int $a_type )

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

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

◆ setRoleType()

ilRegistrationSettings::setRoleType ( int $a_type )

Definition at line 176 of file class.ilRegistrationSettings.php.

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

◆ validate()

ilRegistrationSettings::validate ( )

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

References $valid, ilObjUser\_lookupId(), getApproveRecipientLogins(), and getRegistrationType().

                               : int
     {
         $this->unknown = [];
 
         $login_arr = explode(',', $this->getApproveRecipientLogins());
         $login_arr = $login_arr ?: [];
         $valid = [];
         foreach ($login_arr as $recipient) {
             if (!$recipient = trim($recipient)) {
                 continue;
             }
             if (!ilObjUser::_lookupId($recipient)) {
                 $this->unknown[] = $recipient;
             } else {
                 $valid[] = $recipient;
             }
         }
         if (count($this->unknown)) {
             return self::ERR_UNKNOWN_RCP;
         }
         if ($this->getRegistrationType() === self::IL_REG_APPROVE && !count($valid)) {
             return self::ERR_MISSING_RCP;
         }
         return 0;
     }