ilRadiusSettings Class Reference

Collaboration diagram for ilRadiusSettings:

Public Member Functions
	isActive ()
	setActive ($a_status)
	setPort ($a_port)
	getPort ()
	setSecret ($a_secret)
	getSecret ()
	setServerString ($a_server_string)
	getServersAsString ()
	getServers ()
	setName ($a_name)
	getName ()
	toPearAuthArray ()
	Create options array for PEAR Auth constructor. More...
	getDefaultRole ()
	Get default role for new radius users. More...
	setDefaultRole ($a_role)
	enabledCreation ()
	Enable creation of users. More...
	enableCreation ($a_status)
	Enable creation. More...
	enableAccountMigration ($a_status)
	Enable account migration. More...
	isAccountMigrationEnabled ()
	enabled account migration More...
	getCharset ()
	get charset More...
	setCharset ($a_charset)
	set charset More...
	save ()
	Save settings. More...
	validateRequired ()
	Validate required. More...
	validatePort ()
	Validate port. More...
	validateServers ()
	Validate servers. More...

Static Public Member Functions
static	_getInstance ()
	singleton get instance More...

Data Fields
const	RADIUS_CHARSET_UTF8 = 0
const	RADIUS_CHARSET_LATIN1 = 1
const	SYNC_DISABLED = 0
const	SYNC_RADIUS = 1
const	SYNC_LDAP = 2
	$active = false

Private Member Functions
	__construct ()
	singleton constructor More...
	read ()
	Read settings. More...

Private Attributes
	$settings
	$db
	$account_migration = false
	$servers = array()

Static Private Attributes
static	$instance = null

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilRadiusSettings::__construct ( )

private

singleton constructor

private

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

References $ilDB, $ilSetting, read(), and settings().

        {
                global $ilSetting,$ilDB;
                
                $this->settings = $ilSetting;
                $this->db = $ilDB;
                
                $this->read();
        }

Here is the call graph for this function:

Member Function Documentation

_getInstance()

static ilRadiusSettings::_getInstance ( )

static

singleton get instance

public

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

Referenced by ilAuthProviderRadius\__construct(), ilRadiusAttributeToUser\__construct(), ilAuthUtils\_getMultipleAuthModeOptions(), ilAuthUtils\_hasMultipleAuthenticationMethods(), ilAuthLoginPageEditorGUI\initLoginForm(), ilAuthContainerRadius\initSettings(), ilRadiusSettingsGUI\initSettings(), and ilAuthModeDetermination\read().

        {
                if(isset(self::$instance) and self::$instance)
                {
                        return self::$instance;
                }
                return self::$instance = new ilRadiusSettings();
        }

Here is the caller graph for this function:

enableAccountMigration()

ilRadiusSettings::enableAccountMigration

(

$a_status

)

Enable account migration.

public

Parameters

bool

status

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

        {
                $this->account_migration = $a_status;
        }

enableCreation()

ilRadiusSettings::enableCreation

(

$a_status

)

Enable creation.

public

Parameters

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

        {
                $this->creation = $a_status;
        }

enabledCreation()

ilRadiusSettings::enabledCreation

(

)

Enable creation of users.

public

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

Referenced by save(), and validateRequired().

        {
                return $this->creation;
        }

Here is the caller graph for this function:

getCharset()

ilRadiusSettings::getCharset

(

)

get charset

public

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

Referenced by save().

        {
                return $this->charset ? 1 : 0;
        }

Here is the caller graph for this function:

getDefaultRole()

ilRadiusSettings::getDefaultRole

(

)

Get default role for new radius users.

public

Returns

int role_id

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

Referenced by save(), and validateRequired().

        {
                return $this->default_role;
        }

Here is the caller graph for this function:

getName()

ilRadiusSettings::getName

(

)

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

Referenced by save(), and validateRequired().

        {
                return $this->name;
        }

Here is the caller graph for this function:

getPort()

ilRadiusSettings::getPort

(

)

Definition at line 95 of file class.ilRadiusSettings.php.

Referenced by save(), toPearAuthArray(), validatePort(), and validateRequired().

        {
                return $this->port;
        }

Here is the caller graph for this function:

getSecret()

ilRadiusSettings::getSecret

(

)

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

Referenced by save(), toPearAuthArray(), and validateRequired().

        {
                return $this->secret;
        }

Here is the caller graph for this function:

getServers()

ilRadiusSettings::getServers

(

)

Definition at line 116 of file class.ilRadiusSettings.php.

References array.

Referenced by save(), and toPearAuthArray().

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

Here is the caller graph for this function:

getServersAsString()

ilRadiusSettings::getServersAsString

(

)

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

Referenced by validateRequired().

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

Here is the caller graph for this function:

isAccountMigrationEnabled()

ilRadiusSettings::isAccountMigrationEnabled

(

)

enabled account migration

public

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

Referenced by save().

        {
                return $this->account_migration ? true : false;
        }

Here is the caller graph for this function:

isActive()

ilRadiusSettings::isActive

(

)

Definition at line 83 of file class.ilRadiusSettings.php.

Referenced by save().

        {
                return $this->active ? true : false;
        }

Here is the caller graph for this function:

read()

ilRadiusSettings::read ( )

private

Read settings.

private

Definition at line 330 of file class.ilRadiusSettings.php.

References ilObjRole\_getRolesByAuthMode(), array, and settings().

Referenced by __construct().

        {
                $all_settings = $this->settings->getAll();

                $sets = array("radius_active" => "setActive",
                        "radius_port" => "setPort",
                        "radius_shared_secret" => "setSecret",
                        "radius_name" => "setName",
                        "radius_creation" => "enableCreation",
                        "radius_migration" => "enableAccountMigration",
                        "radius_charset" => "setCharset"
                        );
                foreach ($sets as $s => $m)
                {
                        if (isset($all_settings[$s]))
                        {
                                $this->$m($all_settings[$s]);
                        }
                }
                
                reset($all_settings);
                foreach($all_settings as $k => $v)
                {
                        if (substr($k, 0, 13) == "radius_server")
                        {
                                $this->servers[] = $v;
                        }
                }
                
                include_once('./Services/AccessControl/classes/class.ilObjRole.php');
                $roles = ilObjRole::_getRolesByAuthMode('radius');
                $this->default_role = 0;
                if (isset($roles[0]) && $roles[0])
                {
                        $this->default_role = $roles[0];
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilRadiusSettings::save

(

)

Save settings.

public

Definition at line 236 of file class.ilRadiusSettings.php.

References $counter, $server, ilObjRole\_resetAuthMode(), ilObjRole\_updateAuthMode(), array, enabledCreation(), getCharset(), getDefaultRole(), getName(), getPort(), getSecret(), getServers(), isAccountMigrationEnabled(), isActive(), and settings().

        {
                // first delete old servers
                $this->settings->deleteLike('radius_server%');
                
                $this->settings->set('radius_active',$this->isActive() ? 1 : 0);
                $this->settings->set('radius_port',$this->getPort());
                $this->settings->set('radius_shared_secret',$this->getSecret());
                $this->settings->set('radius_name',$this->getName());
                $this->settings->set('radius_creation',$this->enabledCreation() ? 1 : 0);
                $this->settings->set('radius_migration',$this->isAccountMigrationEnabled() ? 1 : 0);
                $this->settings->set('radius_charset',$this->getCharset() ? 1 : 0);
                
                $counter = 0;
                foreach($this->getServers() as $server)
                {
                        if(++$counter == 1)
                        {
                                $this->settings->set('radius_server',trim($server));
                        }
                        else
                        {
                                $this->settings->set('radius_server'.$counter,trim($server));
                        }
                }
                
                include_once('./Services/AccessControl/classes/class.ilObjRole.php');
                ilObjRole::_resetAuthMode('radius');
                
                if($this->getDefaultRole())
                {
                        ilObjRole::_updateAuthMode(array($this->getDefaultRole() => 'radius'));
                }
                return true;
        }

Here is the call graph for this function:

setActive()

ilRadiusSettings::setActive

(

$a_status

)

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

        {
                $this->active = $a_status;
        }

setCharset()

ilRadiusSettings::setCharset

(

$a_charset

)

set charset

public

Parameters

int

charset

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

        {
                $this->charset = $a_charset;
        }

setDefaultRole()

ilRadiusSettings::setDefaultRole

(

$a_role

)

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

        {
                $this->default_role = $a_role;
        }

setName()

ilRadiusSettings::setName

(

$a_name

)

Definition at line 120 of file class.ilRadiusSettings.php.

        {
                $this->name = $a_name;
        }

setPort()

ilRadiusSettings::setPort

(

$a_port

)

Definition at line 91 of file class.ilRadiusSettings.php.

        {
                $this->port = $a_port;
        }

setSecret()

ilRadiusSettings::setSecret

(

$a_secret

)

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

        {
                $this->secret = $a_secret;
        }

setServerString()

ilRadiusSettings::setServerString

(

$a_server_string

)

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

        {
                $this->server_string = $a_server_string;
                $this->servers = explode(',',$this->server_string);
        }

toPearAuthArray()

ilRadiusSettings::toPearAuthArray

(

)

Create options array for PEAR Auth constructor.

public

Definition at line 135 of file class.ilRadiusSettings.php.

References $server, array, getPort(), getSecret(), and getServers().

        {
                foreach($this->getServers() as $server)
                {
                        $auth_params['servers'][] = array($server,$this->getPort(),$this->getSecret());
                }
                return $auth_params ? $auth_params : array();
        }

Here is the call graph for this function:

validatePort()

ilRadiusSettings::validatePort

(

)

Validate port.

public

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

References getPort().

        {
                return preg_match("/^[0-9]{0,5}$/",$this->getPort()) == 1;
        }

Here is the call graph for this function:

validateRequired()

ilRadiusSettings::validateRequired

(

)

Validate required.

public

Definition at line 278 of file class.ilRadiusSettings.php.

References $ok, enabledCreation(), getDefaultRole(), getName(), getPort(), getSecret(), and getServersAsString().

        {
                $ok = strlen($this->getServersAsString()) and strlen($this->getPort()) and strlen($this->getSecret()) and strlen($this->getName());
                
                $role_ok = true;
                if($this->enabledCreation() and !$this->getDefaultRole())
                {
                        $role_ok = false;
                }
                return $ok and $role_ok;
        }

Here is the call graph for this function:

validateServers()

ilRadiusSettings::validateServers

(

)

Validate servers.

public

Definition at line 307 of file class.ilRadiusSettings.php.

References $server, $servers, ilUtil\isDN(), and ilUtil\isIPv4().

        {
                $servers = explode(",",$this->server_string);
                
                foreach ($servers as $server)
                {
                        $server = trim($server);

                        if (!ilUtil::isIPv4($server) and !ilUtil::isDN($server))
                        {
                                return false;
                        }
                }
                return true;
        }

Here is the call graph for this function:

Field Documentation

$account_migration

ilRadiusSettings::$account_migration = false

private

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

$active

ilRadiusSettings::$active = false

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

$db

ilRadiusSettings::$db

private

Definition at line 43 of file class.ilRadiusSettings.php.

$instance

ilRadiusSettings::$instance = null

staticprivate

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

$servers

ilRadiusSettings::$servers = array()

private

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

Referenced by validateServers().

$settings

ilRadiusSettings::$settings

private

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

RADIUS_CHARSET_LATIN1

const ilRadiusSettings::RADIUS_CHARSET_LATIN1 = 1

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

Referenced by ilAuthContainerRadius\__construct(), and ilRadiusSettingsGUI\prepareCharsetSelection().

RADIUS_CHARSET_UTF8

const ilRadiusSettings::RADIUS_CHARSET_UTF8 = 0

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

Referenced by ilRadiusSettingsGUI\prepareCharsetSelection().

SYNC_DISABLED

const ilRadiusSettings::SYNC_DISABLED = 0

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

Referenced by ilRadiusSettingsGUI\save(), and ilRadiusSettingsGUI\settings().

SYNC_LDAP

const ilRadiusSettings::SYNC_LDAP = 2

Definition at line 39 of file class.ilRadiusSettings.php.

Referenced by ilRadiusSettingsGUI\save(), and ilRadiusSettingsGUI\settings().

SYNC_RADIUS

const ilRadiusSettings::SYNC_RADIUS = 1

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

Referenced by ilRadiusSettingsGUI\save(), and ilRadiusSettingsGUI\settings().

---

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

• Services/Radius/classes/class.ilRadiusSettings.php