BitPermUser Class Reference

Inheritance diagram for BitPermUser:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 addUserToGroup ($pUserId, $pGroupMixed)
 assignLevelPermissions ($pGroupId, $level, $pPackage=NULL)
 assignPermissionToGroup ($perm, $pGroupId)
 assumeUser ($pUserId)
 batch_set_user_default_group ($pGroupId)
 batchAssignUsersToGroup ($pGroupId)
 BitPermUser ($pUserId=NULL, $pContentId=NULL)
 changePermissionLevel ($perm, $level)
 countGroupUsers ($pGroupId)
 createDummyLevel ($level)
 expunge ()
 get_group_users ($pGroupId)
 get_user_id ($pUserName)
 getAllGroups (&$pListHash)
 getAllUserGroups ($pUserId=NULL)
 getContentTypeList ($pUserId)
 getDefaultGroup ($pGroupId=NULL)
 getGroupHome ($pGroupId)
 getGroupInfo ($pGroupId)
 getGroupPermissions ($pParamHash=NULL)
 getGroups ($pUserId=NULL, $pForceRefresh=FALSE)
 getGroupUserData ($pGroupId, $pColumns)
 getPermissionLevels ()
 getPermissionPackages ()
 getUnassignedPerms ()
 group_has_permission ($pGroupId, $perm)
 groupExists ($pGroupName, $pUserId=ROOT_USER_ID)
 hasPermission ($pPerm)
 isAdmin ($pCheckTicket=FALSE)
 isInGroup ($pGroupMixed)
 load ($pFull=FALSE, $pUserName=NULL)
 loadGroups ($pForceRefresh=FALSE)
 loadPermissions ()
 remove_group ($pGroupId)
 removeLevelPermissions ($group, $level)
 removePermissionFromGroup ($perm, $pGroupId)
 removeUserFromGroup ($pUserId, $pGroupId)
 sanitizeUserInfo ()
 setPermission ($pPerm, $pValue=NULL)
 store (&$pParamHash)
 storeGroup (&$pParamHash)
 storeRegistrationChoice ($groupList, $flag)
 storeUserDefaultGroup ($pUserId, $pGroupId)
 verifyGroup (&$pParamHash)

Public Attributes

 $debug = false
 $groupperm_cache
 $usergroups_cache

Detailed Description

Definition at line 31 of file BitPermUser.php.


Member Function Documentation

BitPermUser::addUserToGroup ( pUserId,
pGroupMixed 
)

Adds user pUserId to group(s) pGroupMixed.

Parameters:
pUserId numerical user id
pGroupMixed either a numerical group id or an array of group ids.
Returns:
Either an ADO RecordSet (success) or false (failure).

Definition at line 380 of file BitPermUser.php.

References $query, $result, FALSE, BitUser::getGroups(), mDb, and BitBase::verifyId().

Referenced by batchAssignUsersToGroup(), and store().

Here is the call graph for this function:

BitPermUser::assignLevelPermissions ( pGroupId,
level,
pPackage = NULL 
)

Definition at line 621 of file BitPermUser.php.

References $query, $result, $ret, $row, assignPermissionToGroup(), and mDb.

Here is the call graph for this function:

BitPermUser::assignPermissionToGroup ( perm,
pGroupId 
)

Definition at line 668 of file BitPermUser.php.

References $query, $result, and mDb.

Referenced by assignLevelPermissions().

BitPermUser::assumeUser ( pUserId  ) 

Definition at line 47 of file BitPermUser.php.

References $_COOKIE, $gBitUser, $ret, $user_cookie_site, BitPermUser(), FALSE, hasPermission(), mDb, mUserId, and tra().

Here is the call graph for this function:

BitPermUser::batch_set_user_default_group ( pGroupId  ) 

Definition at line 353 of file BitPermUser.php.

References $userId, get_group_users(), and storeUserDefaultGroup().

Here is the call graph for this function:

BitPermUser::batchAssignUsersToGroup ( pGroupId  ) 

Definition at line 343 of file BitPermUser.php.

References $rs, $userId, addUserToGroup(), get_group_users(), and mDb.

Here is the call graph for this function:

BitPermUser::BitPermUser ( pUserId = NULL,
pContentId = NULL 
)

Definition at line 37 of file BitPermUser.php.

References BitUser::BitUser().

Referenced by assumeUser().

Here is the call graph for this function:

BitPermUser::changePermissionLevel ( perm,
level 
)

Definition at line 614 of file BitPermUser.php.

References $query, and mDb.

BitPermUser::countGroupUsers ( pGroupId  ) 

Definition at line 485 of file BitPermUser.php.

References $query, and mDb.

BitPermUser::createDummyLevel ( level  ) 

Definition at line 649 of file BitPermUser.php.

References $query, $result, and mDb.

BitPermUser::expunge (  ) 

removes user and associated private data

public

Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Reimplemented from BitUser.

Definition at line 149 of file BitPermUser.php.

References $gBitSystem, $gBitUser, $query, $result, BitUser::expunge(), FALSE, BitUser::isValid(), mDb, mUserId, and tra().

Here is the call graph for this function:

BitPermUser::get_group_users ( pGroupId  ) 

Definition at line 322 of file BitPermUser.php.

References $query, and mDb.

Referenced by batch_set_user_default_group(), and batchAssignUsersToGroup().

BitPermUser::get_user_id ( pUserName  ) 

Definition at line 269 of file BitPermUser.php.

References mDb.

BitPermUser::getAllGroups ( &$  pListHash  ) 

Definition at line 205 of file BitPermUser.php.

References $mid, $query, $ret, $row, $rs, getGroupPermissions(), mDb, and LibertyContent::prepGetList().

Here is the call graph for this function:

BitPermUser::getAllUserGroups ( pUserId = NULL  ) 

Definition at line 258 of file BitPermUser.php.

References $sql, mDb, and mUserId.

BitPermUser::getContentTypeList ( pUserId  ) 

Return a list of packages that the user has permission to access

Definition at line 700 of file BitPermUser.php.

References $contentType, $contentTypes, $gBitUser, $gLibertySystem, and hasPermission().

Here is the call graph for this function:

BitPermUser::getDefaultGroup ( pGroupId = NULL  ) 

Definition at line 312 of file BitPermUser.php.

References mDb.

Referenced by removeUserFromGroup(), and store().

BitPermUser::getGroupHome ( pGroupId  ) 

Definition at line 327 of file BitPermUser.php.

References $query, $res, $result, $ret, FALSE, and mDb.

BitPermUser::getGroupInfo ( pGroupId  ) 

Definition at line 360 of file BitPermUser.php.

References $listHash, $query, $res, $result, $sql, getGroupPermissions(), mDb, and up.

Here is the call graph for this function:

BitPermUser::getGroupPermissions ( pParamHash = NULL  ) 

getGroupPermissions

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 public
Returns:
TRUE on success, FALSE on failure

Definition at line 559 of file BitPermUser.php.

References $gBitSystem, $pParamHash, $query, $ret, mDb, up, and BitBase::verifyId().

Referenced by getAllGroups(), and getGroupInfo().

Here is the call graph for this function:

BitPermUser::getGroups ( pUserId = NULL,
pForceRefresh = FALSE 
)

Definition at line 288 of file BitPermUser.php.

References $query, $res, $ret, mDb, and mUserId.

BitPermUser::getGroupUserData ( pGroupId,
pColumns 
)

Definition at line 466 of file BitPermUser.php.

References $query, $ret, mDb, and BitBase::verifyId().

Here is the call graph for this function:

BitPermUser::getPermissionLevels (  ) 

Definition at line 658 of file BitPermUser.php.

References mDb.

BitPermUser::getPermissionPackages (  ) 

Definition at line 663 of file BitPermUser.php.

References mDb.

BitPermUser::getUnassignedPerms (  ) 

Definition at line 510 of file BitPermUser.php.

References $query, and mDb.

BitPermUser::group_has_permission ( pGroupId,
perm 
)

Definition at line 677 of file BitPermUser.php.

References $query, $result, and mDb.

BitPermUser::groupExists ( pGroupName,
pUserId = ROOT_USER_ID 
)

Definition at line 119 of file BitPermUser.php.

References $query, $result, and mDb.

BitPermUser::hasPermission ( pPerm  ) 

Definition at line 525 of file BitPermUser.php.

References $ret, FALSE, BitUser::isAdmin(), and BitUser::isValid().

Referenced by assumeUser(), and getContentTypeList().

Here is the call graph for this function:

BitPermUser::isAdmin ( pCheckTicket = FALSE  ) 

Definition at line 520 of file BitPermUser.php.

References $ret.

BitPermUser::isInGroup ( pGroupMixed  ) 

Definition at line 187 of file BitPermUser.php.

References $ret, FALSE, BitUser::isAdmin(), BitUser::isValid(), and loadGroups().

Here is the call graph for this function:

BitPermUser::load ( pFull = FALSE,
pUserName = NULL 
)

load - loads all settings & preferences for this user

public

Author:
Chrstian Fowler <spider@steelsun.com>
Returns:
returnString

Reimplemented from BitUser.

Definition at line 65 of file BitPermUser.php.

References BitUser::load(), loadGroups(), loadPermissions(), and mUserId.

Referenced by store().

Here is the call graph for this function:

BitPermUser::loadGroups ( pForceRefresh = FALSE  ) 

Definition at line 181 of file BitPermUser.php.

References BitUser::getGroups(), and BitUser::isValid().

Referenced by isInGroup(), and load().

Here is the call graph for this function:

BitPermUser::loadPermissions (  ) 

Definition at line 495 of file BitPermUser.php.

References $query, BitUser::isValid(), mDb, and mUserId.

Referenced by load().

Here is the call graph for this function:

BitPermUser::remove_group ( pGroupId  ) 

Definition at line 278 of file BitPermUser.php.

References $query, $result, and mDb.

BitPermUser::removeLevelPermissions ( group,
level 
)

Definition at line 639 of file BitPermUser.php.

References $query, $res, $result, $ret, mDb, and removePermissionFromGroup().

Here is the call graph for this function:

BitPermUser::removePermissionFromGroup ( perm,
pGroupId 
)

Definition at line 691 of file BitPermUser.php.

References $query, $result, and mDb.

Referenced by removeLevelPermissions().

BitPermUser::removeUserFromGroup ( pUserId,
pGroupId 
)

Definition at line 404 of file BitPermUser.php.

References $query, $result, getDefaultGroup(), and mDb.

Here is the call graph for this function:

BitPermUser::sanitizeUserInfo (  ) 

Definition at line 77 of file BitPermUser.php.

References mInfo.

BitPermUser::setPermission ( pPerm,
pValue = NULL 
)

Definition at line 537 of file BitPermUser.php.

References BitUser::isAdmin(), and BitUser::isValid().

Here is the call graph for this function:

BitPermUser::store ( &$  pParamHash  ) 

Create a new content object or update an existing one

Parameters:
array Array of content data to be stored
See verify for details of the values required

Reimplemented from BitUser.

Definition at line 94 of file BitPermUser.php.

References $gBitSystem, $newUser, $pParamHash, addUserToGroup(), getDefaultGroup(), BitUser::isRegistered(), load(), BitUser::login(), mDb, mUserId, BitUser::store(), and storeGroup().

Here is the call graph for this function:

BitPermUser::storeGroup ( &$  pParamHash  ) 

Definition at line 438 of file BitPermUser.php.

References $_REQUEST, $gBitSystem, $gBitUser, $pParamHash, $result, $sql, mDb, and verifyGroup().

Referenced by store().

Here is the call graph for this function:

BitPermUser::storeRegistrationChoice ( groupList,
flag 
)

Definition at line 708 of file BitPermUser.php.

References $groupList, $mid, $query, $result, and mDb.

BitPermUser::storeUserDefaultGroup ( pUserId,
pGroupId 
)

Definition at line 337 of file BitPermUser.php.

References $query, and mDb.

Referenced by batch_set_user_default_group().

BitPermUser::verifyGroup ( &$  pParamHash  ) 

Definition at line 415 of file BitPermUser.php.

References $pParamHash, mUserId, and BitBase::verifyId().

Referenced by storeGroup().

Here is the call graph for this function:


Member Data Documentation

BitPermUser::$debug = false

Definition at line 33 of file BitPermUser.php.

BitPermUser::$groupperm_cache

Definition at line 35 of file BitPermUser.php.

BitPermUser::$usergroups_cache

Definition at line 34 of file BitPermUser.php.


The documentation for this class was generated from the following file:
Generated on Wed Aug 22 19:34:22 2007 for bitweaver by  doxygen 1.5.2