ilOpenIdProviders Class Reference

@classDescription OpenId provider More...

Collaboration diagram for ilOpenIdProviders:

Public Member Functions
	getProvider ()
	Get enabled provider. More...
	getProviderById ($a_provider_id)
	Get provider by id. More...
	getProviderSelection ()
	get html select options More...
	getSelectedProvider ()
	Return the default provider, if there is only one. More...

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

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

Private Member Functions
	read ()
	Read providers. More...

Private Attributes
	$providers = array()

Static Private Attributes
static	$instance = null

Detailed Description

@classDescription OpenId provider

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilOpenIdProviders::__construct ( )

protected

Singleton constructor.

Returns

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

        {
                $this->read();
        }

References read().

Here is the call graph for this function:

Member Function Documentation

getInstance()

static ilOpenIdProviders::getInstance ( )

static

Get singleton instance.

Returns

object ilOpenIdProviders

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

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

References $instance.

Referenced by ilOpenIdProviderTableGUI\parse(), ilAuthOpenId\parseUsername(), and ilStartUpGUI\showOpenIdLoginForm().

Here is the caller graph for this function:

getProvider()

ilOpenIdProviders::getProvider

(

)

Get enabled provider.

Returns

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

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

References $providers.

Referenced by getProviderById(), getProviderSelection(), and getSelectedProvider().

Here is the caller graph for this function:

getProviderById()

ilOpenIdProviders::getProviderById

(

$a_provider_id

)

Get provider by id.

Parameters

object

$a_provider_id

Returns

object ilOpenIdProvider

Exceptions

UnexpectedValueException

Definition at line 56 of file class.ilOpenIdProviders.php.

        {
                foreach($this->getProvider() as $provider)
                {
                        if($provider->getId() == $a_provider_id)
                        {
                                return $provider;
                        }
                }
                throw new UnexpectedValueException();
        }

References League\OAuth2\Client\Provider\$provider, and getProvider().

Here is the call graph for this function:

getProviderSelection()

ilOpenIdProviders::getProviderSelection

(

)

get html select options

Returns

array $options

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

        {
                global $lng;
                
                $options[0] = $lng->txt('select_one');
                foreach($this->getProvider() as $provider)
                {
                        $options[$provider->getId()] = $provider->getName();
                }
                return $options;
        }

References $lng, $options, League\OAuth2\Client\Provider\$provider, and getProvider().

Here is the call graph for this function:

getSelectedProvider()

ilOpenIdProviders::getSelectedProvider

(

)

Return the default provider, if there is only one.

Otherwise return "0" for –select one –

Returns

int

Definition at line 90 of file class.ilOpenIdProviders.php.

        {
                include_once './Services/OpenId/classes/class.ilOpenIdSettings.php';
                if(count($this->getProvider()) != 1 or !ilOpenIdSettings::getInstance()->forcedProviderSelection())
                {
                        return 0;
                }
 
                foreach($this->getProvider() as $pro)
                {
                        return $pro->getId();
                }
                return 0;
        }

References ilOpenIdSettings\getInstance(), and getProvider().

Here is the call graph for this function:

read()

ilOpenIdProviders::read ( )

private

Read providers.

Returns

Definition at line 109 of file class.ilOpenIdProviders.php.

        {
                global $ilDB;
                
                $query = "SELECT provider_id FROM openid_provider ORDER BY name ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $this->providers[] = new ilOpenIdProvider($row['provider_id']);
                }
                return true;
        }

References $ilDB, $query, $res, $row, and DB_FETCHMODE_ASSOC.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$instance

ilOpenIdProviders::$instance = null

staticprivate

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

Referenced by getInstance().

$providers

ilOpenIdProviders::$providers = array()

private

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

Referenced by getProvider().

---

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

• Services/OpenId/classes/class.ilOpenIdProviders.php