Class: BitUser

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

Class Overview

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

Class that holds all information for a given user

Author(s):

spider <spider@steelsun.com>

Version:

$Revision: 1.121 $

Child classes:

BitPermUser: Class that holds all information for a given user

Inherited Variables

Inherited Methods

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 47]
Class that holds all information for a given user

Tags:

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

[ Top ]

Class Variables

$mAuth =

[line 53]

Type:

mixed

[ Top ]

$mGroups =

[line 50]

Type:

mixed

[ Top ]

$mInfo =

[line 51]

Type:	mixed
Overrides:	Array

[ Top ]

$mTicket =

[line 52]

Type:

mixed

[ Top ]

$mUserId =

[line 48]

Type:

mixed

[ Top ]

$mUsername =

[line 49]

Type:

mixed

[ Top ]

Class Methods

constructor BitUser [line 62]

returnString BitUser(
[
$pUserId = NULL], [
$pContentId = NULL])

Constructor - will automatically load all relevant data if passed a user string

Tags:

author:	Christian Fowler <spider@viovio.com>
access:	public

Parameters:

	$pUserId
	$pContentId

[ Top ]

method canCustomizeLayout [line 1127]

void canCustomizeLayout(
)

[ Top ]

method canCustomizeTheme [line 1119]

void canCustomizeTheme(
)

[ Top ]

method change_user_email [line 925]

void change_user_email(

$pUserId, 
$pUsername, 
$pEmail, 
$pPass)

Parameters:

	$pUserId
	$pUsername
	$pEmail
	$pPass

[ Top ]

method confirmRegistration [line 916]

void confirmRegistration(

$pUserId, 
$pProvpass)

Parameters:

	$pUserId
	$pProvpass

[ Top ]

method count_sessions [line 225]

void count_sessions(
)

[ Top ]

method createTempPassword [line 1006]

void createTempPassword(

$pLogin, 
$pPass)

Parameters:

	$pLogin
	$pPass

[ Top ]

method defaults [line 156]

void defaults(
)

[ Top ]

method expunge [line 655]

void expunge(
)

Overridden in child classes as:

BitPermUser::expunge(): removes user and associated private data

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

[ Top ]

method expungeFavorite [line 1294]

void expungeFavorite(

$pContentId)

Parameters:

$pContentId

[ Top ]

method expungeWatch [line 1376]

void expungeWatch(

$event, 
$object)

Parameters:

	$event
	$object

[ Top ]

method generateChallenge [line 717]

void generateChallenge(
)

[ Top ]

method genPass [line 697]

void genPass(
[
$pLength = NULL])

Parameters:

$pLength

[ Top ]

method getByHash [line 978]

void getByHash(

$hash)

Parameters:

$hash

[ Top ]

method getDisplayLink [line 1423]

void getDisplayLink(

$pUserName, 
$pDisplayHash)

Overrides LibertyContent::getDisplayLink() (Pure virtual function that returns link to display a piece of content)

Parameters:

	$pUserName
	$pDisplayHash

[ Top ]

method getDisplayName [line 1438]

display getDisplayName(
[pUseLink
$pUseLink = FALSE], [pHash
$pHash = NULL])

Get user information for a particular user

Tags:

return:

name or link to user information page

Parameters:

pUseLink	$pUseLink	return the information in the form of a url that links to the users information page
pHash	$pHash	todo - need explanation on how to use this...

[ Top ]

method getDisplayUrl [line 1399]

void getDisplayUrl(
[
$pUserName = NULL], [
$pMixed = NULL])

Overrides LibertyContent::getDisplayUrl() (Not-so-pure virtual function that returns Request_URI to a piece of content)

Parameters:

	$pUserName
	$pMixed

[ Top ]

method getEventWatches [line 1340]

void getEventWatches(

$event, 
$object)

Parameters:

	$event
	$object

[ Top ]

method getGroups [line 1598]

void getGroups(
)

Overridden in child classes as:

BitPermUser::getGroups()

[ Top ]

method getList [line 1517]

void getList(

&$pParamHash)

Parameters:

&$pParamHash

[ Top ]

method getRenderFile [line 1489]

the getRenderFile(
)

Returns include file that will

Tags:

return:

fully specified path to file to be included

Overrides LibertyContent::getRenderFile() (Pure virtual function that returns the include file that should render a page of content of this type)

[ Top ]

method getTitle [line 1427]

void getTitle(
[
$pHash = NULL])

void getUserFiles(
)

[ Top ]

method getUserFromContentId [line 965]

void getUserFromContentId(

$content_id)

Parameters:

$content_id

[ Top ]

method getUserId [line 1395]

void getUserId(
)

[ Top ]

method getUserInfo [line 954]

void getUserInfo(

$pUserMixed)

Parameters:

$pUserMixed

[ Top ]

method getWatches [line 1318]

void getWatches(
[
$pEvent = ''])

Parameters:

$pEvent

[ Top ]

method get_event_watches [line 1353]

void get_event_watches(

$event, 
$object)

Parameters:

	$event
	$object

[ Top ]

method get_SMTP_response [line 381]

void get_SMTP_response(

&$pConnect)

Parameters:

&$pConnect

[ Top ]

method get_users [line 1047]

void get_users(
[
$offset = 0], [
$max_records = -1], [
$sort_mode = 'login_desc'], [
$find = ''])

Parameters:

	$offset
	$max_records
	$sort_mode
	$find

[ Top ]

method get_users_names [line 897]

void get_users_names(
[
$offset = 0], [
$max_records = -1], [
$sort_mode = 'login_desc'], [
$find = ''])

Parameters:

	$offset
	$max_records
	$sort_mode
	$find

[ Top ]

method get_watches_events [line 1384]

void get_watches_events(
)

[ Top ]

method hasSemaphoreConflict [line 1566]

void hasSemaphoreConflict(

$pSemName, 
$pLimit)

Parameters:

	$pSemName
	$pLimit

[ Top ]

method isAdmin [line 262]

void isAdmin(
)

Overridden in child classes as:

BitPermUser::isAdmin()

[ Top ]

method isPasswordDue [line 984]

void isPasswordDue(
)

[ Top ]

method isRegistered [line 254]

void isRegistered(
)

[ Top ]

method isSemaphoreSet [line 1555]

void isSemaphoreSet(

$pSemName, 
$pLimit)

Parameters:

	$pSemName
	$pLimit

[ Top ]

method isValid [line 258]

void isValid(
)

Overrides LibertyContent::isValid() (Check mContentId to establish if the object has been loaded with a valid record)

[ Top ]

method load [line 83]

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

load - loads all settings & preferences for this user

Tags:

author:	Chrstian Fowler <spider@steelsun.com>
access:	public

Overridden in child classes as:

BitPermUser::load()

Overrides 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.))

Parameters:

	$pFull
	$pUserName

[ Top ]

method login [line 721]

void login(

$pLogin, 
$pPassword, [
$pChallenge = NULL], [
$pResponse = NULL])

Parameters:

	$pLogin
	$pPassword
	$pChallenge
	$pResponse

[ Top ]

method logout [line 231]

void logout(
)

[ Top ]

method lookupHomepage [line 934]

void lookupHomepage(

$iHomepage)

Parameters:

$iHomepage

[ Top ]

method purgeAvatar [line 1240]

void purgeAvatar(
)

[ Top ]

method purgeImage [line 1220]

void purgeImage(

$pType)

Parameters:

$pType

[ Top ]

method purgeLogo [line 1245]

void purgeLogo(
)

[ Top ]

method purgePortrait [line 1235]

void purgePortrait(
)

[ Top ]

method register [line 505]

returnString register(

&$pParamHash)

Tags:

author:	Christian Fowler<spider@viovio.com>
access:	public

Parameters:

&$pParamHash

[ Top ]

method remove_user_watch_by_hash [line 1370]

void remove_user_watch_by_hash(

$hash)

Parameters:

$hash

[ Top ]

method renewPassword [line 999]

void renewPassword(

$pLogin)

Parameters:

$pLogin

[ Top ]

method store [line 599]

void store(

&$pParamHash)

Overridden in child classes as:

BitPermUser::store()

void storePassword(

$pPass, [
$pLogin = NULL])

Parameters:

	$pPass
	$pLogin

[ Top ]

method storePortrait [line 1136]

void storePortrait(

&$pStorageHash, [
$pGenerateAvatar = FALSE])

Parameters:

	&$pStorageHash
	$pGenerateAvatar

[ Top ]

method storeRealName [line 1493]

void storeRealName(

$newRealName)

Parameters:

$newRealName

[ Top ]

method storeSemaphore [line 1583]

void storeSemaphore(

$pSemName)

Parameters:

$pSemName

[ Top ]

method storeWatch [line 1305]

void storeWatch(

$event, 
$object, 
$type, 
$title, 
$url)

Parameters:

	$event
	$object
	$type
	$title
	$url

[ Top ]

method updateSession [line 181]

void updateSession(

$pSessionId)

Parameters:

$pSessionId

[ Top ]

method update_lastlogin [line 885]

void update_lastlogin(

$pUserId)

Parameters:

$pUserId

[ Top ]

method userExists [line 1602]

void userExists(

$pUserMixed)

Parameters:

$pUserMixed

[ Top ]

method validate [line 792]

void validate(

$user, 
$pass, 
$challenge, 
$response)

Parameters:

	$user
	$pass
	$challenge
	$response

[ Top ]

method verify [line 280]

void verify(

&$pParamHash)

Overrides LibertyAttachable::verify() (verifyStorageFile - verify if a file exists)

Parameters:

&$pParamHash

[ Top ]

method verifyCaptcha [line 585]

void verifyCaptcha(
[
$pCaptcha = NULL])

Parameters:

$pCaptcha

[ Top ]

method verifyEmail [line 394]

void verifyEmail(

$pEmail, [
$pValidate = FALSE])

Parameters:

	$pEmail
	$pValidate

[ Top ]

method verifyPasswordFormat [line 363]

void verifyPasswordFormat(

$pPassword, [
$pPassword2 = NULL])

Parameters:

	$pPassword
	$pPassword2

[ Top ]

method verifyTicket [line 267]

void verifyTicket(
[
$pFatalOnError = TRUE])

Parameters:

$pFatalOnError

[ Top ]

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