ilCASSettings Class Reference

Collaboration diagram for ilCASSettings:

Public Member Functions
	setServer (string $a_server)
	getServer ()
	setPort (int $a_port)
	getPort ()
	setUri (string $a_uri)
	getUri ()
	setLoginInstruction (string $a_inst)
	getLoginInstruction ()
	setActive ($a_active)
	isActive ()
	enableUserCreation ($a_uc)
	isUserCreationEnabled ()
	enableLocalAuthentication ($a_local)
	isLocalAuthenticationEnabled ()
	setDefaultRole ($a_role)
	getDefaultRole ()
	save ()

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

Data Fields
const	SYNC_DISABLED = 0
const	SYNC_CAS = 1
const	SYNC_LDAP = 2

Protected Member Functions
	__construct ()
	Singleton constructor. More...

Private Member Functions
	read ()
	getStorage ()

Private Attributes
ilSetting	$storage
string	$server = ''
int	$port = 0
string	$uri = ''
string	$login_instructions = ''
bool	$active = false
bool	$create_users = false
bool	$allow_local = false
int	$user_default_role = 0
int	$default_role = 0

Static Private Attributes
static ilCASSettings	$instance = null

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCASSettings::__construct ( )

protected

Singleton constructor.

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

References $DIC, and read().

    {
        global $DIC;

        $this->storage = $DIC->settings();
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

enableLocalAuthentication()

ilCASSettings::enableLocalAuthentication

(

$a_local

)

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

Referenced by read().

                                                       : void
    {
        $this->allow_local = $a_local;
    }

Here is the caller graph for this function:

enableUserCreation()

ilCASSettings::enableUserCreation

(

$a_uc

)

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

Referenced by read().

                                             : void
    {
        $this->create_users = $a_uc;
    }

Here is the caller graph for this function:

getDefaultRole()

ilCASSettings::getDefaultRole

(

)

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

References $default_role.

Referenced by save().

                                    : int
    {
        return $this->default_role;
    }

Here is the caller graph for this function:

getInstance()

static ilCASSettings::getInstance ( )

static

Get singleton instance.

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

Referenced by ilAuthProviderCAS\__construct(), ilCASSettingsGUI\__construct(), and ilCASSettingsTest\setGlobalVariable().

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

Here is the caller graph for this function:

getLoginInstruction()

ilCASSettings::getLoginInstruction

(

)

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

References $login_instructions.

Referenced by save().

                                         : string
    {
        return $this->login_instructions;
    }

Here is the caller graph for this function:

getPort()

ilCASSettings::getPort

(

)

Definition at line 78 of file class.ilCASSettings.php.

References $port.

Referenced by save().

                             : int
    {
        return $this->port;
    }

Here is the caller graph for this function:

getServer()

ilCASSettings::getServer

(

)

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

References $server.

Referenced by save().

                               : string
    {
        return $this->server;
    }

Here is the caller graph for this function:

getStorage()

ilCASSettings::getStorage ( )

private

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

References $storage.

Referenced by read(), and save().

                                 : ilSetting
    {
        return $this->storage;
    }

Here is the caller graph for this function:

getUri()

ilCASSettings::getUri

(

)

Definition at line 88 of file class.ilCASSettings.php.

References $uri.

Referenced by save().

                            : string
    {
        return $this->uri;
    }

Here is the caller graph for this function:

isActive()

ilCASSettings::isActive

(

)

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

References $active.

Referenced by save().

                              : bool
    {
        return $this->active;
    }

Here is the caller graph for this function:

isLocalAuthenticationEnabled()

ilCASSettings::isLocalAuthenticationEnabled

(

)

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

References $allow_local.

Referenced by save().

                                                  : bool
    {
        return $this->allow_local;
    }

Here is the caller graph for this function:

isUserCreationEnabled()

ilCASSettings::isUserCreationEnabled

(

)

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

References $create_users.

Referenced by save().

                                           : bool
    {
        return $this->create_users;
    }

Here is the caller graph for this function:

read()

ilCASSettings::read ( )

private

Definition at line 155 of file class.ilCASSettings.php.

References enableLocalAuthentication(), enableUserCreation(), getStorage(), ILIAS\UI\examples\Progress\Bar\server(), setActive(), setDefaultRole(), setLoginInstruction(), setPort(), setServer(), and setUri().

Referenced by __construct().

                           : void
    {
        $this->setServer($this->getStorage()->get('cas_server', $this->server));
        $this->setPort((int) $this->getStorage()->get('cas_port', (string) $this->port));
        $this->setUri($this->getStorage()->get('cas_uri', $this->uri));
        $this->setActive((bool) $this->getStorage()->get('cas_active', (string) $this->active));
        $this->setDefaultRole((int) $this->getStorage()->get('cas_user_default_role', (string) $this->user_default_role));
        $this->setLoginInstruction($this->getStorage()->get('cas_login_instructions', $this->login_instructions));
        $this->enableLocalAuthentication((bool) $this->getStorage()->get('cas_allow_local', (string) $this->allow_local));
        $this->enableUserCreation((bool) $this->getStorage()->get('cas_create_users', (string) $this->create_users));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilCASSettings::save

(

)

Definition at line 143 of file class.ilCASSettings.php.

References getDefaultRole(), getLoginInstruction(), getPort(), getServer(), getStorage(), getUri(), isActive(), isLocalAuthenticationEnabled(), and isUserCreationEnabled().

                          : void
    {
        $this->getStorage()->set('cas_server', $this->getServer());
        $this->getStorage()->set('cas_port', (string) $this->getPort());
        $this->getStorage()->set('cas_uri', $this->getUri());
        $this->getStorage()->set('cas_login_instructions', $this->getLoginInstruction());
        $this->getStorage()->set('cas_active', (string) $this->isActive());
        $this->getStorage()->set('cas_create_users', (string) $this->isUserCreationEnabled());
        $this->getStorage()->set('cas_allow_local', (string) $this->isLocalAuthenticationEnabled());
        $this->getStorage()->set('cas_user_default_role', (string) $this->getDefaultRole());
    }

Here is the call graph for this function:

setActive()

ilCASSettings::setActive

(

$a_active

)

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

Referenced by read().

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

Here is the caller graph for this function:

setDefaultRole()

ilCASSettings::setDefaultRole

(

$a_role

)

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

Referenced by read().

                                           : void
    {
        $this->default_role = $a_role;
    }

Here is the caller graph for this function:

setLoginInstruction()

ilCASSettings::setLoginInstruction

(

string

$a_inst

)

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

Referenced by read().

                                                       : void
    {
        $this->login_instructions = $a_inst;
    }

Here is the caller graph for this function:

setPort()

ilCASSettings::setPort

(

int

$a_port

)

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

Referenced by read().

                                        : void
    {
        $this->port = $a_port;
    }

Here is the caller graph for this function:

setServer()

ilCASSettings::setServer

(

string

$a_server

)

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

References ILIAS\UI\examples\Progress\Bar\server().

Referenced by read().

                                               : void
    {
        $this->server = $a_server;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUri()

ilCASSettings::setUri

(

string

$a_uri

)

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

Referenced by read().

                                         : void
    {
        $this->uri = $a_uri;
    }

Here is the caller graph for this function:

Field Documentation

$active

bool ilCASSettings::$active = false

private

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

Referenced by isActive().

$allow_local

bool ilCASSettings::$allow_local = false

private

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

Referenced by isLocalAuthenticationEnabled().

$create_users

bool ilCASSettings::$create_users = false

private

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

Referenced by isUserCreationEnabled().

$default_role

int ilCASSettings::$default_role = 0

private

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

Referenced by getDefaultRole().

$instance

ilCASSettings ilCASSettings::$instance = null

staticprivate

Definition at line 28 of file class.ilCASSettings.php.

$login_instructions

string ilCASSettings::$login_instructions = ''

private

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

Referenced by getLoginInstruction().

$port

int ilCASSettings::$port = 0

private

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

Referenced by getPort().

$server

string ilCASSettings::$server = ''

private

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

Referenced by getServer().

$storage

ilSetting ilCASSettings::$storage

private

Definition at line 30 of file class.ilCASSettings.php.

Referenced by getStorage().

$uri

string ilCASSettings::$uri = ''

private

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

Referenced by getUri().

$user_default_role

int ilCASSettings::$user_default_role = 0

private

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

SYNC_CAS

const ilCASSettings::SYNC_CAS = 1

Definition at line 25 of file class.ilCASSettings.php.

Referenced by ilCASSettingsGUI\initFormSettings(), and ilCASSettingsGUI\save().

SYNC_DISABLED

const ilCASSettings::SYNC_DISABLED = 0

Definition at line 24 of file class.ilCASSettings.php.

Referenced by ilCASSettingsGUI\initFormSettings(), and ilCASSettingsGUI\save().

SYNC_LDAP

const ilCASSettings::SYNC_LDAP = 2

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

Referenced by ilCASSettingsGUI\initFormSettings(), and ilCASSettingsGUI\save().

---

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

• components/ILIAS/CAS/classes/class.ilCASSettings.php