BitUser Class Reference

Inheritance diagram for BitUser:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 BitUser ($pUserId=NULL, $pContentId=NULL)
 canCustomizeLayout ()
 canCustomizeTheme ()
 changeUserEmail ($pUserId, $pEmail)
 confirmRegistration ($pUserId, $pProvpass)
 count_sessions ()
 createTempPassword ($pLogin, $pPass)
 defaults ()
 expunge ()
 expungeFavorite ($pContentId)
 expungeWatch ($event, $object)
 generateChallenge ()
 genPass ($pLength=NULL)
 get_event_watches ($event, $object)
 get_SMTP_response (&$pConnect)
 get_users ($offset=0, $max_records=-1, $sort_mode= 'login_desc', $find= '')
 get_users_names ($offset=0, $max_records=-1, $sort_mode= 'login_desc', $find= '')
 get_watches_events ()
 getByHash ($hash)
 getDisplayLink ($pUserName, $pDisplayHash)
 getDisplayName ($pUseLink=FALSE, $pHash=NULL)
 getDisplayUrl ($pUserName=NULL, $pMixed=NULL)
 getDomain ($pContentId)
 getEventWatches ($event, $object)
 getGroups ()
 getList (&$pParamHash)
 getRenderFile ()
 getSelectionList ()
 getThumbnailUrl ($pSize='small', $pInfoHash=NULL)
 getTitle ($pHash=NULL)
 getUserActivity (&$pListHash)
 getUserAttachments (&$pListHash)
 getUserDomain ($pLogin)
 getUserFiles ()
 getUserFromContentId ($content_id)
 getUserId ()
 getUserInfo ($pUserMixed)
 getUserPreference ($pPrefName, $pPrefDefault, $pUserId)
 getWatches ($pEvent= '')
 hasSemaphoreConflict ($pSemName, $pLimit)
 isAdmin ()
 isPasswordDue ()
 isRegistered ()
 isSemaphoreSet ($pSemName, $pLimit)
 isValid ()
 load ($pFull=FALSE, $pUserName=NULL)
 login ($pLogin, $pPassword, $pChallenge=NULL, $pResponse=NULL)
 logout ()
 lookupHomepage ($iHomepage)
 purgeAvatar ()
 purgeImage ($pType)
 purgeLogo ()
 purgePortrait ()
 register (&$pParamHash)
 remove_user_watch_by_hash ($hash)
 renewPassword ($pLogin)
 store (&$pParamHash)
 storeAvatar (&$pStorageHash)
 storeFavorite ($pContentId)
 storeLogin ($newLogin)
 storeLogo (&$pStorageHash)
 storePassword ($pPass, $pLogin=NULL)
 storePortrait (&$pStorageHash, $pGenerateAvatar=FALSE)
 storeRealName ($newRealName)
 storeSemaphore ($pSemName)
 storeWatch ($event, $object, $type, $title, $url)
 update_lastlogin ($pUserId)
 updateSession ($pSessionId)
 userExists ($pUserMixed)
 validate ($user, $pass, $challenge, $response)
 verify (&$pParamHash)
 verifyCaptcha ($pCaptcha=NULL)
 verifyEmail ($pEmail, $pValidate=FALSE)
 verifyPasswordFormat ($pPassword, $pPassword2=NULL)
 verifyTicket ($pFatalOnError=TRUE)

Public Attributes

 $mAuth
 $mGroups
 $mInfo
 $mTicket
 $mUserId
 $mUsername

Detailed Description

Definition at line 47 of file BitUser.php.


Member Function Documentation

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

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

public

Author:
Christian Fowler <spider@viovio.com>
Returns:
returnString

Definition at line 62 of file BitUser.php.

References LibertyAttachable::LibertyAttachable(), mContentId, mUserId, LibertyContent::registerContentType(), and BitBase::verifyId().

Referenced by BitPermUser::BitPermUser().

Here is the call graph for this function:

BitUser::canCustomizeLayout (  ) 

Definition at line 1189 of file BitUser.php.

BitUser::canCustomizeTheme (  ) 

Definition at line 1181 of file BitUser.php.

BitUser::changeUserEmail ( pUserId,
pEmail 
)

Definition at line 943 of file BitUser.php.

References $_REQUEST, $query, $result, mDb, mInfo, tra(), and userExists().

Here is the call graph for this function:

BitUser::confirmRegistration ( pUserId,
pProvpass 
)

Definition at line 934 of file BitUser.php.

References $now, $query, and mDb.

BitUser::count_sessions (  ) 

Definition at line 235 of file BitUser.php.

References $query, and mDb.

BitUser::createTempPassword ( pLogin,
pPass 
)

Definition at line 1046 of file BitUser.php.

References $now, $pass, $query, $result, BitSystem::genPass(), BitBase::getField(), login(), and mDb.

Here is the call graph for this function:

BitUser::defaults (  ) 

Definition at line 166 of file BitUser.php.

References $gBitLanguage, $gBitSystem, $gBitThemes, LibertyContent::getPreference(), mLanguage, and LibertyContent::setPreference().

Referenced by load().

Here is the call graph for this function:

BitUser::expunge (  ) 

Delete content object and all related records

Reimplemented from LibertyContent.

Reimplemented in BitPermUser.

Definition at line 665 of file BitUser.php.

References $logHash, $query, $result, login(), mContentId, mDb, mInfo, mUserId, purgeImage(), LibertyContent::storeActionLog(), title, and tra().

Referenced by BitPermUser::expunge().

Here is the call graph for this function:

BitUser::expungeFavorite ( pContentId  ) 

Definition at line 1366 of file BitUser.php.

References $ret, FALSE, isValid(), mDb, mUserId, and BitBase::verifyId().

Here is the call graph for this function:

BitUser::expungeWatch ( event,
object 
)

Definition at line 1448 of file BitUser.php.

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

Here is the call graph for this function:

BitUser::generateChallenge (  ) 

Definition at line 731 of file BitUser.php.

References BitSystem::genPass().

Here is the call graph for this function:

BitUser::genPass ( pLength = NULL  ) 

Definition at line 711 of file BitUser.php.

References $i, and $r.

Referenced by BitNewsletter::subscribe().

BitUser::get_event_watches ( event,
object 
)

Definition at line 1425 of file BitUser.php.

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

BitUser::get_SMTP_response ( &$  pConnect  ) 

Definition at line 391 of file BitUser.php.

Referenced by verifyEmail().

BitUser::get_users ( offset = 0,
max_records = -1,
sort_mode = 'login_desc',
find = '' 
)

Definition at line 1087 of file BitUser.php.

References $find, $max_records, $mid, $offset, $query, $res, $result, $ret, $sort_mode, getGroups(), and mDb.

Here is the call graph for this function:

BitUser::get_users_names ( offset = 0,
max_records = -1,
sort_mode = 'login_desc',
find = '' 
)

Definition at line 915 of file BitUser.php.

References $find, $max_records, $mid, $offset, $query, $res, $result, $ret, $sort_mode, and mDb.

BitUser::get_watches_events (  ) 

Definition at line 1456 of file BitUser.php.

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

BitUser::getByHash ( hash  ) 

Definition at line 1018 of file BitUser.php.

References $query, and mDb.

BitUser::getDisplayLink ( pUserName,
pDisplayHash 
)

Definition at line 1495 of file BitUser.php.

References getDisplayName().

Here is the call graph for this function:

BitUser::getDisplayName ( pUseLink = FALSE,
pHash = NULL 
)

Get user information for a particular user

Parameters:
pUseLink return the information in the form of a url that links to the users information page
pHash todo - need explanation on how to use this...
Returns:
display name or link to user information page

Definition at line 1510 of file BitUser.php.

References $gBitUser, $ret, login(), mInfo, title, tra(), and BitBase::verifyId().

Referenced by getDisplayLink(), getTitle(), BitMailer::sendQueue(), BitBlogPost::sendTrackbacks(), and smarty_function_displayname().

Here is the call graph for this function:

BitUser::getDisplayUrl ( pContentId = NULL,
pMixed = NULL 
)

Not-so-pure virtual function that returns Request_URI to a piece of content

Parameters:
string Text for DisplayLink function
array different possibilities depending on derived class
Returns:
string Formated URL address to display the page.

Reimplemented from LibertyContent.

Definition at line 1471 of file BitUser.php.

References $ret.

Referenced by BitBoardPost::getComments(), and BitBoardPost::getList().

BitUser::getDomain ( pContentId  ) 

Definition at line 1171 of file BitUser.php.

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

Here is the call graph for this function:

BitUser::getEventWatches ( event,
object 
)

Definition at line 1412 of file BitUser.php.

References $query, $result, $ret, isValid(), mDb, and mUserId.

Here is the call graph for this function:

BitUser::getGroups (  ) 

Definition at line 1691 of file BitUser.php.

References die.

Referenced by BitPermUser::addUserToGroup(), get_users(), getList(), and BitPermUser::loadGroups().

BitUser::getList ( &$  pParamHash  ) 

Definition at line 1606 of file BitUser.php.

References $mid, $pParamHash, $query, $res, $result, $ret, $sort_mode, getGroups(), liberty_fetch_thumbnail_url(), mDb, BitBase::postGetList(), and LibertyContent::prepGetList().

Here is the call graph for this function:

BitUser::getRenderFile (  ) 

Returns include file that will

Returns:
the fully specified path to file to be included

Reimplemented from LibertyContent.

Definition at line 1564 of file BitUser.php.

BitUser::getSelectionList (  ) 

Definition at line 1592 of file BitUser.php.

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

Here is the call graph for this function:

BitUser::getThumbnailUrl ( pSize = 'small',
pInfoHash = NULL 
)

Definition at line 1197 of file BitUser.php.

References $ret, BitBase::getField(), and isValid().

Here is the call graph for this function:

BitUser::getTitle ( pHash = NULL  ) 

Create the generic title for a content item

This will normally be overwriten by extended classes to provide an appropriate title title string

Parameters:
array mInfo type hash of data to be used to provide base data
Returns:
string Descriptive title for the page

Reimplemented from LibertyContent.

Definition at line 1499 of file BitUser.php.

References FALSE, and getDisplayName().

Referenced by LibertyContent::getActionLogs(), TreasuryGallery::getList(), Pigeonholes::getList(), TreasuryGallery::load(), and Pigeonholes::load().

Here is the call graph for this function: