phpDocumentor KuoteInterfaces
Object
[ class tree: KuoteInterfaces ] [ index: KuoteInterfaces ] [ all elements ]

Interface: KuoteInterfaces_User

Source Location: /classes/KuoteInterfaces/User.php

Interface KuoteInterfaces_User

Interface Overview

KuoteInterfaces_User This intefaces defines the set of methods that all User implementations need to function as part of the Kuote System.

Located in /classes/KuoteInterfaces/User.php [line 18]



		
				Author(s):
		
  • Kyle Hall
Information Tags:
Copyright:  2006

Methods

[ Top ]
Method Summary
string   getEmail()   Returns the email of the user.
string   getLogin()   Returns the login name of the user.
string   getNameFirst()   Returns the first name of the user.
string   getNameLast()   Returns the last name of the user.
string   getNameLastFirst()   Returns a string of the format "Lastname, Firstname".
string   getPassword()   Returns the hashed password of the user.
string   getType()   Returns the type of the user.
boolean   setEmail()   Sets the email of the user.
boolean   setLogin()   Sets the login name of the user.
boolean   setNameFirst()   Sets the first name of the user.
boolean   setNameLast()   Sets the last name of the user.
boolean   setPassword()   Sets the password of the user.
boolean   setType()   Sets the type of the user.
void   verify()   Tests whether the given userlogin and password match those in the datastore.

[ Top ]
Methods
getEmail  [line 64]

  string getEmail( )

Returns the email of the user.


API Tags:
Return:  Email
Access:  public


[ Top ]
getLogin  [line 91]

  string getLogin( )

Returns the login name of the user.


API Tags:
Return:  Password Hash
Access:  public


[ Top ]
getNameFirst  [line 38]

  string getNameFirst( )

Returns the first name of the user.


API Tags:
Return:  First Name
Access:  public


[ Top ]
getNameLast  [line 51]

  string getNameLast( )

Returns the last name of the user.


API Tags:
Return:  Last Name
Access:  public


[ Top ]
getNameLastFirst  [line 32]

  string getNameLastFirst( )

Returns a string of the format "Lastname, Firstname".


API Tags:
Return:  String of format "Lastname, Firstname".
Access:  public


[ Top ]
getPassword  [line 77]

  string getPassword( )

Returns the hashed password of the user.


API Tags:
Return:  Password Hash
Access:  public


[ Top ]
getType  [line 105]

  string getType( )

Returns the type of the user.

Type may be either 'student' or 'instructor'


API Tags:
Return:  User Type
Access:  public


[ Top ]
setEmail  [line 71]

  boolean setEmail( string $email  )

Sets the email of the user.

Parameters:
string   $email:  Email

API Tags:
Return:  True on successful set, False otherwise.
Access:  public


[ Top ]
setLogin  [line 98]

  boolean setLogin( string $login  )

Sets the login name of the user.

Parameters:
string   $login:  User Login

API Tags:
Return:  True on successful set, False otherwise.
Access:  public


[ Top ]
setNameFirst  [line 45]

  boolean setNameFirst( string $firstname  )

Sets the first name of the user.

Parameters:
string   $firstname:  First Name

API Tags:
Return:  True on successful set, False otherwise.
Access:  public


[ Top ]
setNameLast  [line 58]

  boolean setNameLast( string $lastname  )

Sets the last name of the user.

Parameters:
string   $lastname:  Last Name

API Tags:
Return:  True on successful set, False otherwise.
Access:  public


[ Top ]
setPassword  [line 85]

  boolean setPassword( string $password  )

Sets the password of the user.

Pass the password in plaintext, the method will hash it.

Parameters:
string   $password:  Plaintext Password

API Tags:
Return:  True on successful set, False otherwise.
Access:  public


[ Top ]
setType  [line 113]

  boolean setType( string $type  )

Sets the type of the user.

Type must be either 'student' or 'instructor'

Parameters:
string   $type:  User Type

API Tags:
Return:  True on successful set, False otherwise.
Access:  public


[ Top ]
verify  [line 26]

  void verify( string $userLogin, string $userPassword  )

Tests whether the given userlogin and password match those in the datastore.

If a match is found, the user for the given username is loaded into the User object.

Parameters:
string   $userLogin:  The user's login name
string   $userPassword:  The password submitted for authentication.

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 15 Dec 2006 11:18:45 -0500 by phpDocumentor 1.3.0