ilShibbolethPluginWrapper Class Reference

Class ilShibbolethPluginWrapper. More...

Inheritance diagram for ilShibbolethPluginWrapper:

Collaboration diagram for ilShibbolethPluginWrapper:

Public Member Functions
	beforeLogin (ilObjUser $user)
	afterLogin (ilObjUser $user)
	beforeCreateUser (ilObjUser $user)
	afterCreateUser (ilObjUser $user)
	beforeLogout (ilObjUser $user)
	afterLogout (ilObjUser $user)
	beforeUpdateUser (ilObjUser $user)
	afterUpdateUser (ilObjUser $user)

Static Public Member Functions
static	getInstance ()

Protected Member Functions
	__construct ()
	getPluginObjects ()

Protected Attributes
	$plugin_admin
	$log

Static Protected Attributes
static	$active_plugins = array()
static	$cache = NULL

Detailed Description

Class ilShibbolethPluginWrapper.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 9 of file class.ilShibbolethPluginWrapper.php.

Constructor & Destructor Documentation

__construct()

ilShibbolethPluginWrapper::__construct ( )

protected

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

References $DIC, $ilLog, and IL_COMP_SERVICE.

                                         {
                global $DIC;
                $ilPluginAdmin = $DIC['ilPluginAdmin'];
                $ilLog = $DIC['ilLog'];
                $this->log = $ilLog;
                $this->plugin_admin = $ilPluginAdmin;
                if (self::$active_plugins == NULL) {
                        self::$active_plugins = $this->plugin_admin->getActivePluginsForSlot(IL_COMP_SERVICE, 'AuthShibboleth', 'shibhk');
                }
        }

Member Function Documentation

afterCreateUser()

ilShibbolethPluginWrapper::afterCreateUser

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 116 of file class.ilShibbolethPluginWrapper.php.

References getPluginObjects().

                                                         {
                foreach ($this->getPluginObjects() as $pl) {
                        $user = $pl->afterCreateUser($user);
                }

                return $user;
        }

Here is the call graph for this function:

afterLogin()

ilShibbolethPluginWrapper::afterLogin

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

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

References getPluginObjects().

                                                    {
                foreach ($this->getPluginObjects() as $pl) {
                        $user = $pl->afterLogin($user);
                }

                return $user;
        }

Here is the call graph for this function:

afterLogout()

ilShibbolethPluginWrapper::afterLogout

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 139 of file class.ilShibbolethPluginWrapper.php.

References getPluginObjects().

                                                     {
                $this->log->write('afterlogout');
                foreach ($this->getPluginObjects() as $pl) {
                        $user = $pl->afterLogout($user);
                }

                return $user;
        }

Here is the call graph for this function:

afterUpdateUser()

ilShibbolethPluginWrapper::afterUpdateUser

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 168 of file class.ilShibbolethPluginWrapper.php.

References getPluginObjects().

                                                         {
                foreach ($this->getPluginObjects() as $pl) {
                        $user = $pl->afterUpdateUser($user);
                }

                return $user;
        }

Here is the call graph for this function:

beforeCreateUser()

ilShibbolethPluginWrapper::beforeCreateUser

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

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

References getPluginObjects().

                                                          {
                foreach ($this->getPluginObjects() as $pl) {
                        $user = $pl->beforeCreateUser($user);
                }

                return $user;
        }

Here is the call graph for this function:

beforeLogin()

ilShibbolethPluginWrapper::beforeLogin

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

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

References getPluginObjects().

                                                     {
                foreach ($this->getPluginObjects() as $pl) {
                        $user = $pl->beforeLogin($user);
                }

                return $user;
        }

Here is the call graph for this function:

beforeLogout()

ilShibbolethPluginWrapper::beforeLogout

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

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

References getPluginObjects().

                                                      {
                foreach ($this->getPluginObjects() as $pl) {
                        $user = $pl->beforeLogout($user);
                }

                return $user;
        }

Here is the call graph for this function:

beforeUpdateUser()

ilShibbolethPluginWrapper::beforeUpdateUser

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilObjUser

Implements ilShibbolethAuthenticationPluginInt.

Definition at line 154 of file class.ilShibbolethPluginWrapper.php.

References getPluginObjects().

                                                          {
                foreach ($this->getPluginObjects() as $pl) {
                        $user = $pl->beforeUpdateUser($user);
                }

                return $user;
        }

Here is the call graph for this function:

getInstance()

static ilShibbolethPluginWrapper::getInstance ( )

static

Returns

ilShibbolethPluginWrapper

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

Referenced by ilAuthProviderShibboleth\doAuthentication(), ShibAuth\login(), ShibAuth\logout(), and ShibAuth\setAuth().

                                             {
                if (! self::$cache instanceof ilShibbolethPluginWrapper) {
                        self::$cache = new self();
                }

                return self::$cache;
        }

Here is the caller graph for this function:

getPluginObjects()

ilShibbolethPluginWrapper::getPluginObjects ( )

protected

Returns

ilShibbolethAuthenticationPlugin[]

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

References array, and IL_COMP_SERVICE.

Referenced by afterCreateUser(), afterLogin(), afterLogout(), afterUpdateUser(), beforeCreateUser(), beforeLogin(), beforeLogout(), and beforeUpdateUser().

                                              {
                $plugin_objs = array();
                foreach (self::$active_plugins as $plugin_name) {
                        $plugin_obj = $this->plugin_admin->getPluginObject(IL_COMP_SERVICE, 'AuthShibboleth', 'shibhk', $plugin_name);
                        if ($plugin_obj instanceof ilShibbolethAuthenticationPlugin) {
                                $plugin_objs[] = $plugin_obj;
                        }
                }

                return $plugin_objs;
        }

Here is the caller graph for this function:

Field Documentation

$active_plugins

ilShibbolethPluginWrapper::$active_plugins = array()

staticprotected

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

$cache

ilShibbolethPluginWrapper::$cache = NULL

staticprotected

Definition at line 26 of file class.ilShibbolethPluginWrapper.php.

$log

ilShibbolethPluginWrapper::$log

protected

Definition at line 18 of file class.ilShibbolethPluginWrapper.php.

$plugin_admin

ilShibbolethPluginWrapper::$plugin_admin

protected

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

---

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

• Services/AuthShibboleth/classes/class.ilShibbolethPluginWrapper.php