SCserdAuthModule Class Reference

Handle authentication of a user to the CSERD realm. More...

Inheritance diagram for SCserdAuthModule:

[legend]

List of all members.

Public Member Functions
	__construct ()
	INSERT BRIEF DESCRIPTION HERE.
	__sleep ()
	INSERT BRIEF DESCRIPTION HERE.
	__wakeup ()
	INSERT BRIEF DESCRIPTION HERE.
	authenticate ($username, $password)
	Attempt to authenticate this module with a CSERD username and password.
	getEmail ()
	INSERT BRIEF DESCRIPTION HERE.
	getFirstName ()
	INSERT BRIEF DESCRIPTION HERE.
	getLastName ()
	INSERT BRIEF DESCRIPTION HERE.
	getPermissions ()
	INSERT BRIEF DESCRIPTION HERE.
	getRole ()
	INSERT BRIEF DESCRIPTION HERE.
	getUID ()
	INSERT BRIEF DESCRIPTION HERE.
Protected Member Functions
	setEmail ($email)
	INSERT BRIEF DESCRIPTION HERE.
	setUID ($uid)
	INSERT BRIEF DESCRIPTION HERE.
	setUserName ($username)
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

Handle authentication of a user to the CSERD realm.

Author:

Joel/Jonathan (jfeiner/jwsm)

Date:

11/29/2007

Definition at line 9 of file SCserdAuthModule.php5.

---

Constructor & Destructor Documentation

SCserdAuthModule::__construct

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SObject.

Definition at line 25 of file SCserdAuthModule.php5.

---

Member Function Documentation

SCserdAuthModule::__sleep

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 191 of file SCserdAuthModule.php5.

SCserdAuthModule::__wakeup

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 202 of file SCserdAuthModule.php5.

SCserdAuthModule::authenticate	(	$	username,
		$	password
	)

Attempt to authenticate this module with a CSERD username and password.

Parameters:

	$username	[string]: A CSERD username to authenticate
	$password	[string]: A CSERD password to authenticate

Returns:

[bool]: True if authentication worked, false if not, null if error

Connect to the CSERD database, verify the user, and then set the attributes of this object from the (first) matching user record that is found.

Definition at line 38 of file SCserdAuthModule.php5.

References SObject::getError(), SConfig::getOption(), SWATFunctions::safeSql(), and SObject::setPrettyError().

SCserdAuthModule::getEmail

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 144 of file SCserdAuthModule.php5.

SCserdAuthModule::getFirstName

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 122 of file SCserdAuthModule.php5.

SCserdAuthModule::getLastName

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 133 of file SCserdAuthModule.php5.

SCserdAuthModule::getPermissions

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 100 of file SCserdAuthModule.php5.

SCserdAuthModule::getRole

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 89 of file SCserdAuthModule.php5.

SCserdAuthModule::getUID

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 111 of file SCserdAuthModule.php5.

SCserdAuthModule::setEmail

(

$

email

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

$email

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 180 of file SCserdAuthModule.php5.

SCserdAuthModule::setUID

(

$

uid

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 156 of file SCserdAuthModule.php5.

SCserdAuthModule::setUserName

(

$

username

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

$username

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 168 of file SCserdAuthModule.php5.

---

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

• SWAT/auth/SCserdAuthModule.php5