Procedural File: BitPermUser.php

Source Location: /users/BitPermUser.php

Classes:

Class that holds all information for a given user

Page Details:

$Header$

Lib for user administration, groups and permissions This lib uses pear so the constructor requieres Copyright (c) 2004 bitweaver.org Copyright (c) 2003 tikwiki.org Copyright (c) 2002-2003, Luis Argerich, Garland Foster, Eduardo Polidor, et. al. All Rights Reserved. See below for details and a complete list of authors. Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See http://www.gnu.org/copyleft/lesser.html for details

$Id$

Tags:

filesource:

Source Code for this file

Includes:

require_once(USERS_PKG_PATH.'/BitUser.php') [line 21]
required setup

assignLevelPermissions [line 823]

void assignLevelPermissions(
array $pGroupId, array $pLevel, [array $pPackage = NULL])

assignLevelPermissions Assign the permissions of a given level to a given group

Tags:

access:

public

Parameters

array	$pGroupId	Group we want to assign permissions to
array	$pLevel	permission level we wish to assign from
array	$pPackage	limit set of permissions to a given package

[ Top ]

assignPermissionToGroup [line 858]

TRUE assignPermissionToGroup(
 $pPerm, array $pGroupId, array $perm)

assignPermissionToGroup

Tags:

return:	on success
access:	public

Parameters

array	$perm
array	$pGroupId
	$pPerm

[ Top ]

getGroupPermissions [line 759]

TRUE getGroupPermissions(
[ $pParamHash = NULL], array $pGroupId, string $pPackage, string $find, array $pSortMode)

getGroupPermissions

Tags:

return:	on success, FALSE on failure
access:	public

Parameters

array	$pGroupId	Group id, if unset, all groups are returned
string	$pPackage	permissions to give group, if unset, all permissions are returned
string	$find	search for a particular permission
array	$pSortMode	sort mode of return hash
	$pParamHash

[ Top ]

getGroupUserData [line 640]

array getGroupUserData(
array $pGroupId, array $pColumns)

getGroupUserData

Tags:

return:	of group data
access:	public

Parameters

array	$pGroupId
array	$pColumns

[ Top ]

getPermissionPackages [line 846]

array getPermissionPackages(
)

getPermissionPackages Get a list of packages that have their own set of permissions

Tags:

return:	of packages
access:	public

[ Top ]

getUnassignedPerms [line 695]

array getUnassignedPerms(
)

getUnassignedPerms

Tags:

return:	of permissions that have not been assigned to any group yet
access:	public

[ Top ]

hasPermission [line 723]

TRUE hasPermission(
array $pPerm)

hasPermission check to see if a user has a given permission

Tags:

return:	if the user has a permission, FALSE if they don't
access:	public

Parameters

array

$pPerm

Perm name

[ Top ]

isAdmin [line 711]

TRUE isAdmin(
[array $pCheckTicket = ])

isAdmin

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

array

$pCheckTicket

[ Top ]

loadPermissions [line 667]

TRUE loadPermissions(
[ $pForceReload = FALSE])

loadPermissions

Tags:

return:	on success, FALSE if no perms were loaded
access:	public

Parameters

$pForceReload

[ Top ]

removePermissionFromGroup [line 876]

TRUE removePermissionFromGroup(
string $pPerm, numeric $pGroupId)

removePermissionFromGroup

Tags:

return:	on success
access:	public

Parameters

string	$pPerm	Perm name
numeric	$pGroupId	Group ID

[ Top ]

setPermissionOverride [line 910]

void setPermissionOverride(
 $pPerm, [ $pValue = NULL])

Grant a single permission to a given value

Parameters

	$pPerm
	$pValue

[ Top ]

storeRegistrationChoice [line 892]

ADO storeRegistrationChoice(
mixed $pGroupMixed, [array $pValue = NULL])

storeRegistrationChoice

Tags:

return:	record set on success, FALSE on failure
access:	public

Parameters

mixed	$pGroupMixed	A single group ID or an array of group IDs
array	$pValue	Value you wish to store - use NULL to delete a value

[ Top ]

verifyPermission [line 740]

none verifyPermission(
$pPermission $pPermission, [ $pMsg = NULL])

verifyPermission check if a user has a given permission and if not

it will display the error template and die()

Tags:

access:

public

Parameters

$pPermission	$pPermission	value of a given permission
	$pMsg

[ Top ]

Documentation generated on Wed, 29 Jul 2015 13:55:57 +0000 by phpDocumentor 1.5.0-lsces