Collaboration diagram for ilRegistrationSettings:

Public Member Functions
	ilRegistrationSettings ()

	getRegistrationType ()

	setRegistrationType ($a_type)

	_lookupRegistrationType ()

	enabled ()

	directEnabled ()

	approveEnabled ()

	activationEnabled ()

	registrationCodeRequired ()

	passwordGenerationEnabled ()

	setPasswordGenerationStatus ($a_status)

	getAccessLimitation ()

	setAccessLimitation ($a_access_limitation)

	setApproveRecipientLogins ($a_rec_string)

	getApproveRecipientLogins ()

	getApproveRecipients ()

	getUnknown ()

	roleSelectionEnabled ()

	automaticRoleAssignmentEnabled ()

	setRoleType ($a_type)

	setRegistrationHashLifetime ($a_lifetime)

	getRegistrationHashLifetime ()

	setAllowCodes ($a_allow_codes)

	getAllowCodes ()

	setAllowedDomains ($a_value)

	getAllowedDomains ()

	validate ()

	save ()

	__read ()

Data Fields
const	ERR_UNKNOWN_RCP = 1

const	ERR_MISSING_RCP = 2

const	REG_HASH_LIFETIME_MIN_VALUE = 60

Private Attributes
	$registration_type

	$password_generation_enabled

	$access_limitation

	$approve_recipient_logins

	$approve_recipient_ids

	$role_type

	$unknown

	$reg_hash_life_time = 0

	$reg_allow_codes = false

	$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

Version: $Id$

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

Member Function Documentation

◆ __read()

ilRegistrationSettings::__read ( )

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

References ilObjUser\_lookupLogin(), and setAllowedDomains().

Referenced by ilRegistrationSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupRegistrationType()

ilRegistrationSettings::_lookupRegistrationType ( )

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

References $ret, and IL_REG_DISABLED.

Referenced by ilMainMenuGUI\getLanguageSelection(), and ilStartUpGUI\showRegistrationLinks().

         {
                 global $ilias;
 
                 $ret  = (int)$ilias->getSetting('new_registration_type',IL_REG_DISABLED);
 
                 if($ret < 1 or $ret > 5)
                 {
                         //data is corrupted and should be processed like "No Registration possible" (#18261)
                         $ret = IL_REG_DISABLED;
                 }
 
                 return $ret;
         }

Here is the caller graph for this function:

◆ activationEnabled()

ilRegistrationSettings::activationEnabled ( )

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

References IL_REG_ACTIVATION.

         {
                 return $this->registration_type == IL_REG_ACTIVATION;
         }

◆ approveEnabled()

ilRegistrationSettings::approveEnabled ( )

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

References IL_REG_APPROVE.

         {
                 return $this->registration_type == IL_REG_APPROVE;
         }

◆ automaticRoleAssignmentEnabled()

ilRegistrationSettings::automaticRoleAssignmentEnabled ( )

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

References IL_REG_ROLES_EMAIL.

         {
                 return $this->role_type == IL_REG_ROLES_EMAIL;
         }

◆ directEnabled()

ilRegistrationSettings::directEnabled ( )

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

References IL_REG_DIRECT.

         {
                 return $this->registration_type == IL_REG_DIRECT;
         }

◆ enabled()

ilRegistrationSettings::enabled ( )

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

References IL_REG_DISABLED.

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

◆ getAccessLimitation()

ilRegistrationSettings::getAccessLimitation ( )

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

References $access_limitation.

         {
                 return $this->access_limitation;
         }

◆ getAllowCodes()

ilRegistrationSettings::getAllowCodes ( )

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

References $reg_allow_codes.

         {
                 return $this->reg_allow_codes;
         }

◆ getAllowedDomains()

ilRegistrationSettings::getAllowedDomains ( )

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

References $allowed_domains.

         {
                 return (array)$this->allowed_domains;
         }

◆ getApproveRecipientLogins()

ilRegistrationSettings::getApproveRecipientLogins ( )

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

References $approve_recipient_logins.

Referenced by validate().

         {
                 return $this->approve_recipient_logins;
         }

Here is the caller graph for this function:

◆ getApproveRecipients()

ilRegistrationSettings::getApproveRecipients ( )

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

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

◆ getRegistrationHashLifetime()

ilRegistrationSettings::getRegistrationHashLifetime ( )

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

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

◆ getRegistrationType()

ilRegistrationSettings::getRegistrationType ( )

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

References $registration_type.

Referenced by validate().

         {
                 return $this->registration_type;
         }

Here is the caller graph for this function:

◆ getUnknown()

ilRegistrationSettings::getUnknown ( )

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

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

◆ ilRegistrationSettings()

ilRegistrationSettings::ilRegistrationSettings ( )

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

References __read().

         {
                 $this->__read();
         }

Here is the call graph for this function:

◆ passwordGenerationEnabled()

ilRegistrationSettings::passwordGenerationEnabled ( )

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

References $password_generation_enabled.

         {
                 return $this->password_generation_enabled;
         }

◆ registrationCodeRequired()

ilRegistrationSettings::registrationCodeRequired ( )

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

References IL_REG_CODES.

         {
                 return $this->registration_type == IL_REG_CODES;
         }

◆ roleSelectionEnabled()

ilRegistrationSettings::roleSelectionEnabled ( )

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

References IL_REG_ROLES_FIXED.

         {
                 return $this->role_type == IL_REG_ROLES_FIXED;
         }

◆ save()

ilRegistrationSettings::save ( )

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

         {
                 global $ilias;
 
                 $ilias->setSetting('reg_role_assignment',$this->role_type);
                 $ilias->setSetting('new_registration_type',$this->registration_type);
                 $ilias->setSetting('passwd_reg_auto_generate',$this->password_generation_enabled);
                 $ilias->setSetting('approve_recipient',addslashes(serialize($this->approve_recipient_ids)));
                 $ilias->setSetting('reg_access_limitation',$this->access_limitation);
                 $ilias->setSetting('reg_hash_life_time',$this->reg_hash_life_time);
                 $ilias->setSetting('reg_allow_codes',$this->reg_allow_codes);   
                 $ilias->setSetting('reg_allowed_domains',implode(';', $this->allowed_domains));
                 
                 return true;
         }

◆ setAccessLimitation()

ilRegistrationSettings::setAccessLimitation ( $a_access_limitation )

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

         {
                 $this->access_limitation = $a_access_limitation;
         }

◆ setAllowCodes()

ilRegistrationSettings::setAllowCodes ( $a_allow_codes )

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

         {
                 $this->reg_allow_codes = (bool)$a_allow_codes;
 
                 return $this;
         }

◆ setAllowedDomains()

ilRegistrationSettings::setAllowedDomains ( $a_value )

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

Referenced by __read().

         {
                 $a_value = explode(";", trim($a_value));
                 $this->allowed_domains = $a_value;
         }

Here is the caller graph for this function:

◆ setApproveRecipientLogins()

ilRegistrationSettings::setApproveRecipientLogins ( $a_rec_string )

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

References ilObjUser\_lookupId().

         {
                 $this->approve_recipient_logins = $a_rec_string;
                 $this->approve_recipient_ids = array();
 
                 // 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 ( $a_status )

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

         {
                 $this->password_generation_enabled = $a_status;
         }

◆ setRegistrationHashLifetime()

ilRegistrationSettings::setRegistrationHashLifetime ( $a_lifetime )

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

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

◆ setRegistrationType()

ilRegistrationSettings::setRegistrationType ( $a_type )

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

         {
                 $this->registration_type = $a_type;
         }

◆ setRoleType()

ilRegistrationSettings::setRoleType ( $a_type )

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

         {
                 $this->role_type = $a_type;
         }

◆ validate()

ilRegistrationSettings::validate ( )

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

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

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