Stores OpenId related settings More...

Collaboration diagram for ilOpenIdSettings:

Public Member Functions
	isActive ()
	Is open id auth active. More...

	setActive ($a_status)
	Set open id active. More...

	forcedProviderSelection ()
	is provider selection forced More...

	forceProviderSelection ($a_status)
	Set force selection status. More...

	isCreationEnabled ()
	Is account creation enabled. More...

	enableCreation ($a_status)
	Enable account creation. More...

	isAccountMigrationEnabled ()
	Is account migration enabled. More...

	enableAccountMigration ($a_status)
	Enable account migration. More...

	getDefaultRole ()
	Get default role. More...

	setDefaultRole ($a_role)
	Set default role. More...

	update ()
	Update settings. More...

	getConsumer ()
	Get open id consumer. More...

	getReturnLocation ()
	Get oid return location. More...

	initConsumer ()

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

Protected Member Functions
	read ()
	Read settings from db. More...

	initTempDir ()
	Init Temp directory. More...

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

Private Attributes
	$storage = null

	$active = false

	$account_migration = false

	$default_role = 0

	$creation = false

	$forced_selection = false

	$consumer = null

Static Private Attributes
static	$instance = null

Detailed Description

Stores OpenId related settings

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilOpenIdSettings::__construct ( )

private

Singleton constructor.

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

References read().

         {
                 $this->storage = new ilSetting('auth_openid');
                 $this->read();
         }

Here is the call graph for this function:

Member Function Documentation

◆ enableAccountMigration()

ilOpenIdSettings::enableAccountMigration ( $a_status )

Enable account migration.

Parameters

bool $a_status

Returns

Definition at line 121 of file class.ilOpenIdSettings.php.

Referenced by read().

         {
                 $this->account_migration = $a_status;
         }

Here is the caller graph for this function:

◆ enableCreation()

ilOpenIdSettings::enableCreation ( $a_status )

Enable account creation.

Parameters

bool $a_status

Returns

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

Referenced by read().

         {
                 $this->creation = $a_status;
         }

Here is the caller graph for this function:

◆ forcedProviderSelection()

ilOpenIdSettings::forcedProviderSelection ( )

is provider selection forced

Returns

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

References $forced_selection.

Referenced by update().

         {
                 return $this->forced_selection;
         }

Here is the caller graph for this function:

◆ forceProviderSelection()

ilOpenIdSettings::forceProviderSelection ( $a_status )

Set force selection status.

Parameters

bool $a_status

Returns

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

Referenced by read().

         {
                 $this->forced_selection = $a_status;
         }

Here is the caller graph for this function:

◆ getConsumer()

ilOpenIdSettings::getConsumer ( )

Get open id consumer.

Returns

Definition at line 175 of file class.ilOpenIdSettings.php.

References $consumer.

         {
                 return $this->consumer;
         }

◆ getDefaultRole()

ilOpenIdSettings::getDefaultRole ( )

Get default role.

Returns

Definition at line 130 of file class.ilOpenIdSettings.php.

References $default_role.

Referenced by update().

         {
                 return $this->default_role;
         }

Here is the caller graph for this function:

◆ getInstance()

static ilOpenIdSettings::getInstance ( )

static

Get singleton instance.

Returns: object ilOpenIdSettings

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

Referenced by ilOpenIdAttributeToUser\__construct(), ilOpenIdSettingsGUI\__construct(), ilAuthUtils\_getActiveAuthModes(), ilAuthUtils\_isExternalAccountEnabled(), ilOpenIdProviders\getSelectedProvider(), ilAuthOpenId\initSettings(), ilAuthContainerOpenId\initSettings(), and ilStartUpGUI\showOpenIdLoginForm().

         {
                 if(self::$instance != null)
                 {
                         return self::$instance;
                 }
                 return self::$instance = new ilOpenIdSettings();
         }

Here is the caller graph for this function:

◆ getReturnLocation()

ilOpenIdSettings::getReturnLocation ( )

Get oid return location.

Returns

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

References $ilCtrl.

         {
                 global $ilCtrl;
 
                 $ilCtrl->setTargetScript('ilias.php');
                 $ilCtrl->setParameterByClass('ilstartupgui','oid_check_status',1);
                 $redir = ILIAS_HTTP_PATH.'/';
                 $redir .= $ilCtrl->getLinkTargetByClass('ilstartupgui','showLogin','',false,false);
                 return $redir;
         }

◆ initConsumer()

ilOpenIdSettings::initConsumer ( )

Definition at line 208 of file class.ilOpenIdSettings.php.

References ilUtil\getDataDir(), and initTempDir().

         {
                 include_once "Auth/OpenID/Consumer.php";
                 include_once "Auth/OpenID/FileStore.php";
                 include_once 'Auth/OpenID/DumbStore.php';
                 
                 if(is_object($this->consumer))
                 {
                         return true;
                 }
                 
                 $this->initTempDir();
                 $store = new Auth_OpenID_FileStore(ilUtil::getDataDir().DIRECTORY_SEPARATOR.'tmp');
                 return $this->consumer = new Auth_OpenID_Consumer($store);
         }

Here is the call graph for this function:

◆ initTempDir()

ilOpenIdSettings::initTempDir ( )

protected

Init Temp directory.

Returns

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

References ilUtil\getDataDir(), and ilUtil\makeDir().

Referenced by initConsumer().

         {
                 if(!file_exists(ilUtil::getDataDir().DIRECTORY_SEPARATOR.'tmp'))
                 {
                         ilUtil::makeDir(ilUtil::getDataDir().DIRECTORY_SEPARATOR.'tmp');
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAccountMigrationEnabled()

ilOpenIdSettings::isAccountMigrationEnabled ( )

Is account migration enabled.

Returns

Definition at line 111 of file class.ilOpenIdSettings.php.

References $account_migration.

Referenced by update().

         {
                 return (bool) $this->account_migration;
         }

Here is the caller graph for this function:

◆ isActive()

ilOpenIdSettings::isActive ( )

Is open id auth active.

Returns

Definition at line 54 of file class.ilOpenIdSettings.php.

References $active.

Referenced by update().

         {
                 return (bool) $this->active;
         }

Here is the caller graph for this function:

◆ isCreationEnabled()

ilOpenIdSettings::isCreationEnabled ( )

Is account creation enabled.

Returns

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

References $creation.

Referenced by update().

         {
                 return (bool) $this->creation;
         }

Here is the caller graph for this function:

◆ read()

ilOpenIdSettings::read ( )

protected

Read settings from db.

Returns

Definition at line 149 of file class.ilOpenIdSettings.php.

References enableAccountMigration(), enableCreation(), forceProviderSelection(), setActive(), and setDefaultRole().

Referenced by __construct().

         {
                 $this->setActive($this->storage->get('active',false));
                 $this->enableCreation($this->storage->get('creation',false));
                 $this->setDefaultRole($this->storage->get('default_role',0));
                 $this->enableAccountMigration($this->storage->get('account_migration',false));
                 $this->forceProviderSelection($this->storage->get('forced_selection',false));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActive()

ilOpenIdSettings::setActive ( $a_status )

Set open id active.

Parameters

bool $a_status

Returns

Definition at line 64 of file class.ilOpenIdSettings.php.

Referenced by read().

         {
                 $this->active = $a_status;
         }

Here is the caller graph for this function:

◆ setDefaultRole()

ilOpenIdSettings::setDefaultRole ( $a_role )

Set default role.

Parameters

int $a_role

Returns

Definition at line 140 of file class.ilOpenIdSettings.php.

Referenced by read().

         {
                 $this->default_role = $a_role;
         }

Here is the caller graph for this function:

◆ update()

ilOpenIdSettings::update ( )

Update settings.

Returns

Definition at line 162 of file class.ilOpenIdSettings.php.

References forcedProviderSelection(), getDefaultRole(), isAccountMigrationEnabled(), isActive(), and isCreationEnabled().

         {
                 $this->storage->set('active', (int) $this->isActive());
                 $this->storage->set('creation',(int) $this->isCreationEnabled());
                 $this->storage->set('default_role',(int) $this->getDefaultRole());
                 $this->storage->set('account_migration',(int) $this->isAccountMigrationEnabled());
                 $this->storage->set('forced_selection',(int) $this->forcedProviderSelection());
         }

Here is the call graph for this function:

Field Documentation

◆ $account_migration

ilOpenIdSettings::$account_migration = false

private

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

Referenced by isAccountMigrationEnabled().

◆ $active

ilOpenIdSettings::$active = false

private

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

Referenced by isActive().

◆ $consumer

ilOpenIdSettings::$consumer = null

private

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

Referenced by getConsumer().

◆ $creation

ilOpenIdSettings::$creation = false

private

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

Referenced by isCreationEnabled().

◆ $default_role

ilOpenIdSettings::$default_role = 0

private

Definition at line 21 of file class.ilOpenIdSettings.php.

Referenced by getDefaultRole().

◆ $forced_selection

ilOpenIdSettings::$forced_selection = false

private

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

Referenced by forcedProviderSelection().

◆ $instance

ilOpenIdSettings::$instance = null

staticprivate

Definition at line 15 of file class.ilOpenIdSettings.php.

◆ $storage

ilOpenIdSettings::$storage = null

private

Definition at line 17 of file class.ilOpenIdSettings.php.

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

Services/OpenId/classes/class.ilOpenIdSettings.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ enableAccountMigration()

◆ enableCreation()

◆ forcedProviderSelection()

◆ forceProviderSelection()

◆ getConsumer()

◆ getDefaultRole()

◆ getInstance()

◆ getReturnLocation()

◆ initConsumer()

◆ initTempDir()

◆ isAccountMigrationEnabled()

◆ isActive()

◆ isCreationEnabled()

◆ read()

◆ setActive()

◆ setDefaultRole()

◆ update()

Field Documentation

◆ $account_migration

◆ $active

◆ $consumer

◆ $creation

◆ $default_role

◆ $forced_selection

◆ $instance

◆ $storage