CSERDUser Class Reference

Inheritance diagram for CSERDUser:

List of all members.

Public Member Functions

doc ()

INSERT BRIEF DESCRIPTION HERE.

getAttributes ()

INSERT BRIEF DESCRIPTION HERE.

getEntity ()

INSERT BRIEF DESCRIPTION HERE.

getId ()

INSERT BRIEF DESCRIPTION HERE.

getUniqueAttributes ()

INSERT BRIEF DESCRIPTION HERE.

hasEditor ()

INSERT BRIEF DESCRIPTION HERE.

isAccredited ()

INSERT BRIEF DESCRIPTION HERE.

isActive ()

INSERT BRIEF DESCRIPTION HERE.

isEditor ()

INSERT BRIEF DESCRIPTION HERE.

isReviewer ()

INSERT BRIEF DESCRIPTION HERE.

reset ()

INSERT BRIEF DESCRIPTION HERE.

setAccredited ()

INSERT BRIEF DESCRIPTION HERE.

setActive ($active="")

INSERT BRIEF DESCRIPTION HERE.

setEmail ($a)

INSERT BRIEF DESCRIPTION HERE.

setId ($id)

INSERT BRIEF DESCRIPTION HERE.

setNotAccredited ()

INSERT BRIEF DESCRIPTION HERE.

Static Public Member Functions

static exists ($constraints=array())

Checks to see if object exists according to constraints.

static retrieve ($constraints=array(), $checkOnly=false)

Retrieves a single object of this type, given the constraints.

Public Attributes

const NOT_ACTIVE

Means the user is not currently active in the system (not allowed to login).

Protected Attributes

$active

Whether or not the user is active (or disabled).

$firstName

The first name of the user as a string.

$lastName

The last name of the user as a string.

$role

The user's current role (changes based on their login status).

$userName

The username of the user for login.

Detailed Description

CSERDUser Object

Author: mevans@shodor.org, jwsm@shodor.org Last Updated: 12/3/2007 - jwsm@shodor.org - changed object to extend SUser as local project user object under SWAT user authentication paradigm.

Created: Mar 8, 2007 This object represents a user from CSERD. The users contains all of the information necessary to write a review, interact with the site, and function as a member of CSERD.

Definition at line 17 of file CSERDUser.php5.

Member Function Documentation

CSERDUser::doc ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Reimplemented from SUser.

Definition at line 57 of file CSERDUser.php5.

static CSERDUser::exists ( $ constraints = array() ) [static]

Checks to see if object exists according to constraints.

This is simply an alias for retrieve($constraints, true);

Parameters:

$constraints

[array]: constraints used to check for existence of object

Returns:: [boolean]: whether object exists in DB

Definition at line 270 of file CSERDUser.php5.

CSERDUser::getAttributes ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Reimplemented from SUser.

Definition at line 68 of file CSERDUser.php5.

CSERDUser::getEntity ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Reimplemented from SModel.

Definition at line 91 of file CSERDUser.php5.

CSERDUser::getId ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 102 of file CSERDUser.php5.

CSERDUser::getUniqueAttributes ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Reimplemented from SUser.

Definition at line 80 of file CSERDUser.php5.

CSERDUser::hasEditor ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 204 of file CSERDUser.php5.

References SUser::isAdmin(), and isEditor().

CSERDUser::isAccredited ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 231 of file CSERDUser.php5.

CSERDUser::isActive ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 219 of file CSERDUser.php5.

CSERDUser::isEditor ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 182 of file CSERDUser.php5.

Referenced by hasEditor().

CSERDUser::isReviewer ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 193 of file CSERDUser.php5.

CSERDUser::reset ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Reimplemented from SUser.

Definition at line 243 of file CSERDUser.php5.

References setActive(), setEmail(), and setId().

static CSERDUser::retrieve	(	$	constraints = `array()`,
		$	checkOnly = `false`
	)			`[static]`

Retrieves a single object of this type, given the constraints.

Use this method instead of the constructor since the constructor cannot return error conditions properly.

Parameters:

	$constraints	[array]: constraints to use when retrieving object
	$checkOnly	[boolean]: if true, just return whether the row exists in the DB

Returns:: [CSERDuser]: retrieved object, or null on error or object does not exist (or true/false if $checkOnly is true, to indicate whether the row exists in the DB)

Definition at line 285 of file CSERDUser.php5.

CSERDUser::setAccredited ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 156 of file CSERDUser.php5.

CSERDUser::setActive ( $ active = "" )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$active

[TYPE]: DESCRIPTION

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 141 of file CSERDUser.php5.

References $active.

Referenced by reset().

CSERDUser::setEmail ( $ a )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$a

[TYPE]: DESCRIPTION

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 125 of file CSERDUser.php5.

References SObject::setError().

Referenced by reset().

CSERDUser::setId ( $ id )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$id

[TYPE]: DESCRIPTION

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 111 of file CSERDUser.php5.

References SUser::$id.

Referenced by reset().

CSERDUser::setNotAccredited ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 167 of file CSERDUser.php5.

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

SWAT/auth/CSERDUser.php5


Public Member Functions
	doc ()
	INSERT BRIEF DESCRIPTION HERE.
	getAttributes ()
	INSERT BRIEF DESCRIPTION HERE.
	getEntity ()
	INSERT BRIEF DESCRIPTION HERE.
	getId ()
	INSERT BRIEF DESCRIPTION HERE.
	getUniqueAttributes ()
	INSERT BRIEF DESCRIPTION HERE.
	hasEditor ()
	INSERT BRIEF DESCRIPTION HERE.
	isAccredited ()
	INSERT BRIEF DESCRIPTION HERE.
	isActive ()
	INSERT BRIEF DESCRIPTION HERE.
	isEditor ()
	INSERT BRIEF DESCRIPTION HERE.
	isReviewer ()
	INSERT BRIEF DESCRIPTION HERE.
	reset ()
	INSERT BRIEF DESCRIPTION HERE.
	setAccredited ()
	INSERT BRIEF DESCRIPTION HERE.
	setActive ($active="")
	INSERT BRIEF DESCRIPTION HERE.
	setEmail ($a)
	INSERT BRIEF DESCRIPTION HERE.
	setId ($id)
	INSERT BRIEF DESCRIPTION HERE.
	setNotAccredited ()
	INSERT BRIEF DESCRIPTION HERE.
Static Public Member Functions
static	exists ($constraints=array())
	Checks to see if object exists according to constraints.
static	retrieve ($constraints=array(), $checkOnly=false)
	Retrieves a single object of this type, given the constraints.
Public Attributes
const	NOT_ACTIVE
	Means the user is not currently active in the system (not allowed to login).
Protected Attributes
	$active
	Whether or not the user is active (or disabled).
	$firstName
	The first name of the user as a string.
	$lastName
	The last name of the user as a string.
	$role
	The user's current role (changes based on their login status).
	$userName
	The username of the user for login.