Fossology\Lib\Dao\UserDao Class Reference

Collaboration diagram for Fossology\Lib\Dao\UserDao:

Public Member Functions
	__construct (DbManager $dbManager, Logger $logger)
	getUserChoices ($groupId=null)
	getUsersByGroup ($groupId=null)
	getAdminGroupMap ($userId, $userLevel=0)
	get array of groups that this user has admin access to More...
	getUserGroupMap ($userId)
	get array of groups that this user has admin access to More...
	getDeletableAdminGroupMap ($userId, $userLevel=0)
	get array of groups that this user has admin access to More...
	deleteGroup ($groupId)
	Delete a group (for constraint, see http://www.fossology.org/projects/fossology/wiki/GroupsPerms ) More...
	updateUserTable ()
	getUserByName ($userName)
	getUserByPk ($userPk)
	getGroupIdByName ($groupName)
	setDefaultGroupMembership ($userId, $groupId)
	getUserAndDefaultGroupByUserName (&$userName, $oauth=false)
	isUserActive ($userName)
	isUserIdActive ($userId)
	updateUserLastConnection ($userId)
	isAdvisorOrAdmin ($userId, $groupId)
	addGroup ($groupName)
	addGroupMembership ($groupId, $userId, $groupPerm=1)
	getUserName ($userId)
	getGroupNameById ($groupId)
	getUserEmail ($userId)
	getAllUsers ()
	editGroup ($groupId, $newGroupName)

Public Attributes
const	USER = 0
const	ADMIN = 1
const	ADVISOR = 2
const	USER_ACTIVE_STATUS = 'active'
const	SUPER_USER = 'fossy'

Private Member Functions
	getUserByPermission ($permission)
	fixDefaultGroup ($userId, $groupName)

Private Attributes
	$dbManager
	$logger
	$session

Detailed Description

Definition at line 18 of file UserDao.php.

Member Function Documentation

addGroup()

Fossology\Lib\Dao\UserDao::addGroup

(

$groupName

)

Parameters

string

$groupName

raw group name as entered by the user

Returns

int $groupId

Exceptions

Definition at line 394 of file UserDao.php.

deleteGroup()

Fossology\Lib\Dao\UserDao::deleteGroup

(

$groupId

)

Delete a group (for constraint, see http://www.fossology.org/projects/fossology/wiki/GroupsPerms )

Parameters

$groupId

Exceptions

Definition at line 164 of file UserDao.php.

editGroup()

Fossology\Lib\Dao\UserDao::editGroup	(		$groupId,
			$newGroupName
	)

Parameters

int	$groupId
string	$newGroupName

Definition at line 475 of file UserDao.php.

fixDefaultGroup()

Fossology\Lib\Dao\UserDao::fixDefaultGroup (   $userId,   $groupName  )

private

Parameters

int	$userId
string	$groupName

Returns

array with keys 'group_fk', 'group_name'

Definition at line 364 of file UserDao.php.

getAdminGroupMap()

Fossology\Lib\Dao\UserDao::getAdminGroupMap	(		$userId,
			$userLevel = 0
	)

get array of groups that this user has admin access to

Parameters

int

$userId

Returns

array in the format {group_pk=>group_name, group_pk=>group_name, ...}

Definition at line 94 of file UserDao.php.

getAllUsers()

Fossology\Lib\Dao\UserDao::getAllUsers

(

)

Get all users from users table

Returns

array

Definition at line 466 of file UserDao.php.

getDeletableAdminGroupMap()

Fossology\Lib\Dao\UserDao::getDeletableAdminGroupMap	(		$userId,
			$userLevel = 0
	)

get array of groups that this user has admin access to

Parameters

int

$userId

Returns

array in the format {group_pk=>group_name, group_pk=>group_name, ...}

Definition at line 135 of file UserDao.php.

getGroupIdByName()

Fossology\Lib\Dao\UserDao::getGroupIdByName

(

$groupName

)

Parameters

$groupName

Returns

array

Definition at line 275 of file UserDao.php.

getGroupNameById()

Fossology\Lib\Dao\UserDao::getGroupNameById

(

$groupId

)

Parameters

$groupId

Returns

array

Definition at line 440 of file UserDao.php.

getUserByName()

Fossology\Lib\Dao\UserDao::getUserByName

(

$userName

)

Parameters

$userName

Returns

array

Definition at line 257 of file UserDao.php.

getUserByPermission()

Fossology\Lib\Dao\UserDao::getUserByPermission (   $permission )

private

Parameters

$permission

Returns

array

Definition at line 285 of file UserDao.php.

getUserByPk()

Fossology\Lib\Dao\UserDao::getUserByPk

(

$userPk

)

Parameters

$userPk

Returns

array

Definition at line 266 of file UserDao.php.

getUserChoices()

Fossology\Lib\Dao\UserDao::getUserChoices

(

$groupId = null

)

Returns

array

Definition at line 47 of file UserDao.php.

getUserEmail()

Fossology\Lib\Dao\UserDao::getUserEmail

(

$userId

)

Parameters

int

$userId

Returns

string

Definition at line 453 of file UserDao.php.

getUserGroupMap()

Fossology\Lib\Dao\UserDao::getUserGroupMap

(

$userId

)

get array of groups that this user has admin access to

Parameters

int

$userId

Returns

array in the format {group_pk=>group_name, group_pk=>group_name, ...}

Definition at line 117 of file UserDao.php.

getUserName()

Fossology\Lib\Dao\UserDao::getUserName

(

$userId

)

Parameters

int

$userId

Returns

string

Definition at line 427 of file UserDao.php.

getUsersByGroup()

Fossology\Lib\Dao\UserDao::getUsersByGroup

(

$groupId = null

)

Get active users of a group as user_pk => user_name.

Parameters

int | null

$groupId

Returns

array

Definition at line 71 of file UserDao.php.

isUserActive()

Fossology\Lib\Dao\UserDao::isUserActive

(

$userName

)

Parameters

string

$userName

Returns

boolean true if user status=active

Definition at line 332 of file UserDao.php.

isUserIdActive()

Fossology\Lib\Dao\UserDao::isUserIdActive

(

$userId

)

Parameters

int

$userId

Returns

boolean true if user status=active

Definition at line 343 of file UserDao.php.

setDefaultGroupMembership()

Fossology\Lib\Dao\UserDao::setDefaultGroupMembership	(		$userId,
			$groupId
	)

Parameters

int	$userId
int	$groupId

Definition at line 294 of file UserDao.php.

updateUserLastConnection()

Fossology\Lib\Dao\UserDao::updateUserLastConnection

(

$userId

)

Parameters

int

$userId

Definition at line 353 of file UserDao.php.

---

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

• src/lib/php/Dao/UserDao.php