RoleDAO Class Reference

Operations for retrieving and modifying Role objects. More...

List of all members.

Public Member Functions

_returnRoleFromRow (&$row)
 deleteRole (&$role)
 deleteRoleByConferenceId ($conferenceId)
 deleteRoleBySchedConfId ($schedConfId)
 deleteRoleByUserId ($userId, $conferenceId=null, $roleId=null, $schedConfId=null)
 getConferenceUsersCount ($conferenceId)
getRole ($conferenceId, $schedConfId, $userId, $roleId)
 getRoleIdFromPath ($rolePath)
 getRoleName ($roleId, $plural=false)
 getRolePath ($roleId)
getRolesByConferenceId ($conferenceId=null, $roleId=null)
getRolesByUserId ($userId, $conferenceId=null, $schedConfId=null)
 getSchedConfUsersCount ($schedConfId, $roleId=null)
 getSortMapping ($heading)
getUsersByConferenceId ($conferenceId, $searchType=null, $search=null, $searchMatch=null, $dbResultRange=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
getUsersByRoleId ($roleId=null, $conferenceId=null, $schedConfId=null, $searchType=null, $search=null, $searchMatch=null, $dbResultRange=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
getUsersBySchedConfId ($schedConfId, $searchType=null, $search=null, $searchMatch=null, $dbResultRange=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 insertRole (&$role)
 RoleDAO ()
 roleExists ($conferenceId, $schedConfId, $userId, $roleId)


Detailed Description

Operations for retrieving and modifying Role objects.

See also:
Role

Definition at line 20 of file RoleDAO.inc.php.


Member Function Documentation

& RoleDAO._returnRoleFromRow ( &$  row  ) 

Internal function to return a Role object from a row.

Parameters:
$row array
Returns:
Role

Definition at line 63 of file RoleDAO.inc.php.

Referenced by getRole(), getRolesByConferenceId(), and getRolesByUserId().

RoleDAO.deleteRole ( &$  role  ) 

Delete a role.

Parameters:
$role Role

Definition at line 98 of file RoleDAO.inc.php.

RoleDAO.deleteRoleByConferenceId ( conferenceId  ) 

Delete all roles for a specified conference.

Parameters:
$conferenceId int

Definition at line 418 of file RoleDAO.inc.php.

RoleDAO.deleteRoleBySchedConfId ( schedConfId  ) 

Delete all roles for a specified scheduled conference.

Parameters:
$schedConfId int

Definition at line 428 of file RoleDAO.inc.php.

RoleDAO.deleteRoleByUserId ( userId,
conferenceId = null,
roleId = null,
schedConfId = null 
)

Delete all roles for a specified conference.

Parameters:
$userId int
$conferenceId int optional, include roles only in this conference
$roleId int optional, include only this role

Definition at line 440 of file RoleDAO.inc.php.

RoleDAO.getConferenceUsersCount ( conferenceId  ) 

Retrieve the number of users associated with the specified conference.

Parameters:
$conferenceId int
Returns:
int

Definition at line 347 of file RoleDAO.inc.php.

& RoleDAO.getRole ( conferenceId,
schedConfId,
userId,
roleId 
)

Retrieve a role.

Parameters:
$conferenceId int
$userId int
$roleId int
Returns:
Role

Definition at line 36 of file RoleDAO.inc.php.

References _returnRoleFromRow().

RoleDAO.getRoleIdFromPath ( rolePath  ) 

Get a role's ID based on its path.

Parameters:
$rolePath string
Returns:
int

Definition at line 532 of file RoleDAO.inc.php.

Referenced by DirectorHandler.assignDirector(), UserImportExportPlugin.display(), and TrackDirectorSubmissionDAO.getReviewersNotAssignedToPaper().

RoleDAO.getRoleName ( roleId,
plural = false 
)

Get the i18n key name associated with the specified role.

Parameters:
$roleId int
$plural boolean get the plural form of the name
Returns:
string

Definition at line 480 of file RoleDAO.inc.php.

Referenced by Role.getRoleName().

RoleDAO.getRolePath ( roleId  ) 

Get the URL path associated with the specified role's operations.

Parameters:
$roleId int
Returns:
string

Definition at line 506 of file RoleDAO.inc.php.

Referenced by Role.getRolePath().

& RoleDAO.getRolesByConferenceId ( conferenceId = null,
roleId = null 
)

Select all roles for a specified conference.

Parameters:
$conferenceId int optional
$roleId int optional

Definition at line 393 of file RoleDAO.inc.php.

References _returnRoleFromRow().

& RoleDAO.getRolesByUserId ( userId,
conferenceId = null,
schedConfId = null 
)

Retrieve a list of all roles for a specified user.

Parameters:
$userId int
$conferenceId int optional, include roles only in this conference
$schedConfId int optional, include roles only in this scheduled conference
Returns:
array matching Roles

Definition at line 117 of file RoleDAO.inc.php.

References _returnRoleFromRow().

RoleDAO.getSchedConfUsersCount ( schedConfId,
roleId = null 
)

Retrieve the number of users associated with the specified scheduled conference.

Parameters:
$schedConfId int
$roleId int ROLE_ID_... (optional) role to count
Returns:
int

Definition at line 369 of file RoleDAO.inc.php.

RoleDAO.getSortMapping ( heading  ) 

Map a column heading value to a database value for sorting

Parameters:
string 
Returns:
string

Definition at line 558 of file RoleDAO.inc.php.

Referenced by getUsersByConferenceId(), getUsersByRoleId(), and getUsersBySchedConfId().

& RoleDAO.getUsersByConferenceId ( conferenceId,
searchType = null,
search = null,
searchMatch = null,
dbResultRange = null,
sortBy = null,
sortDirection = SORT_DIRECTION_ASC 
)

Retrieve a list of all users with some role in the specified conference.

Parameters:
$conferenceId int
$searchType int optional, which field to search
$search string optional, string to match
$searchMatch string optional, type of match ('is' vs. 'contains' vs. 'startsWith')
$dbRangeInfo object DBRangeInfo object describing range of results to return
Returns:
array matching Users

Definition at line 229 of file RoleDAO.inc.php.

References getSortMapping().

& RoleDAO.getUsersByRoleId ( roleId = null,
conferenceId = null,
schedConfId = null,
searchType = null,
search = null,
searchMatch = null,
dbResultRange = null,
sortBy = null,
sortDirection = SORT_DIRECTION_ASC 
)

Retrieve a list of users in a specified role.

Parameters:
$roleId int optional (can leave as null to get all users in conference)
$conferenceId int optional, include users only in this conference
$schedConfId int optional, include users only in this conference
$searchType int optional, which field to search
$search string optional, string to match
$searchMatch string optional, type of match ('is' vs. 'contains' vs. 'startsWith')
$dbResultRange object DBRangeInfo object describing range of results to return
Returns:
array matching Users

Definition at line 152 of file RoleDAO.inc.php.

References getSortMapping().

& RoleDAO.getUsersBySchedConfId ( schedConfId,
searchType = null,
search = null,
searchMatch = null,
dbResultRange = null,
sortBy = null,
sortDirection = SORT_DIRECTION_ASC 
)

Retrieve a list of all users with some role in the specified scheduled conference.

Parameters:
$schedConfId int
$searchType int optional, which field to search
$search string optional, string to match
$searchMatch string optional, type of match ('is' vs. 'contains')
$dbRangeInfo object DBRangeInfo object describing range of results to return
Returns:
array matching Users

Definition at line 292 of file RoleDAO.inc.php.

References getSortMapping().

RoleDAO.insertRole ( &$  role  ) 

Insert a new role.

Parameters:
$role Role

Definition at line 79 of file RoleDAO.inc.php.

RoleDAO.RoleDAO (  ) 

Constructor.

Definition at line 24 of file RoleDAO.inc.php.

RoleDAO.roleExists ( conferenceId,
schedConfId,
userId,
roleId 
)

Check if a role exists.

Parameters:
$conferenceId int
$userId int
$roleId int
Returns:
boolean

Definition at line 462 of file RoleDAO.inc.php.


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7