Docs For Class User1

Description

Located in /packages/core/install/upgrade/1.11lib/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

User1_11 __construct ([ $ID_or_Row = 0])

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)

string __toString ()

Variables

string $DisplayName = NULL (line 1037)

access: public

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

access: public

integer $ID = 0 (line 1027)

access: public

integer $LanguageID = 0 (line 1048)

access: public

integer $Locked = 0 (line 1053)

access: public

string $Login = NULL (line 1032)

access: public

string $Password = NULL (line 1069)

access: public

string $PasswordHash = NULL (line 1063)

access: public

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

access: public

string $Scratchpad = NULL (line 1058)

access: public

Usergroup $Usergroup = NULL (line 1074)

access: public

integer $UsergroupID = 0 (line 1042)

access: public

Methods

Constructor __construct (line 4)

access: public

User1_11 __construct ( $ID_or_Row)

$ID_or_Row

dbDelete (line 45)

Deletes User from the database

access: public

boolean dbDelete ()

dbLoad (line 111)

Loads User from the database

access: public

boolean dbLoad ()

dbLoadHomeWidgets (line 179)

Loads User home Widgets from the database

access: public

boolean dbLoadHomeWidgets ()

dbLoadPermissions (line 216)

Loads User Permissions from the database

access: public

boolean dbLoadPermissions ()

dbRelateHomeWidget (line 252)

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 326)

Sets User LanguageID in the database

access: public

boolean dbSetLanguageID (integer $LanguageID)

integer $LanguageID: LanguageID

dbSetPassword (line 381)

Sets User Password in the database

access: public

boolean dbSetPassword (string $Password)

string $Password

dbSetPermissions (line 486)

Sets User Permissions in database for a particular module

access: public

boolean dbSetPermissions (integer $ModuleID, integer $Permissions)

integer $ModuleID
integer $Permissions

dbSetScratchpad (line 437)

Sets User Scratchpad in the database

access: public

boolean dbSetScratchpad (integer $Note)

integer $Note: LanguageID

dbStore (line 561)

Stores User to the database

access: public

boolean dbStore ()

dbUnrelateAllHomeWidgets (line 708)

Unrelates all home widgets for user

access: public

boolean dbUnrelateAllHomeWidgets ()

dbUnrelateHomeWidget (line 764)

Unrelate Home Widget from User

access: public

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

integer $CreatorID
$PackageID
$WidgetCode

dbUnsetPermissions (line 834)

Unsets User Permissions for a particular module

access: public

boolean dbUnsetPermissions (integer $ModuleID)

integer $ModuleID

toString (line 895)

Generates a formatted string of the User object

access: public
todo: Custom Formatting

string toString ()

verifyPassword (line 932)

Verifies a User's Password

access: public

boolean verifyPassword (string $Password)

string $Password

verifyPermissions (line 965)

Verifies Permissions of User for a particular module

access: public

boolean verifyPermissions (integer $ModuleID, integer $AccessFlag)

integer $ModuleID
integer $AccessFlag

__toString (line 1018)

Outputs User if User is cast to string

access: public
magic:

string __toString ()

Class User1_11