Class: BitPermUser

Source Location: d:\website\PhpDocumentor\/users/BitPermUser.php

Class Overview

BitBase
   |
   --LibertyBase
      |
      --LibertyContent
         |
         --LibertyAttachable
            |
            --BitUser
               |
               --BitPermUser

Class that holds all information for a given user

Author(s):

spider <spider@steelsun.com>

Version:

$Revision: 1.51 $

Variables

Methods

Inherited Variables

Inherited Methods

Class: BitUser

BitUser::BitUser(): Constructor - will automatically load all relevant data if passed a user string
BitUser::canCustomizeLayout()
BitUser::canCustomizeTheme()
BitUser::change_user_email()
BitUser::confirmRegistration()
BitUser::count_sessions()
BitUser::createTempPassword()
BitUser::defaults()
BitUser::expunge()
BitUser::expungeFavorite()
BitUser::expungeWatch()
BitUser::generateChallenge()
BitUser::genPass()
BitUser::getByHash()
BitUser::getDisplayLink()
BitUser::getDisplayName(): Get user information for a particular user
BitUser::getDisplayUrl()
BitUser::getEventWatches()
BitUser::getGroups()
BitUser::getList()
BitUser::getRenderFile(): Returns include file that will
BitUser::getTitle()
BitUser::getUserActivity()
BitUser::getUserAttachments()
BitUser::getUserFiles()
BitUser::getUserFromContentId()
BitUser::getUserId()
BitUser::getUserInfo()
BitUser::getWatches()
BitUser::get_event_watches()
BitUser::get_SMTP_response()
BitUser::get_users()
BitUser::get_users_names()
BitUser::get_watches_events()
BitUser::hasSemaphoreConflict()
BitUser::isAdmin()
BitUser::isPasswordDue()
BitUser::isRegistered()
BitUser::isSemaphoreSet()
BitUser::isValid()
BitUser::load(): load - loads all settings & preferences for this user
BitUser::login()
BitUser::logout()
BitUser::lookupHomepage()
BitUser::purgeAvatar()
BitUser::purgeImage()
BitUser::purgeLogo()
BitUser::purgePortrait()
BitUser::register(): register - will handle everything necessary for registering a user and sending appropriate emails, etc.
BitUser::remove_user_watch_by_hash()
BitUser::renewPassword()
BitUser::store()
BitUser::storeAvatar()
BitUser::storeFavorite()
BitUser::storeLogin()
BitUser::storeLogo()
BitUser::storePassword()
BitUser::storePortrait()
BitUser::storeRealName()
BitUser::storeSemaphore()
BitUser::storeWatch()
BitUser::updateSession()
BitUser::update_lastlogin()
BitUser::userExists()
BitUser::validate()
BitUser::verify()
BitUser::verifyCaptcha()
BitUser::verifyEmail()
BitUser::verifyPasswordFormat()
BitUser::verifyTicket()

Class: LibertyAttachable

LibertyAttachable::LibertyAttachable()
LibertyAttachable::cloneAttachment()
LibertyAttachable::detachAttachment(): detach attachment from content
LibertyAttachable::expunge()
LibertyAttachable::expungeAttachment(): expunge attachment from the database
LibertyAttachable::getAttachment(): load details of a given attachment allow an optional content_id to be passed in to ease legacy lib style objects (like blogs, articles, etc.)
LibertyAttachable::getAttachmentList(): Get a list of all available attachments
LibertyAttachable::getSiblingAttachments(): Get a list of attachments which also reference the foreign_id of the given attachment
LibertyAttachable::getStorageBranch(): getStorageBranch - get url to store files for the feature site_upload_dir. It creates a calculable hierarchy of directories
LibertyAttachable::getStoragePath(): getStoragePath - get path to store files for the feature site_upload_dir. It creates a calculable hierarchy of directories
LibertyAttachable::getStorageSubDirName()
LibertyAttachable::getStorageUrl()
LibertyAttachable::load(): fully load content and insert any attachments in $this->mStorage allow an optional content_id to be passed in to ease legacy lib style objects (like blogs, articles, etc.)
LibertyAttachable::scanForAttchmentUse(): This function will scan through liberty_content.data and will search for any occurrances of {attachemt id=<id>}
LibertyAttachable::store()
LibertyAttachable::verify(): verifyStorageFile - verify if a file exists

Class: LibertyContent

LibertyContent::LibertyContent(): Construct an empty LibertyBase object with a blank permissions array
LibertyContent::addHit(): Increment the content item hit flag by 1
LibertyContent::cacheUrl(): Cache given url If \c $data present (passed) it is just associated \c $url and \c $data.
LibertyContent::copyPermissions(): Copy current permissions to another object
LibertyContent::exportHtml(): Create an export object from the data
LibertyContent::expunge(): Delete content object and all related records
LibertyContent::expungeActionLog(): expungeActionLog
LibertyContent::expungeCacheFile(): Delete cache file for a given content item
LibertyContent::expungeComments(): Delete comment entries relating to the content object
LibertyContent::expungeVersion(): Removes a specific version of a page
LibertyContent::getActionLogs(): Get a list of action log entries
LibertyContent::getAuthorList(): Get a list of users who have created entries in the content table
LibertyContent::getCacheBasePath(): Get the path where we store liberty cached content
LibertyContent::getCacheFile(): Get the path to file where an individual cache item is stored
LibertyContent::getCachePath(): Get the path to directory where an individual cache item is stored
LibertyContent::getContentDescription(): Return content type description for this content object.
LibertyContent::getContentId(): Access a content item type GUID
LibertyContent::getContentList(): Get a list of all structures this content is a member of
LibertyContent::getContentRanking(): Get a list of content ranked by certain criteria set in $pListHash['sort_mode']
LibertyContent::getContentType(): Access a content item type GUID
LibertyContent::getContentTypeDescription()
LibertyContent::getDisplayLink(): Pure virtual function that returns link to display a piece of content
LibertyContent::getDisplayUrl(): Not-so-pure virtual function that returns Request_URI to a piece of content
LibertyContent::getFilter()
LibertyContent::getHistory(): Get complete set of historical data in order to display a given wiki page version
LibertyContent::getHistoryCount(): Get count of the number of historic records for the page
LibertyContent::getHits(): Get Hits and Last Hit
LibertyContent::getNumberOfPages(): Special parsing for multipage articles
LibertyContent::getPage(): Special parsing for a particular page of a multipage article
LibertyContent::getPreference(): Returns the content preferences value for the passed in key.
LibertyContent::getRenderFile(): Pure virtual function that returns the include file that should render a page of content of this type
LibertyContent::getServicesSql(): Set up SQL strings for services used by the object
LibertyContent::getStructures(): Get a list of all structures this content is a member of
LibertyContent::getThumbnailUrl(): Not-so-pure virtual function that returns Request_URI to a content's thumbnail representation. It is up to the derived content what exactly this means If not implemented in the content's class, this class will return NULL, which is an acceptable case meaning no thumbnail is available.
LibertyContent::getTitle(): Create the generic title for a content item
LibertyContent::getUserPermissions(): Get specific permissions for the specified user for this content
LibertyContent::hasAdminPermission(): Determine if current user has the ability to administer this type of content
LibertyContent::hasEditPermission(): Determine if current user has the ability to edit this type of content
LibertyContent::hasPermission(): Check is a user has permission to access the object
LibertyContent::hasUserPermission(): Function that determines if this content specified permission for the current gBitUser
LibertyContent::invokeServices(): Set up access to services used by the object
LibertyContent::isAdminable(): Check permissions to establish if user has permission to admin the object
LibertyContent::isCached(): Check if given url is currently cached locally
LibertyContent::isContentType(): Check user_id to establish if the object that has been loaded was created by the current user
LibertyContent::isEditable(): Check permissions to establish if user has permission to edit the object
LibertyContent::isHidden()
LibertyContent::isInStructure(): Check the number of structures that the content object is being used in
LibertyContent::isOwner(): Check user_id to establish if the object that has been loaded was created by the current user
LibertyContent::isPrivate()
LibertyContent::isProtected()
LibertyContent::isValid(): Check mContentId to establish if the object has been loaded with a valid record
LibertyContent::isViewable(): Check permissions to establish if user has permission to view the object
LibertyContent::load(): Assume a derived class has joined on the liberty_content table, and loaded it's columns already.
LibertyContent::loadAllObjectPermissions(): Load all permissions assigned to a given object. This is not for general consumption.
LibertyContent::loadPermissions(): Check permissions for the object that has been loaded against the permission database
LibertyContent::loadPreferences()
LibertyContent::pageExists(): Determines if a wiki page (row in wiki_pages) exists, and returns a hash of important info. If N pages exists with $pPageName, returned existsHash has a row for each unique pPageName row.
LibertyContent::parseData(): Process the raw content blob using the speified content GUID processor
LibertyContent::postGetList(): Updates results from any getList function to provide the control set
LibertyContent::registerContentType(): Copy current permissions to another object
LibertyContent::removeLastVersion(): Removes last version of the page (from pages) if theres some
LibertyContent::removePermission(): Remove a permission to access the object
LibertyContent::rollbackVersion(): Roll back to a specific version of a page
LibertyContent::setHits(): Set Hits and Last Hit
LibertyContent::setIndexData(): This is a generic liberty content function to gather indexable words. Override this function in your BitPackage.php file if you need to add more indexable words from files other than tiki_content and users_users.
LibertyContent::setPreference(): Set a hash value in the mPrefs hash. This does *NOT* store the value in the database. It does no checking for existing or duplicate values. the main point of this function is to limit direct accessing of the mPrefs hash. I will probably make mPrefs private one day.
LibertyContent::setStructure(): Set content related mStructureId
LibertyContent::store(): Create a new content object or update an existing one
LibertyContent::storeActionLog(): storeActionLog Note: use $gBitSystem throughout that this function can be called statically if needed
LibertyContent::storeHistory()
LibertyContent::storePermission(): Store a permission for the object that has been loaded in the permission database
LibertyContent::storePreference(): Saves a preference to the liberty_content_prefs database table with the given pref name and value. If the value is NULL, the existing value will be delete and the value will not be saved. However, a zero will be stored. This will update the mPrefs hash.
LibertyContent::updateUserPermissions(): This function will replace all permissions for a particular package with the ones set using the content permissions
LibertyContent::verify(): Verify the core class data required to update the liberty_content table entries
LibertyContent::verifyAccessControl(): Check permissions to establish if user has permission to access the object
LibertyContent::verifyActionLog(): verify the data in the action log is ready for storing First checks $pParamHash['action_log'] for information and then the content_store stuff Note: use $gBitSystem throughout that this function can be called statically if needed

Class: LibertyBase

LibertyBase::LibertyBase(): Constructor building on BitBase object
LibertyBase::getLibertyObject(): Given a content_id, this will return and object of the proper type

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::debug(): Switch debug level in database
BitBase::display(): This method should be THE method used to display a template. php files should not access $gBitSmarty directly.
BitBase::getDb(): Return pointer to current Database
BitBase::getField(): Returns entry from the mInfo hash if field exists
BitBase::isDatabaseValid(): Determines if there is a valide database connection
BitBase::prepGetList(): Prepares parameters with default values for any getList function
BitBase::setDatabase(): Sets database mechanism for the instance
BitBase::verifyId(): Determines if any given variable exists and is a number

Class Details

[line 32]
Class that holds all information for a given user

Tags:

version:	$Revision: 1.51 $
author:	spider <spider@steelsun.com>

[ Top ]

Class Variables

$debug = false

[line 35]

Type:

mixed

[ Top ]

$groupperm_cache =

[line 37]

Type:

mixed

[ Top ]

$usergroups_cache =

[line 36]

Type:

mixed

[ Top ]

Class Methods

constructor BitPermUser [line 39]

BitPermUser BitPermUser(
[
$pUserId = NULL], [
$pContentId = NULL])

Parameters:

	$pUserId
	$pContentId

[ Top ]

method addGroupInclusion [line 361]

void addGroupInclusion(

$pGroupId, 
$pIncludeId)

Parameters:

	$pGroupId
	$pIncludeId

[ Top ]

method addUserToGroup [line 443]

Either addUserToGroup(
pUserId
$pUserId, pGroupMixed
$pGroupMixed)

Adds user pUserId to group(s) pGroupMixed.

Tags:

return:

an ADO RecordSet (success) or false (failure).

Parameters:

pUserId	$pUserId	numerical user id
pGroupMixed	$pGroupMixed	either a numerical group id or an array of group ids.

[ Top ]

method assignPermissionToGroup [line 848]

void assignPermissionToGroup(

$perm, 
$pGroupId)

Parameters:

	$perm
	$pGroupId

[ Top ]

method assign_level_permissions [line 795]

void assign_level_permissions(

$pGroupId, 
$level, [
$pPackage = NULL])

Parameters:

	$pGroupId
	$level
	$pPackage

[ Top ]

method assign_object_permission [line 702]

void assign_object_permission(

$pGroupId, 
$object_id, 
$object_type, 
$perm_name)

Parameters:

	$pGroupId
	$object_id
	$object_type
	$perm_name

[ Top ]

method assumeUser [line 46]

void assumeUser(

$pUserId)

Parameters:

$pUserId

[ Top ]

method batchAssignUsersToGroup [line 410]

void batchAssignUsersToGroup(

$pGroupId)

Parameters:

$pGroupId

[ Top ]

method batch_set_user_default_group [line 420]

void batch_set_user_default_group(

$pGroupId)

Parameters:

$pGroupId

[ Top ]

method change_permission_level [line 786]

void change_permission_level(

$perm, 
$level)

Parameters:

	$perm
	$level

[ Top ]

method copy_object_permissions [line 744]

void copy_object_permissions(

$object_id, 
$destinationObjectId, 
$object_type)

Parameters:

	$object_id
	$destinationObjectId
	$object_type

[ Top ]

method countGroupUsers [line 558]

void countGroupUsers(

$pGroupId)

Parameters:

$pGroupId

[ Top ]

method create_dummy_level [line 827]

void create_dummy_level(

$level)

Parameters:

$level

[ Top ]

method expunge [line 148]

TRUE expunge(
)

removes user and associated private data

Tags:

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

Overrides BitUser::expunge() (parent method not documented)

[ Top ]

method getAllGroups [line 204]

void getAllGroups(

&$pListHash)

Parameters:

&$pListHash

[ Top ]

method getAllUserGroups [line 261]

void getAllUserGroups(
[
$pUserId = NULL])

Parameters:

$pUserId

[ Top ]

method getContentTypeList [line 884]

void getContentTypeList(

$pUserId)

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

Parameters:

$pUserId

[ Top ]

method getDefaultGroup [line 379]

void getDefaultGroup(
[
$pGroupId = NULL])

Parameters:

$pGroupId

[ Top ]

method getGroupHome [line 394]

void getGroupHome(

$pGroupId)

Parameters:

$pGroupId

[ Top ]

method getGroupInfo [line 427]

void getGroupInfo(

$pGroupId)

Parameters:

$pGroupId

[ Top ]

method getGroupPermissions [line 650]

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

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

[ Top ]

method getGroups [line 321]

void getGroups(
[
$pUserId = NULL], [
$pForceRefresh = FALSE])

Overrides BitUser::getGroups() (parent method not documented)

Parameters:

	$pUserId
	$pForceRefresh

[ Top ]

method getGroupUserData [line 538]

void getGroupUserData(

$pGroupId, 
$pColumns)

Parameters:

	$pGroupId
	$pColumns

[ Top ]

method getIncludedGroups [line 345]

void getIncludedGroups(

$pGroupId, 
&$pIncludes)

Parameters:

	$pGroupId
	&$pIncludes

[ Top ]

method getPermissionLevels [line 838]

void getPermissionLevels(
)

[ Top ]

method getPermissionPackages [line 843]

void getPermissionPackages(
)

[ Top ]

method getUnassignedPerms [line 601]

void getUnassignedPerms(
)

[ Top ]

method get_group_users [line 389]

void get_group_users(

$pGroupId)

Parameters:

$pGroupId

[ Top ]

method get_object_permissions [line 759]

void get_object_permissions(

$object_id, 
$object_type)

Parameters:

	$object_id
	$object_type

[ Top ]

method get_user_id [line 272]

void get_user_id(

$pUserName)

Parameters:

$pUserName

[ Top ]

method groupExists [line 118]

void groupExists(

$pGroupName, [
$pUserId = ROOT_USER_ID])

Parameters:

	$pGroupName
	$pUserId

[ Top ]

method group_has_permission [line 859]

void group_has_permission(

$pGroupId, 
$perm)

Parameters:

	$pGroupId
	$perm

[ Top ]

method hasPermission [line 616]

void hasPermission(

$pPerm)

Overrides LibertyContent::hasPermission() (Check is a user has permission to access the object)

Parameters:

$pPerm

[ Top ]

method isAdmin [line 611]

void isAdmin(
[
$pCheckTicket = FALSE])

Overrides BitUser::isAdmin() (parent method not documented)

Parameters:

$pCheckTicket

[ Top ]

method isInGroup [line 186]

void isInGroup(

$pGroupMixed)

Parameters:

$pGroupMixed

[ Top ]

method load [line 64]

void load(
[
$pFull = FALSE], [
$pUserName = NULL])

Overrides BitUser::load() (load - loads all settings & preferences for this user)

Parameters:

	$pFull
	$pUserName

[ Top ]

method loadGroups [line 180]

void loadGroups(
[
$pForceRefresh = FALSE])

Parameters:

$pForceRefresh

[ Top ]

method loadPermissions [line 568]

void loadPermissions(
)

Overrides LibertyContent::loadPermissions() (Check permissions for the object that has been loaded against the permission database)

[ Top ]

method object_has_one_permission [line 775]

void object_has_one_permission(

$object_id, 
$object_type)

Parameters:

	$object_id
	$object_type

[ Top ]

method object_has_permission [line 714]

void object_has_permission(
[
$pUserId = NULL], 
$object_id, 
$object_type, 
$perm_name, [
$pForceRefresh = FALSE])

Parameters:

	$pUserId
	$object_id
	$object_type
	$perm_name
	$pForceRefresh

[ Top ]

method removeGroupInclusions [line 369]

void removeGroupInclusions(

$pGroupId)

Parameters:

$pGroupId

[ Top ]

method removeUserFromGroup [line 467]

void removeUserFromGroup(

$pUserId, 
$pGroupId)

Parameters:

	$pUserId
	$pGroupId

[ Top ]

method remove_group [line 308]

void remove_group(

$pGroupId)

Parameters:

$pGroupId

[ Top ]

method remove_level_permissions [line 815]

void remove_level_permissions(

$group, 
$level)

Parameters:

	$group
	$level

[ Top ]

method remove_object_permission [line 733]

void remove_object_permission(

$pGroupId, 
$object_id, 
$object_type, 
$perm_name)

Parameters:

	$pGroupId
	$object_id
	$object_type
	$perm_name

[ Top ]

method remove_permission_from_group [line 873]

void remove_permission_from_group(

$perm, 
$pGroupId)

Parameters:

	$perm
	$pGroupId

[ Top ]

method sanitizeUserInfo [line 76]

void sanitizeUserInfo(
)

[ Top ]

method setPermission [line 628]

void setPermission(

$pPerm, [
$pValue = NULL])

Parameters:

	$pPerm
	$pValue

[ Top ]

method store [line 93]

void store(

&$pParamHash)

Overrides BitUser::store() (parent method not documented)

Parameters:

&$pParamHash

[ Top ]

method storeGroup [line 501]

void storeGroup(

&$pParamHash)

Parameters:

&$pParamHash

[ Top ]

method storeRegistrationChoice [line 892]

void storeRegistrationChoice(

$groupList, 
$flag)

Parameters:

	$groupList
	$flag

[ Top ]

method storeUserDefaultGroup [line 404]

void storeUserDefaultGroup(

$pUserId, 
$pGroupId)

Parameters:

	$pUserId
	$pGroupId

[ Top ]

method verifyGroup [line 478]

void verifyGroup(

&$pParamHash)

Parameters:

&$pParamHash

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:32:01 +0000 by phpDocumentor 1.3.0