@classDescription OpenId provider More...

Collaboration diagram for ilOpenIdProvider:

Public Member Functions
	__construct ($a_provider_id=0)
	Constructor. More...

	setId ($a_id)
	Set id. More...

	getId ()
	Get id. More...

	enable ($a_status)
	Set en/disabled. More...

	isEnabled ()
	Check if provider is en/disabled. More...

	setName ($a_name)
	Set name. More...

	getName ()
	Get name. More...

	setURL ($a_url)
	Set URL. More...

	getURL ()
	Get URL. More...

	delete ()
	Delete provider. More...

	add ()
	Add openid provider. More...

	update ()
	Update provider. More...

Protected Member Functions
	read ()
	Read provider data. More...

Private Attributes
	$provider_id = 0

	$name = ''

	$url = 'http://'

	$enabled = true

	$image = 0

Detailed Description

@classDescription OpenId provider

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

Version: $Id$

Definition at line 11 of file class.ilOpenIdProvider.php.

Constructor & Destructor Documentation

◆ __construct()

ilOpenIdProvider::__construct ( $a_provider_id = 0 )

Constructor.

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

        {
                if($a_provider_id)
                {
                        $this->setId($a_provider_id);
                        $this->read();
                }
        }

References read(), and setId().

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilOpenIdProvider::add ( )

Add openid provider.

Returns

Definition at line 125 of file class.ilOpenIdProvider.php.

        {
                global $ilDB;
                
                $this->setId($ilDB->nextId('openid_provider'));
                $query = "INSERT INTO openid_provider ".
                        "(provider_id, enabled, name, url) ".
                        "VALUES ( ".
                        $ilDB->quote($this->getId(),'integer').', '.
                        $ilDB->quote($this->isEnabled(),'integer').', '.
                        $ilDB->quote($this->getName(),'text').', '.
                        $ilDB->quote($this->getURL(),'text').
                        ')';
                $ilDB->query($query);
                return true;
        }

References $ilDB, $query, getId(), getName(), getURL(), isEnabled(), and setId().

Here is the call graph for this function:

◆ delete()

ilOpenIdProvider::delete ( )

Delete provider.

Returns

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

        {
                global $ilDB;
                
                $query = "DELETE FROM openid_provider ".
                        "WHERE provider_id = ".$ilDB->quote($this->getId(),'integer');
                $ilDB->query($query);
                return true;
        }

References $ilDB, $query, and getId().

Here is the call graph for this function:

◆ enable()

ilOpenIdProvider::enable ( $a_status )

Set en/disabled.

Parameters

bool $a_status

Returns

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

        {
                $this->enabled = (bool) $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

◆ getId()

ilOpenIdProvider::getId ( )

Get id.

Returns

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

        {
                return $this->provider_id;
        }

References $provider_id.

Referenced by add(), delete(), read(), and update().

Here is the caller graph for this function:

◆ getName()

ilOpenIdProvider::getName ( )

Get name.

Returns

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

        {
                return $this->name;
        }

References $name.

Referenced by add(), and update().

Here is the caller graph for this function:

◆ getURL()

ilOpenIdProvider::getURL ( )

Get URL.

Returns

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

        {
                return $this->url;
        }

References $url.

Referenced by add(), and update().

Here is the caller graph for this function:

◆ isEnabled()

ilOpenIdProvider::isEnabled ( )

Check if provider is en/disabled.

Returns

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

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

References $enabled.

Referenced by add(), and update().

Here is the caller graph for this function:

◆ read()

ilOpenIdProvider::read ( )

protected

Read provider data.

Returns

Definition at line 164 of file class.ilOpenIdProvider.php.

        {
                global $ilDB;
                
                $query = "SELECT * FROM openid_provider ".
                        "WHERE provider_id = ".$ilDB->quote($this->getId(),'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $this->setName($row['name']);
                        $this->enable($row['enabled']);
                        $this->setURL($row['url']);
                        return true;
                }
                return false;
        }

References $ilDB, $query, $res, $row, DB_FETCHMODE_ASSOC, enable(), getId(), setName(), and setURL().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setId()

ilOpenIdProvider::setId ( $a_id )

Set id.

Parameters

int $a_id

Returns

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

        {
                $this->provider_id = $a_id;
        }

Referenced by __construct(), and add().

Here is the caller graph for this function:

◆ setName()

ilOpenIdProvider::setName ( $a_name )

Set name.

Parameters

string $a_name

Returns

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

        {
                $this->name = $a_name;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setURL()

ilOpenIdProvider::setURL ( $a_url )

Set URL.

Parameters

string $a_url

Returns

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

        {
                $this->url = $a_url;
        }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilOpenIdProvider::update ( )

Update provider.

Returns

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

        {
                global $ilDB;
                
                $query = 'UPDATE openid_provider SET '.
                        "enabled = ".$ilDB->quote($this->isEnabled(),'integer').', '.
                        "name = ".$ilDB->quote($this->getName(),'text').', '.
                        "url = ".$ilDB->quote($this->getURL(),'text')." ".
                        "WHERE provider_id = ".$ilDB->quote($this->getId(),'integer');
                $ilDB->query($query);
                return true;
        }

References $ilDB, $query, getId(), getName(), getURL(), and isEnabled().

Here is the call graph for this function:

Field Documentation

◆ $enabled

ilOpenIdProvider::$enabled = true

private

Definition at line 16 of file class.ilOpenIdProvider.php.

Referenced by isEnabled().

◆ $image

ilOpenIdProvider::$image = 0

private

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

◆ $name

ilOpenIdProvider::$name = ''

private

Definition at line 14 of file class.ilOpenIdProvider.php.

Referenced by getName().

◆ $provider_id

ilOpenIdProvider::$provider_id = 0

private

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

Referenced by getId().

◆ $url

ilOpenIdProvider::$url = 'http://'

private

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

Referenced by getURL().

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

Services/OpenId/classes/class.ilOpenIdProvider.php

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ delete()

◆ enable()

◆ getId()

◆ getName()

◆ getURL()

◆ isEnabled()

◆ read()

◆ setId()

◆ setName()

◆ setURL()

◆ update()

Field Documentation

◆ $enabled

◆ $image

◆ $name

◆ $provider_id

◆ $url