ExternalAuthentication Class Reference

Public Member Functions
	ExternalAuthentication ($extAuthType, $authOptionList, $formFieldList=array('username'=> 'login', 'password'=> 'password'))
	setAuthSourceName ($authSourceName)
	isAuth ()
	recordUserData ($extAuthAttribNameList, $extAuthAttribTreatmentList, $uid=false)
	getUid ()
Data Fields
	$auth

---

Detailed Description

This class is mainly a bridge between the claroline system and the PEAR Auth library. It allows to use external authentication system for claroline login process

Author:

Hugues Peeters <peeters@ipm.ucl.ac.be>

Deprecated:

since Claroline 1.9, use AuthManager and AuthDriver instead

Definition at line 23 of file extauth.lib.php.

---

Member Function Documentation

ExternalAuthentication	(	$	extAuthType,
		$	authOptionList,
		$	formFieldList = array('username' => 'login',                                                           'password' => 'password')
	)

constructor.

Author:

Hugues Peeters <peeters@ipm.ucl.ac.be>

Parameters:

	string	$extAuthType
	string	$authOptionList

Definition at line 34 of file extauth.lib.php.

getUid

(

)

get the current uid of the logged usser

Author:

Hugues Peeters <peeters@ipm.ucl.ac.be>

Returns:

int

Definition at line 194 of file extauth.lib.php.

isAuth

(

)

check if user is authenticated

Author:

Hugues Peeters <peeters@ipm.ucl.ac.be>

Returns:

Definition at line 76 of file extauth.lib.php.

recordUserData	(	$	extAuthAttribNameList,
		$	extAuthAttribTreatmentList,
		$	uid = false
	)

record user data into the claroline system

Author:

Hugues Peeters <peeters@ipm.ucl.ac.be>

Parameters:

	array	$extAuthAttribNameList - list that make correspondance between claroline attribute names and the external authentication system attribute name
	array	$extAttribTreatmentList list of preliminary treatment before submitting the attribute values to the claroline system. Each claroline attributes destination can have its own preliminary treatment
	int	$uid (optional) user id if the user is already registered to claroline

Returns:

Definition at line 96 of file extauth.lib.php.

setAuthSourceName

(

$

authSourceName

)

Definition at line 63 of file extauth.lib.php.

---

Field Documentation

$auth

Definition at line 25 of file extauth.lib.php.

---

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

• claroline/claroline/inc/lib/extauth.lib.php