This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilExternalAuthUserAttributeMapping:

Collaboration diagram for ilExternalAuthUserAttributeMapping:

Public Member Functions
	__construct (string $authMode, int $authSourceId=0)

	getAuthSourceId ()

	setAuthSourceId (int $authSourceId)

	getAuthMode ()

	setAuthMode (string $authMode)

	getEmptyRule ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	count ()

	current ()

	next ()

	key ()

	valid ()

	rewind ()

	save ()

	delete ()

Protected Member Functions
	read ()

Protected Attributes
ilDBInterface	$db

string	$authMode

int	$authSourceId

array	$mapping = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilExternalAuthUserAttributeMapping

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

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

Constructor & Destructor Documentation

◆ __construct()

ilExternalAuthUserAttributeMapping::__construct	(	string	$authMode,
		int	$authSourceId = `0`
	)

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

References $DIC, read(), setAuthMode(), and setAuthSourceId().

     {
         global $DIC;
         $this->db = $DIC->database();
 
         $this->setAuthMode($authMode);
         $this->setAuthSourceId($authSourceId);
 
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ count()

ilExternalAuthUserAttributeMapping::count ( )

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

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

◆ current()

ilExternalAuthUserAttributeMapping::current ( )

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

Referenced by valid().

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

Here is the caller graph for this function:

◆ delete()

ilExternalAuthUserAttributeMapping::delete ( )

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

References getAuthMode(), and getAuthSourceId().

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

Here is the call graph for this function:

◆ getAuthMode()

ilExternalAuthUserAttributeMapping::getAuthMode ( )

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

References $authMode.

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

                                  : string
     {
         return $this->authMode;
     }

Here is the caller graph for this function:

◆ getAuthSourceId()

ilExternalAuthUserAttributeMapping::getAuthSourceId ( )

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

References $authSourceId.

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

                                      : int
     {
         return $this->authSourceId;
     }

Here is the caller graph for this function:

◆ getEmptyRule()

ilExternalAuthUserAttributeMapping::getEmptyRule ( )

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

Referenced by read().

                                   : ilExternalAuthUserAttributeMappingRule
     {
         return new ilExternalAuthUserAttributeMappingRule();
     }

Here is the caller graph for this function:

◆ key()

ilExternalAuthUserAttributeMapping::key ( )

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

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

◆ next()

ilExternalAuthUserAttributeMapping::next ( )

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

                           : void
     {
         next($this->mapping);
     }

◆ offsetExists()

ilExternalAuthUserAttributeMapping::offsetExists ( $offset )

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

Referenced by offsetGet().

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

Here is the caller graph for this function:

◆ offsetGet()

ilExternalAuthUserAttributeMapping::offsetGet ( $offset )

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

References offsetExists().

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

Here is the call graph for this function:

◆ offsetSet()

ilExternalAuthUserAttributeMapping::offsetSet	(	$offset,
		$value
	)

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

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

◆ offsetUnset()

ilExternalAuthUserAttributeMapping::offsetUnset ( $offset )

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

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

◆ read()

ilExternalAuthUserAttributeMapping::read ( )

protected

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

References $res, getAuthMode(), getAuthSourceId(), and getEmptyRule().

Referenced by __construct().

                              : void
     {
         $this->mapping = [];
 
         $res = $this->db->queryF(
             'SELECT * FROM auth_ext_attr_mapping WHERE auth_mode = %s AND auth_src_id = %s',
             ['text', 'integer'],
             [$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 118 of file class.ilExternalAuthUserAttributeMapping.php.

                             : void
     {
         reset($this->mapping);
     }

◆ save()

ilExternalAuthUserAttributeMapping::save ( )

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

References getAuthMode(), getAuthSourceId(), and ILIAS\Repository\int().

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

Here is the call graph for this function:

◆ setAuthMode()

ilExternalAuthUserAttributeMapping::setAuthMode ( string $authMode )

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

References $authMode.

Referenced by __construct().

                                                  : void
     {
         $this->authMode = $authMode;
     }

Here is the caller graph for this function:

◆ setAuthSourceId()

ilExternalAuthUserAttributeMapping::setAuthSourceId ( int $authSourceId )

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

References $authSourceId.

Referenced by __construct().

                                                       : void
     {
         $this->authSourceId = $authSourceId;
     }

Here is the caller graph for this function:

◆ valid()

ilExternalAuthUserAttributeMapping::valid ( )

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

References current().

                            : bool
     {
         return current($this->mapping) instanceof ilExternalAuthUserAttributeMappingRule;
     }

Here is the call graph for this function:

Field Documentation

◆ $authMode

string ilExternalAuthUserAttributeMapping::$authMode

protected

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

Referenced by getAuthMode(), and setAuthMode().

◆ $authSourceId

int ilExternalAuthUserAttributeMapping::$authSourceId

protected

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

Referenced by getAuthSourceId(), and setAuthSourceId().

◆ $db

ilDBInterface ilExternalAuthUserAttributeMapping::$db

protected

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

◆ $mapping

array ilExternalAuthUserAttributeMapping::$mapping = []

protected

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ count()

◆ current()

◆ delete()

◆ getAuthMode()

◆ getAuthSourceId()

◆ getEmptyRule()

◆ key()

◆ next()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ read()

◆ rewind()

◆ save()

◆ setAuthMode()

◆ setAuthSourceId()

◆ valid()

Field Documentation

◆ $authMode

◆ $authSourceId

◆ $db

◆ $mapping