Class Core_User

(line 2)

Description


Located in File: /packages/core/lib/user.inc.php



Class Variables

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

$DisplayName = NULL (line 1004)

Data type : string

  • access: - public

$HomeWidgets = array() (line 1051)

Data type : object[][]

  • access: - public

$ID = 0 (line 994)

Data type : integer

  • access: - public

$LanguageID = 0 (line 1015)

Data type : integer

  • access: - public

$Locked = 0 (line 1020)

Data type : integer

  • access: - public

$Login = NULL (line 999)

Data type : string

  • access: - public

$Password = NULL (line 1036)

Data type : string

  • access: - public

$PasswordHash = NULL (line 1030)

Data type : string

  • access: - public

$Permissions = array() (line 1046)

Data type : integer[]

  • access: - public

$Scratchpad = NULL (line 1025)

Data type : string

  • access: - public

$Usergroup = NULL (line 1041)

Data type : Usergroup

  • access: - public

$UsergroupID = 0 (line 1009)

Data type : integer

  • access: - public

Class Constants

Summary:

Method Detail

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 dbUnrelateHomeWidget ( $PackageID,  $WidgetCode, integer $CreatorID)
boolean dbUnsetPermissions (integer $ModuleID)
string toString ()
boolean verifyPassword (string $Password)
boolean verifyPermissions (integer $ModuleID, integer $AccessFlag)
string __toString ()

Method dbDelete (line 9)

boolean dbDelete( )

Deletes User from the database

Info

  • access - public

Method dbLoad (line 75)

boolean dbLoad( )

Loads User from the database

Info

  • access - public

Method dbLoadHomeWidgets (line 144)

boolean dbLoadHomeWidgets( )

Loads User home Widgets from the database

Info

  • access - public

Method dbLoadPermissions (line 181)

boolean dbLoadPermissions( )

Loads User Permissions from the database

Info

  • access - public

Method dbRelateHomeWidget (line 217)

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

Relate Home Widget to User

Parameters

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

Info

  • access - public

Method dbSetLanguageID (line 293)

boolean dbSetLanguageID( integer $LanguageID)

Sets User LanguageID in the database

Parameters

  • integer $LanguageID: LanguageID

Info

  • access - public

Method dbSetPassword (line 348)

boolean dbSetPassword( string $Password)

Sets User Password in the database

Parameters

  • string $Password:

Info

  • access - public

Method dbSetPermissions (line 453)

boolean dbSetPermissions( integer $ModuleID, integer $Permissions)

Sets User Permissions in database for a particular module

Parameters

  • integer $ModuleID:
  • integer $Permissions:

Info

  • access - public

Method dbSetScratchpad (line 404)

boolean dbSetScratchpad( integer $Note)

Sets User Scratchpad in the database

Parameters

  • integer $Note: LanguageID

Info

  • access - public

Method dbStore (line 528)

boolean dbStore( )

Stores User to the database

Info

  • access - public

Method dbUnrelateAllHomeWidgets (line 675)

boolean dbUnrelateAllHomeWidgets( )

Unrelates all home widgets for user

Info

  • access - public

Method dbUnrelateHomeWidget (line 731)

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

Unrelate Home Widget from User

Parameters

  • integer $CreatorID:
  • $PackageID:
  • $WidgetCode:

Info

  • access - public

Method dbUnsetPermissions (line 801)

boolean dbUnsetPermissions( integer $ModuleID)

Unsets User Permissions for a particular module

Parameters

  • integer $ModuleID:

Info

  • access - public

Method toString (line 862)

string toString( )

Generates a formatted string of the User object

Info

  • access - public
  • todo - Custom Formatting

Method verifyPassword (line 899)

boolean verifyPassword( string $Password)

Verifies a User's Password

Parameters

  • string $Password:

Info

  • access - public

Method verifyPermissions (line 932)

boolean verifyPermissions( integer $ModuleID, integer $AccessFlag)

Verifies Permissions of User for a particular module

Parameters

  • integer $ModuleID:
  • integer $AccessFlag:

Info

  • access - public

Method __toString (line 985)

string __toString( )

Outputs User if User is cast to string

Info

  • access - public
  • magic -

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary


Documentation generated on Mon, 19 Nov 2007 16:16:40 -0600 by phpDocumentor 1.3.1