Docs For Class Core

Description

abstract:

Located in /packages/core/lib/user.inc.php (line 2)

Variable Summary

string $DisplayName

object[][] $HomeWidgets

integer $ID

integer $LanguageID

integer $Locked

string $Login

string $Password

string $PasswordHash

integer[] $Permissions

string $Scratchpad

Usergroup $Usergroup

integer $UsergroupID

Method Summary

boolean dbDelete ()

boolean dbLoad ()

boolean dbLoadHomeWidgets ()

boolean dbLoadPermissions ()

boolean dbRelateHomeWidget (integer $PackageID, string $WidgetCode, [ $DisplayOrder = 0], integer $DisplayOrder[optional])

boolean dbSetLanguageID (integer $LanguageID)

boolean dbSetPassword (string $Password)

boolean dbSetPermissions (integer $ModuleID, integer $Permissions)

boolean dbSetScratchpad (integer $Note)

boolean dbStore ()

boolean dbUnrelateAllHomeWidgets ()

boolean dbUnrelateHomeWidget ( $PackageID, $WidgetCode, integer $CreatorID)

boolean dbUnsetPermissions (integer $ModuleID)

string toString ()

boolean verifyPassword (string $Password)

boolean verifyPermissions (integer $ModuleID, integer $AccessFlag)

Variables

string $DisplayName = NULL (line 969)

access: public

object[][] $HomeWidgets = array() (line 1016)

access: public

integer $ID = 0 (line 959)

access: public

integer $LanguageID = 0 (line 980)

access: public

integer $Locked = 0 (line 985)

access: public

string $Login = NULL (line 964)

access: public

string $Password = NULL (line 1001)

access: public

string $PasswordHash = NULL (line 995)

access: public

integer[] $Permissions = array() (line 1011)

access: public

string $Scratchpad = NULL (line 990)

access: public

Usergroup $Usergroup = NULL (line 1006)

access: public

integer $UsergroupID = 0 (line 974)

access: public

Methods

dbDelete (line 9)

Deletes User from the database

access: public

boolean dbDelete ()

dbLoad (line 75)

Loads User from the database

access: public

boolean dbLoad ()

dbLoadHomeWidgets (line 117)

Loads User home Widgets from the database

access: public

boolean dbLoadHomeWidgets ()

dbLoadPermissions (line 154)

Loads User Permissions from the database

access: public

boolean dbLoadPermissions ()

dbRelateHomeWidget (line 190)

Relate Home Widget to User

access: public

boolean dbRelateHomeWidget (integer $PackageID, string $WidgetCode, $DisplayOrder, integer $DisplayOrder[optional])

integer $PackageID
string $WidgetCode
integer $DisplayOrder[optional]
$DisplayOrder

dbSetLanguageID (line 266)

Sets User LanguageID in the database

access: public

boolean dbSetLanguageID (integer $LanguageID)

integer $LanguageID: LanguageID

dbSetPassword (line 321)

Sets User Password in the database

access: public

boolean dbSetPassword (string $Password)

string $Password

dbSetPermissions (line 426)

Sets User Permissions in database for a particular module

access: public

boolean dbSetPermissions (integer $ModuleID, integer $Permissions)

integer $ModuleID
integer $Permissions

dbSetScratchpad (line 377)

Sets User Scratchpad in the database

access: public

boolean dbSetScratchpad (integer $Note)

integer $Note: LanguageID

dbStore (line 501)

Stores User to the database

access: public

boolean dbStore ()

dbUnrelateAllHomeWidgets (line 648)

Unrelates all home widgets for user

access: public

boolean dbUnrelateAllHomeWidgets ()

dbUnrelateHomeWidget (line 704)

Unrelate Home Widget from User

access: public

boolean dbUnrelateHomeWidget ( $PackageID, $WidgetCode, integer $CreatorID)

integer $CreatorID
$PackageID
$WidgetCode

dbUnsetPermissions (line 774)

Unsets User Permissions for a particular module

access: public

boolean dbUnsetPermissions (integer $ModuleID)

integer $ModuleID

toString (line 835)

Generates a formatted string of the User object

access: public
todo: Custom Formatting

string toString ()

verifyPassword (line 877)

Verifies a User's Password

access: public

boolean verifyPassword (string $Password)

string $Password

verifyPermissions (line 910)

Verifies Permissions of User for a particular module

access: public

boolean verifyPermissions (integer $ModuleID, integer $AccessFlag)

integer $ModuleID
integer $AccessFlag

Class Core_User