SLdapAuthModule Class Reference
[Undocumented Classes]

INSERT BRIEF DESCRIPTION HERE. More...

Inheritance diagram for SLdapAuthModule:

[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 Shodor LDAP username and password.
	clearAllCaches ()
	INSERT BRIEF DESCRIPTION HERE.
	clearGroupCache ()
	INSERT BRIEF DESCRIPTION HERE.
	clearUserCache ()
	INSERT BRIEF DESCRIPTION HERE.
	getEmail ($uid= '')
	INSERT BRIEF DESCRIPTION HERE.
	getFirstName ($uid= '')
	INSERT BRIEF DESCRIPTION HERE.
	getGroupFromGid ($gid)
	INSERT BRIEF DESCRIPTION HERE.
	getGroupInfo ($gid)
	INSERT BRIEF DESCRIPTION HERE.
	getHomePhone ($uid= '')
	INSERT BRIEF DESCRIPTION HERE.
	getLastName ($uid= '')
	INSERT BRIEF DESCRIPTION HERE.
	getMobile ($uid= '')
	INSERT BRIEF DESCRIPTION HERE.
	getPassword ()
	INSERT BRIEF DESCRIPTION HERE.
	getPermissions ()
	INSERT BRIEF DESCRIPTION HERE.
	getPhone ($uid= '')
	INSERT BRIEF DESCRIPTION HERE.
	getRole ()
	Get a user's role.
	getUID ()
	INSERT BRIEF DESCRIPTION HERE.
	getUidFromRealName ($firstName="", $lastName="")
	INSERT BRIEF DESCRIPTION HERE.
	getUidFromUserName ($username)
	INSERT BRIEF DESCRIPTION HERE.
	getUserFromUid ($uid)
	INSERT BRIEF DESCRIPTION HERE.
	getUserInfo ($uid)
	INSERT BRIEF DESCRIPTION HERE.
	getUserName ()
	INSERT BRIEF DESCRIPTION HERE.
	listGroups ($uid="")
	INSERT BRIEF DESCRIPTION HERE.
	listUsers ()
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Author:

AUTHOR (DATE)

---

Constructor & Destructor Documentation

SLdapAuthModule::__construct

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SObject.

---

Member Function Documentation

SLdapAuthModule::__sleep

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::__wakeup

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::authenticate	(	$	username,
		$	password
	)

Attempt to authenticate this module with a Shodor LDAP username and password.

Parameters:

	$username	[string]: A Shodor LDAP username to authenticate
	$password	[string]: A Shodor LDAP password to authenticate

Returns:

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

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

Reimplemented from SAuthModule.

SLdapAuthModule::clearAllCaches

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::clearGroupCache

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::clearUserCache

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getEmail

(

$

uid = ''

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getFirstName

(

$

uid = ''

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getGroupFromGid

(

$

gid

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$gid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getGroupInfo

(

$

gid

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$gid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getHomePhone

(

$

uid = ''

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getLastName

(

$

uid = ''

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getMobile

(

$

uid = ''

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getPassword

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getPermissions

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SAuthModule.

SLdapAuthModule::getPhone

(

$

uid = ''

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getRole

(

)

Get a user's role.

Returns:

[string]: The role of this user (staff, intern, or apprentice)

Reimplemented from SAuthModule.

SLdapAuthModule::getUID

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SAuthModule.

SLdapAuthModule::getUidFromRealName	(	$	firstName = "",
		$	lastName = ""
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$firstName	[TYPE]: DESCRIPTION
	$lastName	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getUidFromUserName

(

$

username

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$username

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getUserFromUid

(

$

uid

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getUserInfo

(

$

uid

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::getUserName

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::listGroups

(

$

uid = ""

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$uid

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SLdapAuthModule::listUsers

(

)

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/SLdapAuthModule.php5