ShibAuth Class Reference

Inheritance diagram for ShibAuth:

Collaboration diagram for ShibAuth:

Public Member Functions
	supportsRedirects ()
	login ()
	Login function. More...
	setAuth ($username, ilObjUser $userObj=NULL)
	logout ()

Detailed Description

Definition at line 42 of file class.ilShibboleth.php.

Member Function Documentation

login()

ShibAuth::login

(

)

Login function.

private

Returns

void

Definition at line 78 of file class.ilShibboleth.php.

References $_GET, $_SERVER, $DIC, $ilSetting, ilObjUser\_updateLastLogin(), shibUser\buildInstance(), ilShibbolethRoleAssignmentRules\doAssignments(), shibServerData\getInstance(), ilShibbolethPluginWrapper\getInstance(), ilUtil\redirect(), setAuth(), and ilShibbolethRoleAssignmentRules\updateAssignments().

                                {
                global $DIC; // for backword compatibility of hook environment variables
                $ilias = $DIC['ilias'];
                $ilSetting = $DIC['ilSetting'];
                $shibServerData = shibServerData::getInstance();
                if ($shibServerData->getLogin()) {
                        $shibUser = shibUser::buildInstance($shibServerData);
                        // for backword compatibility of hook environment variables
                        $userObj =& $shibUser; // For shib_data_conv included Script
                        $newUser = $shibUser->isNew(); // For shib_data_conv included Script
                        if ($shibUser->isNew()) {
                                $shibUser->createFields();
                                $shibUser->setPref('hits_per_page', $ilSetting->get('hits_per_page'));

                                // Modify user data before creating the user
                                // Include custom code that can be used to further modify
                                // certain Shibboleth user attributes
                                if ($ilias->getSetting('shib_data_conv') AND $ilias->getSetting('shib_data_conv') != ''
                                        AND is_readable($ilias->getSetting('shib_data_conv'))
                                ) {
                                        include($ilias->getSetting('shib_data_conv'));
                                }
                                $shibUser = ilShibbolethPluginWrapper::getInstance()->beforeCreateUser($shibUser);
                                $shibUser->create();
                                $shibUser->updateOwner();
                                $shibUser->saveAsNew();
                                $shibUser->writePrefs();
                                $shibUser = ilShibbolethPluginWrapper::getInstance()->afterCreateUser($shibUser);
                                ilShibbolethRoleAssignmentRules::doAssignments($shibUser->getId(), $_SERVER);
                        } else {
                                $shibUser->updateFields();
                                // Include custom code that can be used to further modify
                                // certain Shibboleth user attributes
                                if ($ilias->getSetting('shib_data_conv') AND $ilias->getSetting('shib_data_conv') != ''
                                        AND is_readable($ilias->getSetting('shib_data_conv'))
                                ) {
                                        include($ilias->getSetting('shib_data_conv'));
                                }
                                //                              $shibUser->update();
                                $shibUser = ilShibbolethPluginWrapper::getInstance()->beforeUpdateUser($shibUser);
                                $shibUser->update();
                                $shibUser = ilShibbolethPluginWrapper::getInstance()->afterUpdateUser($shibUser);
                                ilShibbolethRoleAssignmentRules::updateAssignments($shibUser->getId(), $_SERVER);
                        }
                        $this->setAuth($shibUser->getLogin(), $shibUser);
                        ilObjUser::_updateLastLogin($shibUser->getId());
                        if ($_GET['target'] != '') {
                                ilUtil::redirect('goto.php?target=' . $_GET['target'] . '&client_id=' . CLIENT_ID);
                        }
                } else {
                        $this->status = AUTH_WRONG_LOGIN;
                }
        }

Here is the call graph for this function:

logout()

ShibAuth::logout

(

)

Definition at line 148 of file class.ilShibboleth.php.

References $DIC, $ilUser, and ilShibbolethPluginWrapper\getInstance().

                                 {
                global $DIC;
                $ilUser = $DIC['ilUser'];
                ilShibbolethPluginWrapper::getInstance()->beforeLogout($ilUser);
                parent::logout();
                ilShibbolethPluginWrapper::getInstance()->afterLogout($ilUser);
        }

Here is the call graph for this function:

setAuth()

ShibAuth::setAuth	(		$username,
		ilObjUser	$userObj = NULL
	)

Parameters

	$username
ilObjUser	$userObj

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

References ilShibbolethPluginWrapper\getInstance().

Referenced by login().

                                                                      {
                if ($userObj) {
                        ilShibbolethPluginWrapper::getInstance()->beforeLogin($userObj);
                }
                parent::setAuth($username);
                if ($userObj) {
                        ilShibbolethPluginWrapper::getInstance()->afterLogin($userObj);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

supportsRedirects()

ShibAuth::supportsRedirects

(

)

Parameters

	$authParams
bool	$updateUserData

Definition at line 67 of file class.ilShibboleth.php.

                                            {
                return true;
        }

---

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

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