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.

---

Detailed Description

Handle authentication of a user to the CSERD realm.

Author:

Joel/Jonathan (jfeiner/jwsm)

Date:

11/29/2007

---

Constructor & Destructor Documentation

SCserdAuthModule::__construct

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SObject.

---

Member Function Documentation

SCserdAuthModule::__sleep

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SCserdAuthModule::__wakeup

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

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.

SCserdAuthModule::getEmail

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SCserdAuthModule::getFirstName

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SCserdAuthModule::getLastName

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SCserdAuthModule::getPermissions

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SCserdAuthModule::getRole

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SCserdAuthModule::getUID

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

---

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

• SWAT/auth/SCserdAuthModule.php5