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

Class: tlRole

Source Location: /role.class.php

Class tlRole

Class Overview

TestLink Open Source Project - http://testlink.sourceforge.net/ This script is distributed under the GNU General Public License 2 or later.

Filename $RCSfile: tlRole.html,v $

Located in /role.class.php [line 17]

tlObject
   |
   --tlDBObject
      |
      --tlRole
Author(s):
Information Tags:
Version:  $Revision: 1.1.2.1 $

Properties

Methods

[ Top ]
Property Summary
mixed   $description  
mixed   $name  
mixed   $replacementRoleID  
mixed   $rights  

[ Top ]
Method Summary
static void   checkRoleName()  
static void   doesRoleExist()  
static void   getAll()  
static void   getByID()  
static void   getByIDs()  
tlRole   __construct()  
void   addRightsToDB()  
void   buildRightsArray()  
void   checkDetails()  
void   deleteFromDB()  
void   deleteRightsFromDB()  
array   getAllUsersWithRole()   Gets all users which have a certain global,testplan or testproject role
array   getUsersWithGlobalRole()   Gets all users with a certain global role
array   getUsersWithTestPlanRole()   Gets all users with a certain testplan role
array   getUsersWithTestProjectRole()   Gets all users with a certain testproject role
void   hasRight()  
void   readFromDB()  
void   readRights()  
void   replaceUserRolesWith()  
void   writeToDB()  
void   _clean()  

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


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


[ Top ]
mixed   $replacementRoleID [line 23]
API Tags:
Access:  protected


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


[ Top ]
Methods
static method checkRoleName  [line 154]

  static void checkRoleName( $name  )

Parameters:
   $name: 

API Tags:
Access:  public


[ Top ]
static method doesRoleExist  [line 146]

  static void doesRoleExist( &$db, $name, $id  )

Parameters:
   &$db: 
   $name: 
   $id: 

API Tags:
Access:  public


[ Top ]
static method getAll  [line 317]

  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 312]

  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 334]

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

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

API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 36]

  tlRole __construct( [ $dbID = null]  )

Parameters:
   $dbID: 


Redefinition of:
tlDBObject::__construct()

[ Top ]
addRightsToDB  [line 276]

  void addRightsToDB( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  protected


[ Top ]
buildRightsArray  [line 300]

  void buildRightsArray( $rightInfo  )

Parameters:
   $rightInfo: 

API Tags:
Access:  protected


[ Top ]
checkDetails  [line 131]

  void checkDetails( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
deleteFromDB  [line 158]

  void deleteFromDB( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
deleteRightsFromDB  [line 260]

  void deleteRightsFromDB( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  protected


[ Top ]
getAllUsersWithRole  [line 230]

  array getAllUsersWithRole( &$db, object $db, int $roleID  )

Gets all users which have a certain global,testplan or testproject role

Parameters:
object   $db:  [ref] the db-object
int   $roleID:  the role id
   &$db: 

API Tags:
Return:  returns assoc map with the userids as the keys
Access:  public


[ Top ]
getUsersWithGlobalRole  [line 190]

  array getUsersWithGlobalRole( &$db, object $db, int $roleID  )

Gets all users with a certain global role

Parameters:
object   $db:  [ref] the db-object
int   $roleID:  the role id
   &$db: 

API Tags:
Return:  returns assoc map with the userids as the keys
Access:  protected


[ Top ]
getUsersWithTestPlanRole  [line 216]

  array getUsersWithTestPlanRole( &$db, object $db, int $roleID  )

Gets all users with a certain testplan role

Parameters:
object   $db:  [ref] the db-object
int   $roleID:  the role id
   &$db: 

API Tags:
Return:  returns assoc map with the userids as the keys
Access:  protected


[ Top ]
getUsersWithTestProjectRole  [line 202]

  array getUsersWithTestProjectRole( &$db, object $db, int $roleID  )

Gets all users with a certain testproject role

Parameters:
object   $db:  [ref] the db-object
int   $roleID:  the role id
   &$db: 

API Tags:
Return:  returns assoc map with the userids as the keys
Access:  protected


[ Top ]
hasRight  [line 248]

  void hasRight( $rightName  )

Parameters:
   $rightName: 

API Tags:
Access:  public


[ Top ]
readFromDB  [line 54]

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

Parameters:
   &$db: 
   $options: 

API Tags:
Access:  public


[ Top ]
readRights  [line 291]

  void readRights( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  protected


[ Top ]
replaceUserRolesWith  [line 171]

  void replaceUserRolesWith( &$db, $newRole  )

Parameters:
   &$db: 
   $newRole: 

API Tags:
Access:  protected


[ Top ]
writeToDB  [line 95]

  void writeToDB( &$db  )

Parameters:
   &$db: 

API Tags:
Access:  public


[ Top ]
_clean  [line 43]

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

Parameters:
   $options: 

API Tags:
Access:  protected


Redefinition of:
tlObject::_clean()

[ Top ]
Constants
E_DBERROR = -2 [line 31]

[ Top ]
E_EMPTYROLE = -5 [line 34]

[ Top ]
E_NAMEALREADYEXISTS = -4 [line 33]

[ Top ]
E_NAMELENGTH = -3 [line 32]

[ Top ]
ROLE_O_SEARCH_BYNAME = 2 [line 26]

[ Top ]
TLOBJ_O_GET_DETAIL_RIGHTS = 1 [line 29]

[ Top ]

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