Docs For Class BitUser

Class: LibertyMime

LibertyMime::addDownloadHit(): Increment the item hit flag by 1
LibertyMime::getThumbnailUrl(): getThumbnailUrl will fetch the primary thumbnail for a given content. If nothing has been set, it will fetch the last thumbnail it can find.
LibertyMime::load(): load the attachments for a given content id and then stuff them in mStorage
LibertyMime::pluginStore(): pluginStore will use a given plugin to store uploaded file data
LibertyMime::store(): Store a new upload
LibertyMime::updateAttachmentParams(): updateAttachmentParams will update attachment parameters
LibertyMime::verify(): Verify content that is about to be stored
LibertyMime::verifyAttachment(): verifyAttachment will perform a generic check if a file is valid for processing

Class: LibertyContent

LibertyContent::__construct(): Construct an empty LibertyBase object with a blank permissions array
LibertyContent::addHit(): Increment the content item hit flag by 1
LibertyContent::checkContentPermission(): Check is a user has permission to access the object
LibertyContent::convertQueryHash(): Convert a built up pQueryHash into a single query string and set of bind variables.
LibertyContent::exportHash(): Create an export hash from the data
LibertyContent::exportList()
LibertyContent::expunge(): Delete content object and all related records
LibertyContent::expungeComments(): Delete comment entries relating to the content object
LibertyContent::expungeContentPermissions(): Expunge Content Permissions
LibertyContent::expungeVersion(): Removes a specific version of a page
LibertyContent::generateDescription(): Attempt to create a brief description of this object, most useful for <meta name="description" />
LibertyContent::generateKeywords(): Attempt to create a collection of relevant words about this object, most useful for <meta name="keywords" />
LibertyContent::getAliases(): Get array of aliases for this content object
LibertyContent::getCacheKey()
LibertyContent::getContentDescription(): Return content type description for this content object.
LibertyContent::getContentId(): Access a content item content_id
LibertyContent::getContentListPermissionsSql(): getContentListPermissionsSql
LibertyContent::getContentPermissionsList(): Load all permissions assigned to a given object.
LibertyContent::getContentPermissionsSql(): getContentPermissionsSql
LibertyContent::getContentType(): Access a content item type GUID
LibertyContent::getContentTypeDescription(): getContentTypeDescription
LibertyContent::getContentTypeName(): Get the display name of the content type
LibertyContent::getContentWithPermissionsList(): Get a list of content with permissions
LibertyContent::getDisplayLink(): Pure virtual function that returns link to display a piece of content
LibertyContent::getDisplayUri(): Not-so-pure virtual function that returns fully qualified URI to a piece of content
LibertyContent::getDisplayUriFromHash(): Not-so-pure virtual function that returns fully qualified URI to a piece of content
LibertyContent::getDisplayUrlFromHash(): Not-so-pure virtual function that returns Request_URI to a piece of content
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::getLibertySql(): Default liberty sql for joining a content object table to liberty.
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::getServicesSql2(): getServicesSql2
LibertyContent::getTitle(): Create the generic title for a content item
LibertyContent::getTitleFromHash(): Create the generic title for a content item
LibertyContent::getUserPermissions(): Get specific permissions for the specified user for this content
LibertyContent::getViewTemplate(): returns a path to the template type requested this is intended for package override. while not a requirement please use a naming convention of center_<action>_<content_type_guid>.tpl for new tpls
LibertyContent::hasAdminPermission(): Determine if current user has the ability to administer this type of content
LibertyContent::hasCreatePermission(): Determine if current user has the ability to craete this type of content
LibertyContent::hasEditPermission(): Deprecated, use hasUpdatePermission
LibertyContent::hasExpungePermission(): Determine if current user has the ability to delete/expunge this type of content
LibertyContent::hasPostCommentsPermission(): Determine if current user has the ability to post comments to this type of content
LibertyContent::hasService(): check if a service is active for this content type
LibertyContent::hasUpdatePermission(): Determine if current user has the ability to edit this type of content
LibertyContent::hasUserPermission(): Function that determines if this content specified permission for the current gBitUser.
LibertyContent::hasUserPermissions(): Check to see if the loaded content has individually assigned permissions
LibertyContent::hasViewPermission(): Determine if current user has the ability to view this type of content Note that this will always return TRUE if you haven't set the mViewContentPerm in your class
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::isCacheableClass()
LibertyContent::isCacheableObject()
LibertyContent::isContentType(): Check if content matches content type GUID - must also be a valid content object, it will not work for generic content class
LibertyContent::isEditable(): Check permissions to establish if user has permission to edit the object
LibertyContent::isExcludedPermission(): Check to see if this permission is already in the global permissions table.
LibertyContent::isOwner(): Check user_id to establish if the object that has been loaded was created by the current user
LibertyContent::isServiceRequired(): check if a service is required for this content type
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(): load Assume a derived class has joined on the liberty_content table, and loaded it's columns already.
LibertyContent::loadPreferences(): loadPreferences of the currently loaded object or pass in to get preferences of a specific content_id
LibertyContent::registerContentType(): Register the content type for reference
LibertyContent::removeLastVersion(): Removes last version of the page (from pages) if theres some version in the liberty_content_history then the last version becomes the actual version
LibertyContent::removePermission(): Remove a permission to access the content
LibertyContent::rollbackVersion(): Roll back to a specific version of a page
LibertyContent::setHits(): Set Hits and Last Hit
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::store(): Create a new content object or update an existing one
LibertyContent::storeAliases(): storeAliases will store aliases to a given content item
LibertyContent::storeHistory(): storeHistory will store the previous data into the history table for reference
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::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::verifyAdminPermission(): This code was duplicated _EVERYWHERE_ so here is an easy template to cut that down.
LibertyContent::verifyCreatePermission(): Determine if current user has the ability to create this type of content Note this will always return FALSEif the content isValid
LibertyContent::verifyEditPermission(): Deprecated, use verifyUpdatePermission
LibertyContent::verifyExpungePermission(): It will verify if a given user has a given $permission and if not, it will display the error template and die()
LibertyContent::verifyPostCommentsPermission(): It will verify if a given user has a given $permission and if not, it will display the error template and die()
LibertyContent::verifyUpdatePermission(): This code was duplicated _EVERYWHERE_ so here is an easy template to cut that down.
LibertyContent::verifyUserPermission(): Function that determines if this content specified permission for the current gBitUser, and will throw a fatal error if not.
LibertyContent::verifyViewPermission(): This code was duplicated _EVERYWHERE_ so here is an easy template to cut that down.

Class: LibertyBase

LibertyBase::__construct(): Constructor building on BitBase object
LibertyBase::getLibertyClass(): given a content_type_guid this will return an object of the proper type
LibertyBase::getLibertyObject(): Given a content_id, this will return and object of the proper type
LibertyBase::getNewObject(): Simple method to create a given class with a specified content_id. The purpose of a method is to allow for derived classes to override as necessary.
LibertyBase::getNewObjectById(): Simple method to create a given class with a specified primary_id. The purpose of a method is to allow for derived classes to override as necessary.

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::__construct()
BitBase::clearFromCache()
BitBase::expunge(): Delete content object and all related records
BitBase::load()
BitBase::__destruct()

static method getDisplayNameFromHash [line 2373]

static display getDisplayNameFromHash(
[pUseLink
$pUseLink = FALSE], pHash
$pHash)

Get user information for a particular user

Tags:

return:	name or link to user information page
access:	public

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 ]

static method getDisplayUrlFromHash [line 2320]

static URL getDisplayUrlFromHash(

&$pParamHash, array
$pUserName, array
$pMixed)

getDisplayUrl

Tags:

return:	to users homepage
access:	public

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

Parameters:

array	$pUserName
array	$pMixed
	&$pParamHash

[ Top ]

static method getSiteCookieName [line 1200]

static void getSiteCookieName(
)

Tags:

access:

public

[ Top ]

static method getSortModeFields [line 102]

static array getSortModeFields(
)

Validate inbound sort_mode parameter

Tags:

return:	of fields which are valid sorts
access:	public

[ Top ]

static method getUserObject [line 2757]

static void getUserObject(

$pUserId)

Tags:

access:

public

Parameters:

$pUserId

[ Top ]

static method getUserPreference [line 1598]

static TRUE getUserPreference(
array
$pPrefName, array
$pPrefDefault, array
$pUserId)

getUserPreference

Tags:

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

Parameters:

array	$pPrefName
array	$pPrefDefault
array	$pUserId

[ Top ]

static method isCacheableClass [line 86]

static void isCacheableClass(
)

Tags:

access:

public

Overrides LibertyContent::isCacheableClass() (parent method not documented)

[ Top ]

static method userCollection [line 2741]

static $pReturn userCollection(
array
$pInput, 
&$pReturn, array
$pReturn)

userCollection

Tags:

access:

public

Parameters:

array	$pInput
array	$pReturn
	&$pReturn

[ Top ]

static method verifyAnonEmail [line 530]

static TRUE verifyAnonEmail(
array
$pEmail, 
&$pErrors)

verifyAnonEmail

Tags:

return:	on success, FALSE on failure, or -1 if verifyMX had a connection failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pEmail
	&$pErrors

[ Top ]

constructor BitUser [line 59]

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 answerCaptcha [line 387]

void answerCaptcha(

$pParamHash)

answerCaptcha

Determine if the submitted answer for the captcha is valid

Parameters:

$pParamHash

[ Top ]

method ban [line 1236]

TRUE ban(
)

ban sets the user account status to -201 suspended

Tags:

return:	on success, Display error message on failure
access:	public

[ Top ]

method canCustomizeLayout [line 1887]

TRUE canCustomizeLayout(
)

canCustomizeLayout check if a user can customise their layout

Tags:

return:	on success, FALSE on failure
access:	public

[ Top ]

method canCustomizeTheme [line 1876]

TRUE canCustomizeTheme(
)

canCustomizeTheme check if a user can customise their theme

Tags:

return:	on success, FALSE on failure
access:	public

[ Top ]

method changeUserEmail [line 1544]

TRUE changeUserEmail(
array
$pUserId, array
$pEmail)

changeUserEmail

Tags:

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

Parameters:

array	$pUserId
array	$pEmail

[ Top ]

method confirmRegistration [line 1528]

registered confirmRegistration(
array
$pUserId, array
$pProvpass)

confirmRegistration

Tags:

return:	user, empty array on failure
access:	public

Parameters:

array	$pUserId
array	$pProvpass

[ Top ]

method countSessions [line 1144]

count countSessions(
[array
$pActive = FALSE])

countSessions

Tags:

return:	of sessions
access:	public

Parameters:

array

$pActive

[ Top ]

method createTempPassword [line 1707]

TRUE createTempPassword(
array
$pLogin, array
$pPass)

createTempPassword

Tags:

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

Parameters:

array	$pLogin
array	$pPass

[ Top ]

method defaults [line 226]

void defaults(
)

defaults set a default set of preferences in mPrefs for new users

Tags:

access:

public

[ Top ]

method exportHash [line 2711]

export exportHash(
)

Create an export hash from the data

Tags:

return:	data
access:	public

Overrides LibertyContent::exportHash() (Create an export hash from the data)

[ Top ]

method expunge [line 1039]

TRUE expunge(
[
$pExpungeContent = NULL])

expunge removes user and associated private data

Tags:

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

Overridden in child classes as:

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

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

Overrides LibertyContent::expunge() (Delete content object and all related records)

Parameters:

$pExpungeContent

[ Top ]

method expungeFavorite [line 2266]

void expungeFavorite(

$pContentId)

Parameters:

$pContentId

[ Top ]

method expungeWatch [line 2210]

TRUE expungeWatch(
array
$pEvent, array
$pObject)

expungeWatch

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array	$pEvent
array	$pObject

[ Top ]

method generateChallenge [line 1290]

md5 generateChallenge(
)

generateChallenge

Tags:

return:	string
access:	public

[ Top ]

method genPass [line 1266]

password genPass(
[array
$pLength = NULL])

genPass generate random password

Tags:

access:

public

Parameters:

array

$pLength

Length of final password

[ Top ]

method getCacheKey [line 77]

void getCacheKey(
)

Tags:

access:

public

Overrides LibertyContent::getCacheKey() (parent method not documented)

[ Top ]

method getDisplayLink [line 2348]

get getDisplayLink(
[
$pLinkText = NULL], [
$pMixed = NULL], [
$pAnchor = NULL], array
$pUserName, array
$pDisplayHash)

getDisplayLink

Tags:

return:	a link to the the users homepage
access:	public

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

Parameters:

array	$pUserName
array	$pDisplayHash
	$pLinkText
	$pMixed
	$pAnchor

[ Top ]

method getDisplayName [line 2427]

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 getDomain [line 1861]

TRUE getDomain(
array
$pContentId)

getDomain

Tags:

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

Parameters:

array

$pContentId

[ Top ]

method getEventWatches [line 2153]

TRUE getEventWatches(
array
$pEvent, 
$pObject, array
$object)

getEventWatches

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array	$pEvent
array	$object
	$pObject

[ Top ]

method getFavorites [line 2290]

Array getFavorites(
)

getFavorites

Tags:

return:	of content data
see:	LibertyContent::getContentList

[ Top ]

method getList [line 2472]

array getList(

&$pParamHash, array
$pParamHash)

getList get a list of users

Tags:

return:	of users
access:	public

Parameters:

array	$pParamHash
	&$pParamHash

[ Top ]

method getRenderFile [line 2441]

the getRenderFile(
)

getRenderFile Returns include file that will

Tags:

return:	fully specified path to file to be included
access:	public

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

[ Top ]

method getRoles [line 2614]

TRUE getRoles(
[array
$pUserId = NULL], [array
$pForceRefresh = FALSE])

getRoles

Tags:

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

Parameters:

array	$pUserId
array	$pForceRefresh

[ Top ]

method getSelectionList [line 2451]

TRUE getSelectionList(
)

getSelectionList get a list of users that can be used in dropdown lists in forms to choose from

Tags:

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

[ Top ]

method getSmtpResponse [line 479]

TRUE getSmtpResponse(

&$pConnect, array
$pConnect)

getSmtpResponse

Tags:

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

Parameters:

array	$pConnect
	&$pConnect

[ Top ]

method getThumbnailUrl [line 1903]

TRUE getThumbnailUrl(
[string
$pSize = 'small'], [array
$pInfoHash = NULL], [
$pSecondaryId = NULL], [
$pDefault = TRUE])

getThumbnailUrl

Tags:

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

Overrides LibertyMime::getThumbnailUrl() (getThumbnailUrl will fetch the primary thumbnail for a given content. If nothing has been set, it will fetch the last thumbnail it can find.)

Parameters:

string	$pSize
array	$pInfoHash
	$pSecondaryId
	$pDefault

[ Top ]

method getTitle [line 2359]

get getTitle(
[array
$pHash = NULL], [
$pDefault = TRUE])

getTitle

Tags:

return:	the users display name
access:	public

Overrides LibertyContent::getTitle() (Create the generic title for a content item)

Parameters:

array	$pHash
	$pDefault

[ Top ]

method getUserActivity [line 1772]

array getUserActivity(

&$pListHash, array
$pListHash)

getUserActivity

Tags:

return:	of users and what they have been up to
access:	public

Parameters:

array	$pListHash
	&$pListHash

[ Top ]

method getUserAttachments [line 2241]

list getUserAttachments(

&$pListHash, array
$pListHash)

getUserAttachments

Tags:

return:	of attachments
access:	public

Parameters:

array	$pListHash
	&$pListHash

[ Top ]

method getUserDomain [line 1838]

TRUE getUserDomain(
array
$pLogin)

getUserDomain

Tags:

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

Parameters:

array

$pLogin

[ Top ]

method getUserId [line 2308]

user getUserId(
)

getUserId

Tags:

return:	id of currently loaded user
access:	public

[ Top ]

method getUserIdFromCookieHash [line 1667]

user getUserIdFromCookieHash(
array
$pHash)

getByHash get user from cookie hash

Tags:

return:	info
access:	public

Parameters:

array

$pHash

[ Top ]

method getUserInfo [line 1621]

user getUserInfo(
array
$pUserMixed)

getUserInfo will fetch the user info of a given user

Tags:

return:	info on success, NULL on failure
access:	public

Parameters:

array

$pUserMixed

hash key can be any column in users_users table e.g.: 'login', 'user_id', 'email', 'content_id'

[ Top ]

method getWatches [line 2124]

TRUE getWatches(
[string
$pEvent = ''])

getWatches

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

string

$pEvent

[ Top ]

method get_event_watches [line 2173]

TRUE get_event_watches(
array
$pEvent, array
$pObject)

get_event_watches

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array	$pEvent
array	$pObject

[ Top ]

method get_watches_events [line 2223]

TRUE get_watches_events(
)

get_watches_events

Tags:

return:	on success, FALSE on failure
access:	public

[ Top ]

method hasFavorite [line 2275]

void hasFavorite(

$pContentId)

Parameters:

$pContentId

[ Top ]

method importUser [line 832]

TRUE importUser(
$pParamHash
&$pParamHash)

Imports a user record from csv file This is a admin specific function

Tags:

return:

if import succeed

Parameters:

$pParamHash

&$pParamHash

an array with user data

[ Top ]

method isAdmin [line 2654]

FALSE isAdmin(
)

isAdmin "PURE VIRTUAL BASE FUNCTION";

Tags:

access:

public

[ Top ]

method isCacheableObject [line 94]

boolean isCacheableObject(
)

Determines if a user object is cacheable. Out of paranoia, admin's are never cached.

Tags:

return:	if object can be cached
access:	public

Overrides LibertyContent::isCacheableObject() (parent method not documented)

[ Top ]

method isPasswordDue [line 1679]

TRUE isPasswordDue(
[
$pUserId = NULL])

isPasswordDue work out if a user has to change their password

Tags:

return:	when the password is due, FALSE if it isn't, NULL when no due time is set
note:	NULL password due means no expiration
access:	public

Parameters:

$pUserId

[ Top ]

method isRegistered [line 2664]

TRUE isRegistered(
)

isRegistered

Tags:

return:	if user is registered, FALSE otherwise
access:	public

[ Top ]

method isUserPrivate [line 1649]

boolean isUserPrivate(
[array
$pUserId = NULL])

isUserPublic Determine if an arbitrary user can be viewed by non-permissioned users.

Tags:

return:	if user is publically visible
access:	public

Parameters:

array

$pUserId

user_id of user to query visibility, if NULL will use this object

[ Top ]

method isValid [line 2644]

TRUE isValid(
)

isValid

Tags:

return:	if user is loaded
access:	public

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

[ Top ]

method load [line 117]

returnString load(
[boolean
$pFull = FALSE], [string
$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(): load

RolePermUser::load(): load

Overrides LibertyMime::load() (load the attachments for a given content id and then stuff them in mStorage)

Parameters:

boolean	$pFull	Load additional user data like
string	$pUserName	User login name

[ Top ]

method login [line 1304]

URL login(
array
$pLogin, array
$pPassword, [array
$pChallenge = NULL], [array
$pResponse = NULL])

Tags:

return:	the user should be sent to after login
access:	public

Parameters:

array	$pLogin
array	$pPassword
array	$pChallenge
array	$pResponse

[ Top ]

method logout [line 1158]

void logout(
)

logout

Tags:

access:

public

[ Top ]

method lookupHomepage [line 1568]

user_id lookupHomepage(
array
$iHomepage)

lookupHomepage

Tags:

return:	that can be used to point to users homepage
access:	public

Parameters:

array

$iHomepage

[ Top ]

method preRegisterVerify [line 433]

void preRegisterVerify(

&$pParamHash)

preRegisterVerify

A collection of values to verify before a user can register Separated from BitUser::verify so that import verification can be processed with less rigor than user submitted requests

Parameters:

&$pParamHash

[ Top ]

method purgeAvatar [line 2076]

TRUE purgeAvatar(
)

purgeAvatar

Tags:

return:	on success, FALSE on failure
access:	public

[ Top ]

method purgeImage [line 2044]

TRUE purgeImage(
array
$pType)

purgeImage

Tags:

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

Parameters:

array

$pType

[ Top ]

method purgeLogo [line 2087]

TRUE purgeLogo(
)

purgeLogo

Tags:

return:	on success, FALSE on failure
access:	public

[ Top ]

method purgePortrait [line 2065]

TRUE purgePortrait(
)

purgePortrait

Tags:

return:	on success, FALSE on failure
access:	public

[ Top ]

method register [line 672]

TRUE register(

&$pParamHash, [
$pNotifyRegistrant = TRUE])

Tags:

return:	on success, FALSE on failure
author:	Christian Fowler<spider@viovio.com>
access:	public

Parameters:

	&$pParamHash
	$pNotifyRegistrant

[ Top ]

method remove_user_watch_by_hash [line 2197]

TRUE remove_user_watch_by_hash(
array
$pHash)

remove_user_watch_by_hash

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array

$pHash

[ Top ]

method sendSessionCookie [line 1170]

void sendSessionCookie(
[
$pCookie = TRUE])

Parameters:

$pCookie

[ Top ]

method store [line 787]

TRUE store(

&$pParamHash, array
$pParamHash)

store

Tags:

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

Overridden in child classes as:

BitPermUser::store(): store

RolePermUser::store(): store

Overrides LibertyMime::store() (Store a new upload)

Parameters:

array	$pParamHash
	&$pParamHash

[ Top ]

method storeAvatar [line 1987]

TRUE storeAvatar(

&$pStorageHash, array
$pStorageHash)

storeAvatar

Tags:

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

Parameters:

array	$pStorageHash
	&$pStorageHash

[ Top ]

method storeFavorite [line 2255]

TRUE storeFavorite(
array
$pContentId)

storeFavorite

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array

$pContentId

[ Top ]

method storeImages [line 1924]

TRUE storeImages(
array
$pParamHash, boolean
$pParamHash['user_auto_avatar'])

storeImages will store any user images - please note that uploaded files have to be in predefined keys in $_FILES

$_FILES['user_portrait_file'] $_FILES['user_auto_avatar'] $_FILES['user_logo_file']

Tags:

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

Parameters:

array	$pParamHash	array of options
boolean	$pParamHash['user_auto_avatar']	automatically create avatar from portrait

[ Top ]

method storeLogo [line 1998]

TRUE storeLogo(

&$pStorageHash, array
$pStorageHash)

storeLogo

Tags:

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

Parameters:

array	$pStorageHash
	&$pStorageHash

[ Top ]

method storePassword [line 1737]

TRUE storePassword(
array
$pPass, [array
$pLogin = NULL])

storePassword

Tags:

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

Parameters:

array	$pPass
array	$pLogin

[ Top ]

method storePortrait [line 1961]

TRUE storePortrait(

&$pStorageHash, [array
$pGenerateAvatar = FALSE], array
$pStorageHash)

storePortrait

Tags:

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

Parameters:

array	$pStorageHash
array	$pGenerateAvatar
	&$pStorageHash

[ Top ]

method storeUserImage [line 2010]

TRUE storeUserImage(

&$pStorageHash, [string
$pType = 'portrait'], array
$pStorageHash)

storeUserImage

Tags:

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

Parameters:

array	$pStorageHash
string	$pType
	&$pStorageHash

[ Top ]

method storeWatch [line 2105]

TRUE storeWatch(
array
$pEvent, array
$pObject, array
$pType, array
$pTitle, array
$pUrl)

storeWatch

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array	$pEvent
array	$pObject
array	$pType
array	$pTitle
array	$pUrl

[ Top ]

method unban [line 1252]

TRUE unban(
)

ban unban the user

Tags:

return:	on success
access:	public

[ Top ]

method updateLastLogin [line 1509]

TRUE updateLastLogin(
array
$pUserId)

updateLastLogin

Tags:

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

Parameters:

array

$pUserId

[ Top ]

method updateSession [line 1092]

TRUE updateSession(
array
$pSessionId)

updateSession

Tags:

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

Parameters:

array

$pSessionId

[ Top ]

method userExists [line 2689]

TRUE userExists(
array
$pUserMixed)

userExists

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array

$pUserMixed

[ Top ]

method validate [line 1399]

TRUE validate(
array
$pUser, array
$pPass, array
$pChallenge, array
$pResponse)

validate

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
todo:	rewrite this mess. this is horrible stuff. - xing - Thursday Oct 16, 2008 09:47:20 CEST
access:	public

Parameters:

array	$pUser
array	$pPass
array	$pChallenge
array	$pResponse

[ Top ]

method verify [line 259]

TRUE verify(

&$pParamHash, array
$pParamHash)

verify store hash

Tags:

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

Overrides LibertyMime::verify() (Verify content that is about to be stored)

Parameters:

array	$pParamHash	Data to be verified
	&$pParamHash

[ Top ]

method verifyCaptcha [line 766]

TRUE verifyCaptcha(
[array
$pCaptcha = NULL])

verifyCaptcha

Tags:

return:	on success, FALSE on failure
access:	public

Parameters:

array

$pCaptcha

[ Top ]

method verifyEmail [line 497]

TRUE verifyEmail(
array
$pEmail, 
&$pErrors)

verifyEmail

Tags:

return:	on success, FALSE on failure, or -1 if verifyMX had a connection failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pEmail
	&$pErrors

[ Top ]

method verifyMX [line 555]

TRUE verifyMX(
array
$pEmail, 
&$pErrors, array
$pValidate)

verifyMX

Tags:

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

Parameters:

array	$pEmail
array	$pValidate
	&$pErrors

[ Top ]

method verifyPasswordFormat [line 455]

FALSE verifyPasswordFormat(
array
$pPassword, [array
$pPassword2 = NULL])

verifyPasswordFormat

Tags:

return:	on success, Error string on failure
access:	public

Parameters:

array	$pPassword
array	$pPassword2

[ Top ]

method verifyRegistered [line 2674]

TRUE verifyRegistered(
[
$pMsg = ""])

verifyRegistered

Tags:

return:	if user is registered, otherwise a login dialog is displayed
access:	public

Parameters:

$pMsg

[ Top ]

method verifyTicket [line 1215]

TRUE verifyTicket(
[array
$pFatalOnError = TRUE], [array
$pForceCheck = TRUE])

verifyTicket

Tags:

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

Parameters:

array	$pFatalOnError
array	$pForceCheck

[ Top ]

method verifyUserImport [line 891]

TRUE verifyUserImport(
$pParamHash
&$pParamHash)

Verify and validate the data when importing a user record from csv file This is a admin specific function

Tags:

return:

on success, FALSE on failure - mErrors will contain reason for failure

Parameters:

$pParamHash

&$pParamHash

an array with user data

[ Top ]

Class: BitUser

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Constants

Class: BitBase

Inherited Variables

Class: LibertyMime

Class: LibertyContent

Class: BitBase

Inherited Methods

Class: LibertyMime

Class: LibertyContent

Class: LibertyBase

Class: BitBase

Class Details

Tags:

Class Variables

$mAuth =

$mRoles =

$mTicket =

$mUserId =

$mUsername =

Class Methods

static method getDisplayNameFromHash [line 2373]

Tags:

Parameters:

static method getDisplayUrlFromHash [line 2320]

Tags:

Parameters:

static method getSiteCookieName [line 1200]

Tags:

static method getSortModeFields [line 102]

Tags:

static method getUserObject [line 2757]

Tags:

Parameters:

static method getUserPreference [line 1598]

Tags:

Parameters:

static method isCacheableClass [line 86]

Tags:

static method userCollection [line 2741]

Tags:

Parameters:

static method verifyAnonEmail [line 530]

Tags:

Parameters:

constructor BitUser [line 59]

Tags:

Parameters:

method answerCaptcha [line 387]

Parameters:

method ban [line 1236]

Tags:

method canCustomizeLayout [line 1887]

Tags:

method canCustomizeTheme [line 1876]

Tags:

method changeUserEmail [line 1544]

Tags:

Parameters:

method confirmRegistration [line 1528]

Tags:

Parameters:

method countSessions [line 1144]

Tags:

Parameters:

method createTempPassword [line 1707]

Tags:

Parameters:

method defaults [line 226]

Tags:

method exportHash [line 2711]

Tags:

method expunge [line 1039]

Tags:

Parameters: