XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
XoopsUser Class Reference
Inheritance diagram for XoopsUser:
XoopsObject AbstractXoopsObject XoopsGuestUser

Public Member Functions

 __construct ($id=null)
 
 XoopsUser ($id=null)
 
 isGuest ()
 
 incrementPost ()
 
 setGroups ($groupsArr)
 
 getGroups ($bReget=false)
 
 getNumGroups ()
 
 groups ()
 
 isAdmin ($module_id=null)
 
 rank ()
 
 isActive ()
 
 isOnline ()
 
 uid ()
 
 name ($format='S')
 
 uname ($format='S')
 
 email ($format='S')
 
 url ($format='S')
 
 user_avatar ($format='S')
 
 user_regdate ()
 
 user_icq ($format='S')
 
 user_from ($format='S')
 
 user_sig ($format='S')
 
 user_viewemail ()
 
 actkey ()
 
 user_aim ($format='S')
 
 user_yim ($format='S')
 
 user_msnm ($format='S')
 
 pass ()
 
 posts ()
 
 attachsig ()
 
 level ()
 
 theme ()
 
 timezone ()
 
 umode ()
 
 uorder ()
 
 notify_method ()
 
 notify_mode ()
 
 user_occ ($format='S')
 
 bio ($format='S')
 
 user_intrest ($format='S')
 
 last_login ()
 
 hasAvatar ()
 
 getAvatarUrl ()
 
- Public Member Functions inherited from XoopsObject
 __construct ()
 
 setNew ()
 
 unsetNew ()
 
 isNew ()
 
 setDirty ()
 
 unsetDirty ()
 
 isDirty ()
 
 initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='')
 
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 setVar ($key, $value, $not_gpc=false)
 
 setVars ($var_arr, $not_gpc=false)
 
 setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
 
getVars ()
 
getVar ($key, $format='s')
 
 getShow ($key)
 
 set ($key, $value)
 
 get ($key)
 
 getProperty ($key)
 
 getProperties ()
 
 cleanVars ()
 
 registerFilter ($filtername)
 
 _loadFilters ()
 
xoopsClone ()
 
 setErrors ($err_str)
 
 getErrors ()
 
 getHtmlErrors ()
 
- Public Member Functions inherited from AbstractXoopsObject
 initVar ($key, $data_type, $default, $required, $size)
 

Static Public Member Functions

static getUnameFromId ($userid, $usereal=0)
 

Data Fields

 $_groups = []
 
 $_isAdmin = null
 
 $_rank = null
 
 $_isOnline = null
 
- Data Fields inherited from XoopsObject
 $vars = []
 
 $cleanVars = []
 
 $_isNew = false
 
 $_isDirty = false
 
 $_errors = []
 
 $_filters = []
 

Detailed Description

Definition at line 18 of file user.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $id = null)

constructor

Parameters
int$idID of the user to be loaded from the database.

Definition at line 47 of file user.php.

Member Function Documentation

◆ actkey()

actkey ( )

Definition at line 341 of file user.php.

◆ attachsig()

attachsig ( )

Definition at line 371 of file user.php.

◆ bio()

bio ( $format = 'S')

Definition at line 417 of file user.php.

◆ email()

email ( $format = 'S')

get the user's email

Parameters
string$formatformat for the output, see XoopsObject::getVar()
Returns
string

Definition at line 302 of file user.php.

◆ getAvatarUrl()

getAvatarUrl ( )

Return Abs URL for displaying avatar.

Returns
string

Definition at line 453 of file user.php.

◆ getGroups()

getGroups ( $bReget = false)

get the groups that the user belongs to

Parameters
bool$bRegetthis is true, this object gets group informations from DB again. This is a special method for the BASE(CMS core) functions, you should not use this proactivity.
Returns
array array of groups

Reimplemented in XoopsGuestUser.

Definition at line 173 of file user.php.

◆ getNumGroups()

getNumGroups ( )

Definition at line 186 of file user.php.

◆ getUnameFromId()

static getUnameFromId ( $userid,
$usereal = 0 )
static

Updated by Catzwolf 11 Jan 2004 find the username for a given ID

Parameters
int$useridID of the user to find
int$userealswitch for usename or realname
Returns
string name of the user. name for "anonymous" if not found.

Definition at line 125 of file user.php.

◆ groups()

groups ( )

alias for getGroups()

See also
getGroups()
Returns
array array of groups
Deprecated

Definition at line 201 of file user.php.

◆ hasAvatar()

hasAvatar ( )

This class has avatar in uploads directory.

Returns
bool

Definition at line 436 of file user.php.

◆ incrementPost()

incrementPost ( )

increase the number of posts for the user

Deprecated

Definition at line 148 of file user.php.

◆ isActive()

isActive ( )

is the user activated?

Returns
bool

Definition at line 242 of file user.php.

◆ isAdmin()

isAdmin ( $module_id = null)

Is the user admin ?

This method will return true if this user has admin rights for the specified module.

  • If you don't specify any module ID, the current module will be checked.
  • If you set the module_id to -1, it will return true if the user has admin rights for at least one module
Parameters
int$module_idcheck if user is admin of this module
Returns
bool is the user admin of that module?

Definition at line 215 of file user.php.

◆ isGuest()

isGuest ( )

check if the user is a guest user

Returns
bool returns false

Reimplemented in XoopsGuestUser.

Definition at line 112 of file user.php.

◆ isOnline()

isOnline ( )

is the user currently logged in?

Returns
bool

Definition at line 250 of file user.php.

◆ last_login()

last_login ( )

Definition at line 427 of file user.php.

◆ level()

level ( )

Definition at line 376 of file user.php.

◆ name()

name ( $format = 'S')

get the users name

Parameters
string$formatformat for the output, see XoopsObject::getVar()
Returns
string

Definition at line 281 of file user.php.

◆ notify_method()

notify_method ( )

Definition at line 402 of file user.php.

◆ notify_mode()

notify_mode ( )

Definition at line 407 of file user.php.

◆ pass()

pass ( )

Definition at line 361 of file user.php.

◆ posts()

posts ( )

Definition at line 366 of file user.php.

◆ rank()

rank ( )

get the user's rank

Returns
array array of rank ID and title

@access private

Definition at line 231 of file user.php.

◆ setGroups()

setGroups ( $groupsArr)

set the groups for the user

Parameters
array$groupsArrArray of groups that user belongs to

Definition at line 158 of file user.php.

◆ theme()

theme ( )

Definition at line 381 of file user.php.

◆ timezone()

timezone ( )

Definition at line 386 of file user.php.

◆ uid()

uid ( )

#+ specialized wrapper for XoopsObject::getVar()

kept for compatibility reasons.

See also
XoopsObject\getVar()
Deprecated

get the users UID

Returns
int

Definition at line 271 of file user.php.

◆ umode()

umode ( )

Definition at line 391 of file user.php.

◆ uname()

uname ( $format = 'S')

get the user's uname

Parameters
string$formatformat for the output, see XoopsObject::getVar()
Returns
string

Definition at line 291 of file user.php.

◆ uorder()

uorder ( )

Definition at line 396 of file user.php.

◆ url()

url ( $format = 'S')

Definition at line 307 of file user.php.

◆ user_aim()

user_aim ( $format = 'S')

Definition at line 346 of file user.php.

◆ user_avatar()

user_avatar ( $format = 'S')

Definition at line 312 of file user.php.

◆ user_from()

user_from ( $format = 'S')

Definition at line 327 of file user.php.

◆ user_icq()

user_icq ( $format = 'S')

Definition at line 322 of file user.php.

◆ user_intrest()

user_intrest ( $format = 'S')

Definition at line 422 of file user.php.

◆ user_msnm()

user_msnm ( $format = 'S')

Definition at line 356 of file user.php.

◆ user_occ()

user_occ ( $format = 'S')

Definition at line 412 of file user.php.

◆ user_regdate()

user_regdate ( )

Definition at line 317 of file user.php.

◆ user_sig()

user_sig ( $format = 'S')

Definition at line 331 of file user.php.

◆ user_viewemail()

user_viewemail ( )

Definition at line 336 of file user.php.

◆ user_yim()

user_yim ( $format = 'S')

Definition at line 351 of file user.php.

◆ XoopsUser()

XoopsUser ( $id = null)

Definition at line 101 of file user.php.

Field Documentation

◆ $_groups

$_groups = []

Definition at line 26 of file user.php.

◆ $_isAdmin

$_isAdmin = null

Definition at line 31 of file user.php.

◆ $_isOnline

$_isOnline = null

Definition at line 41 of file user.php.

◆ $_rank

$_rank = null

Definition at line 36 of file user.php.


The documentation for this class was generated from the following file: