ilExternalAuthUserAttributeMapping Class Reference

Class ilExternalAuthUserAttributeMapping. More...

Inheritance diagram for ilExternalAuthUserAttributeMapping:

Collaboration diagram for ilExternalAuthUserAttributeMapping:

Public Member Functions
	__construct ($authMode, $authSourceId=0)
	ilExternalAuthUserAttributeMapping constructor. More...
	getAuthSourceId ()
	setAuthSourceId ($authSourceId)
	getAuthMode ()
	setAuthMode ($authMode)
	getEmptyRule ()
	offsetExists ($offset)
	{} More...
	offsetGet ($offset)
	{} More...
	offsetSet ($offset, $value)
	{} More...
	offsetUnset ($offset)
	{} More...
	count ()
	current ()
	next ()
	{} More...
	key ()
	{} More...
	valid ()
	{} More...
	rewind ()
	save ()
	delete ()

Protected Member Functions
	read ()

Protected Attributes
	$db
	$authMode = ''
	$authSourceId
	$mapping = array()

Detailed Description

Class ilExternalAuthUserAttributeMapping.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 10 of file class.ilExternalAuthUserAttributeMapping.php.

Constructor & Destructor Documentation

__construct()

ilExternalAuthUserAttributeMapping::__construct	(		$authMode,
			$authSourceId = 0
	)

ilExternalAuthUserAttributeMapping constructor.

Parameters

string	$authMode
int	$authSourceId

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

References $authMode, $authSourceId, $GLOBALS, read(), setAuthMode(), and setAuthSourceId().

    {
        assert(is_string($authMode));
        assert(is_numeric($authSourceId));

        $this->db = $GLOBALS['DIC']->database();

        $this->setAuthMode($authMode);
        $this->setAuthSourceId($authSourceId);

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

count()

ilExternalAuthUserAttributeMapping::count

(

)

Returns

int

Definition at line 129 of file class.ilExternalAuthUserAttributeMapping.php.

    {
        return count($this->mapping);
    }

current()

ilExternalAuthUserAttributeMapping::current

(

)

Returns

ilExternalAuthUserAttributeMappingRule

Definition at line 137 of file class.ilExternalAuthUserAttributeMapping.php.

Referenced by valid().

    {
        return current($this->mapping);
    }

Here is the caller graph for this function:

delete()

ilExternalAuthUserAttributeMapping::delete

(

)

Definition at line 217 of file class.ilExternalAuthUserAttributeMapping.php.

References array, getAuthMode(), and getAuthSourceId().

    {
        $this->mapping = array();
        $this->db->manipulateF(
            'DELETE FROM auth_ext_attr_mapping WHERE auth_mode = %s AND auth_src_id = %s',
            array('text', 'integer'),
            array($this->getAuthMode(), $this->getAuthSourceId())
        );
    }

Here is the call graph for this function:

getAuthMode()

ilExternalAuthUserAttributeMapping::getAuthMode

(

)

Returns

string

Definition at line 69 of file class.ilExternalAuthUserAttributeMapping.php.

References $authMode.

Referenced by delete(), read(), and save().

    {
        return $this->authMode;
    }

Here is the caller graph for this function:

getAuthSourceId()

ilExternalAuthUserAttributeMapping::getAuthSourceId

(

)

Returns

int

Definition at line 53 of file class.ilExternalAuthUserAttributeMapping.php.

References $authSourceId.

Referenced by delete(), read(), and save().

    {
        return $this->authSourceId;
    }

Here is the caller graph for this function:

getEmptyRule()

ilExternalAuthUserAttributeMapping::getEmptyRule

(

)

Returns

ilExternalAuthUserAttributeMappingRule

Definition at line 85 of file class.ilExternalAuthUserAttributeMapping.php.

Referenced by read().

    {
        return new ilExternalAuthUserAttributeMappingRule();
    }

Here is the caller graph for this function:

key()

ilExternalAuthUserAttributeMapping::key

(

)

{}

Definition at line 153 of file class.ilExternalAuthUserAttributeMapping.php.

    {
        return key($this->mapping);
    }

next()

ilExternalAuthUserAttributeMapping::next

(

)

{}

Definition at line 145 of file class.ilExternalAuthUserAttributeMapping.php.

    {
        next($this->mapping);
    }

offsetExists()

ilExternalAuthUserAttributeMapping::offsetExists

(

$offset

)

{}

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

Referenced by offsetGet().

    {
        return isset($this->mapping[$offset]);
    }

Here is the caller graph for this function:

offsetGet()

ilExternalAuthUserAttributeMapping::offsetGet

(

$offset

)

{}

Definition at line 101 of file class.ilExternalAuthUserAttributeMapping.php.

References offsetExists().

    {
        return $this->offsetExists($offset) ? $this->mapping[$offset] : null;
    }

Here is the call graph for this function:

offsetSet()

ilExternalAuthUserAttributeMapping::offsetSet	(		$offset,
			$value
	)

{}

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

    {
        if (is_null($offset)) {
            $this->mapping[] = $value;
        } else {
            $this->mapping[$offset] = $value;
        }
    }

offsetUnset()

ilExternalAuthUserAttributeMapping::offsetUnset

(

$offset

)

{}

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

    {
        unset($this->mapping[$offset]);
    }

read()

ilExternalAuthUserAttributeMapping::read ( )

protected

Definition at line 174 of file class.ilExternalAuthUserAttributeMapping.php.

References $res, $row, $rule, array, getAuthMode(), getAuthSourceId(), and getEmptyRule().

Referenced by __construct().

    {
        $this->mapping = array();

        $res = $this->db->queryF(
            'SELECT * FROM auth_ext_attr_mapping WHERE auth_mode = %s AND auth_src_id = %s',
            array('text', 'integer'),
            array($this->getAuthMode(), $this->getAuthSourceId())
        );
        while ($row = $this->db->fetchAssoc($res)) {
            $rule = $this->getEmptyRule();
            $rule->setAttribute($row['attribute']);
            $rule->setExternalAttribute($row['ext_attribute']);
            $rule->updateAutomatically((bool) $row['update_automatically']);

            $this->mapping[$rule->getAttribute()] = $rule;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

rewind()

ilExternalAuthUserAttributeMapping::rewind

(

)

Definition at line 166 of file class.ilExternalAuthUserAttributeMapping.php.

    {
        reset($this->mapping);
    }

save()

ilExternalAuthUserAttributeMapping::save

(

)

Definition at line 196 of file class.ilExternalAuthUserAttributeMapping.php.

References $rule, array, getAuthMode(), and getAuthSourceId().

    {
        foreach ($this->mapping as $rule) {
            $this->db->replace(
                'auth_ext_attr_mapping',
                array(
                    'auth_mode'   => array('text', $this->getAuthMode()),
                    'auth_src_id' => array('integer', $this->getAuthSourceId()),
                    'attribute'   => array('text', $rule->getAttribute())
                ),
                array(
                    'ext_attribute'        => array('text', $rule->getExternalAttribute()),
                    'update_automatically' => array('integer', (int) $rule->isAutomaticallyUpdated())
                )
            );
        }
    }

Here is the call graph for this function:

setAuthMode()

ilExternalAuthUserAttributeMapping::setAuthMode

(

$authMode

)

Parameters

string

$authMode

Definition at line 77 of file class.ilExternalAuthUserAttributeMapping.php.

References $authMode.

Referenced by __construct().

    {
        $this->authMode = $authMode;
    }

Here is the caller graph for this function:

setAuthSourceId()

ilExternalAuthUserAttributeMapping::setAuthSourceId

(

$authSourceId

)

Parameters

int

$authSourceId

Definition at line 61 of file class.ilExternalAuthUserAttributeMapping.php.

References $authSourceId.

Referenced by __construct().

    {
        $this->authSourceId = $authSourceId;
    }

Here is the caller graph for this function:

valid()

ilExternalAuthUserAttributeMapping::valid

(

)

{}

Definition at line 161 of file class.ilExternalAuthUserAttributeMapping.php.

References current().

    {
        return current($this->mapping);
    }

Here is the call graph for this function:

Field Documentation

$authMode

ilExternalAuthUserAttributeMapping::$authMode = ''

protected

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

Referenced by __construct(), getAuthMode(), and setAuthMode().

$authSourceId

ilExternalAuthUserAttributeMapping::$authSourceId

protected

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

Referenced by __construct(), getAuthSourceId(), and setAuthSourceId().

$db

ilExternalAuthUserAttributeMapping::$db

protected

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

$mapping

ilExternalAuthUserAttributeMapping::$mapping = array()

protected

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

---

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

• Services/Authentication/classes/External/UserAttributeMapping/class.ilExternalAuthUserAttributeMapping.php