phpDocumentor Testlink
[ class tree: Testlink ] [ index: Testlink ] [ all elements ]

Class: tlUser

Source Location: /user.class.php

Class tlUser

Property Summary
mixed   $bActive  
mixed   $defaultTestprojectID  
mixed   $emailAddress  
mixed   $firstName  
mixed   $globalRole  
mixed   $globalRoleID  
mixed   $lastName  
mixed   $locale  
mixed   $login  
mixed   $loginMethod  
mixed   $maxLoginLength  
mixed   $password  
mixed   $tplanRoles  
mixed   $tprojectRoles  
mixed   $userApiKey  
mixed   $usernameFormat  

[ Top ]
Method Summary
static void   checkEmailAdress()  
static void   checkFirstName()  
static void   checkLastName()  
static void   doesUserExist()  
static void   getAll()  
static void   getByID()  
static void   getByIDs()  
static void   isPasswordMgtExternal()  
tlUser   __construct()  
void   checkDetails()  
void   checkLogin()  
void   comparePassword()  
void   create()  
void   deleteFromDB()  
tl::OK   deleteTestProjectRoles()   Deletes all testproject related role assignments for a given user
void   encryptPassword()  
void   getDisplayName()  
void   getEffectiveRole()  
void   getPassword()  
void   hasRight()  
void   readFromDB()  
void   readTestPlanRoles()  
void   readTestProjectRoles()  
void   setPassword()  
void   writeToDB()  
void   _clean()  

[ Top ]
Properties
mixed   $bActive [line 22]
API Tags:
Access:  public


[ Top ]
mixed   $defaultTestprojectID [line 23]
API Tags:
Access:  public


[ Top ]
mixed   $emailAddress [line 20]
API Tags:
Access:  public


[ Top ]
mixed   $firstName [line 18]
API Tags:
Access:  public


[ Top ]
mixed   $globalRole [line 24]
API Tags:
Access:  public


[ Top ]
mixed   $globalRoleID [line 25]
API Tags:
Access:  public


[ Top ]
mixed   $lastName [line 19]
API Tags:
Access:  public


[ Top ]
mixed   $locale [line 21]
API Tags:
Access:  public


[ Top ]
mixed   $login [line 28]
API Tags:
Access:  public


[ Top ]
mixed   $loginMethod [line 34]
API Tags:
Access:  protected


[ Top ]
mixed   $maxLoginLength [line 35]
API Tags:
Access:  protected


[ Top ]
mixed   $password [line 30]
API Tags:
Access:  protected


[ Top ]
mixed   $tplanRoles [line 27]
API Tags:
Access:  public


[ Top ]
mixed   $tprojectRoles [line 26]
API Tags:
Access:  public


[ Top ]
mixed   $userApiKey [line 29]
API Tags:
Access:  public


[ Top ]
mixed   $usernameFormat [line 33]
API Tags:
Access:  protected


[ Top ]
Methods
static method checkEmailAdress  [line 421]

  static void checkEmailAdress( $email  )

Parameters:
   $email: 

API Tags:
Access:  public


[ Top ]
static method checkFirstName  [line 437]

  static void checkFirstName( $first  )

Parameters:
   $first: 

API Tags:
Access:  public


[ Top ]
static method checkLastName  [line 442]

  static void checkLastName( $last  )

Parameters:
   $last: 

API Tags:
Access:  public


[ Top ]
static method doesUserExist  [line 447]

  static void doesUserExist( &$db, $login  )

Parameters:
   &$db: 
   $login: 

API Tags:
Access:  public


[ Top ]
static method getAll  [line 475]

  static void getAll( &$db, [ $whereClause = null], [ $column = null], [ $orderBy = null], [ $detailLevel = self::TLOBJ_O_GET_DETAIL_FULL]  )

Parameters:
   &$db: 
   $whereClause: 
   $column: 
   $orderBy: 
   $detailLevel: 

API Tags:
Access:  public


[ Top ]
static method getByID  [line 456]

  static void getByID( &$db, $id, [ $detailLevel = self::TLOBJ_O_GET_DETAIL_FULL]  )

Parameters:
   &$db: 
   $id: 
   $detailLevel: 

API Tags:
Access:  public


[ Top ]
static method getByIDs  [line 462]

  static void getByIDs( &$db, $ids, [ $detailLevel = self::TLOBJ_O_GET_DETAIL_FULL]  )

Parameters:
   &$db: 
   $ids: 
   $detailLevel: 

API Tags:
Access:  public


[ Top ]
static method isPasswordMgtExternal  [line 99]

  static void isPasswordMgtExternal( )


API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 57]

  tlUser __construct( [ $dbID = null]  )

Parameters:
   $dbID: 


Redefinition of:
tlDBObject::__construct()

[ Top ]
checkDetails  [line 304]

  void checkDetails( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
checkLogin  [line 326]

  void checkLogin( $login  )

Parameters:
   $login: 

API Tags:
Access:  public


[ Top ]
comparePassword  [line 294]

  void comparePassword( $pwd  )

Parameters:
   $pwd: 

API Tags:
Access:  public


[ Top ]
create  [line 106]

  void create( )



[ Top ]
deleteFromDB  [line 225]

  void deleteFromDB( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
deleteTestProjectRoles  [line 254]

  tl::OK deleteTestProjectRoles( &$db, object $db, int $userID  )

Deletes all testproject related role assignments for a given user

Parameters:
object   $db:  [ref] the db-object
int   $userID:  the user id
   &$db: 

API Tags:
Return:  on success, tl:ERROR else
Access:  protected


[ Top ]
encryptPassword  [line 270]

  void encryptPassword( $pwd  )

Parameters:
   $pwd: 

API Tags:
Access:  protected


[ Top ]
getDisplayName  [line 260]

  void getDisplayName( )


API Tags:
Access:  public


[ Top ]
getEffectiveRole  [line 348]

  void getEffectiveRole( &$db, $tproject_id, $tplan_id  )

Parameters:
   &$db: 
   $tproject_id: 
   $tplan_id: 


[ Top ]
getPassword  [line 289]

  void getPassword( )


API Tags:
Access:  public


[ Top ]
hasRight  [line 363]

  void hasRight( &$db, $roleQuestion, [ $tprojectID = null], [ $tplanID = null]  )

Parameters:
   &$db: 
   $roleQuestion: 
   $tprojectID: 
   $tplanID: 


[ Top ]
readFromDB  [line 110]

  void readFromDB( &$db, [ $options = self::TLOBJ_O_SEARCH_BY_ID]  )

Parameters:
   &$db: 
   $options: 

API Tags:
Access:  public


[ Top ]
readTestPlanRoles  [line 171]

  void readTestPlanRoles( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  protected


[ Top ]
readTestProjectRoles  [line 154]

  void readTestProjectRoles( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  protected


[ Top ]
setPassword  [line 278]

  void setPassword( $pwd  )

Parameters:
   $pwd: 

API Tags:
Access:  public


[ Top ]
writeToDB  [line 188]

  void writeToDB( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
_clean  [line 74]

  void _clean( [ $options = self::TLOBJ_O_SEARCH_BY_ID]  )

Parameters:
   $options: 

API Tags:
Access:  protected


Redefinition of:
tlObject::_clean()

[ Top ]
Constants
E_DBERROR = -8 [line 41]

[ Top ]
E_EMAILFORMAT = -512 [line 47]

[ Top ]
E_EMAILLENGTH = -2 [line 39]

[ Top ]
E_FIRSTNAMELENGTH = -16 [line 42]

[ Top ]
E_LASTNAMELENGTH = -32 [line 43]

[ Top ]
E_LOGINALREADYEXISTS = -256 [line 46]

[ Top ]
E_LOGINLENGTH = -1 [line 38]

[ Top ]
E_NOTALLOWED = -4 [line 40]

[ Top ]
E_PWDDONTMATCH = -128 [line 45]

[ Top ]
E_PWDEMPTY = -64 [line 44]

[ Top ]
S_PWDMGTEXTERNAL = 2 [line 48]

[ Top ]
TLOBJ_O_GET_DETAIL_ROLES = 1 [line 55]

[ Top ]
USER_O_SEARCH_BYLOGIN = 2 [line 51]

[ Top ]

Documentation generated on Fri, 03 Apr 2009 14:13:50 +0200 by phpDocumentor 1.4.1